chat-sdk-core/com.nice.cxonechat.message/Message/Plugin

Plugin

abstract class Plugin : Message

Rich content messages, called plugins. These are very often generated by Agent action in the agent console. Your application can support all PluginElement or just focus on the components that is currently required by your own specification. Note that new elements can be added to the backend services for which you need to update the SDK. New elements, previously undefined are ignored by the SDK until implemented.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
abstract val attachments: Iterable<Attachment>

Attachments provided with the message. This field can be empty. It contains attachments that the user or agent sent alongside with the message.

Link copied to clipboard
abstract val author: MessageAuthor?

Author associated with this message.

Link copied to clipboard
abstract val createdAt: Date

The timestamp of when the message was created on the server. Similarly to id this field shouldn't change for the lifetime of the message.

Link copied to clipboard
abstract val direction: MessageDirection

The direction in which the message is sent.

Link copied to clipboard
abstract val element: PluginElement?

Element provided with this message. If the element is null, then you have received a message with an element that's not supported by this version. Kindly update the SDK in order to gain support.

Link copied to clipboard
abstract val fallbackText: String?

Optional fallback text which can be used if UI integration doesn't support concrete subtype of Message.

Link copied to clipboard
abstract val id: UUID

The id that was assigned to this message. If another message has matching id, it's the same message with possibly different content.

Link copied to clipboard
abstract val metadata: MessageMetadata

The otherwise uncategorizable properties for this message. It can contain anything from message status to custom properties.

Link copied to clipboard
abstract val postback: String?

Additional information provided alongside with the message. Refer to information given by a representative to correctly use this parameter.

Link copied to clipboard
abstract val threadId: UUID

The thread id that this message belongs to. Messages should never be mismatched between threads as this can lead to inconsistencies and undefined behavior.