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

Message

public class Message

Represents all information about a message in chat. Messages can be either systemic or user generated. There shouldn't be a distinction on the client side about those messages, though you should know they are created in different ways.

As long as you receive this object from whatever source, you have a guarantee that this object exists somewhere on the server. Messages are never generated locally as phantoms.

Inheritors

Types

ListPicker

public abstract class ListPicker extends Message

A list picker displays a list of items, and information about the items, such as product name, description, and image, in the Messages app on the customer's device. The customer can interact multiple times with one or more items from the list. Each interaction should send a reply (on behalf of the user) together with the postback value.

QuickReplies

public abstract class QuickReplies extends Message

Quick Reply messages have a title to present to the user along with a selection of quick response Action.ReplyButton. The buttons should also be presented to the user, and if the user taps a button, the associated postback should be sent together with the text of the button as a reply message (on behalf of the user). The action can be invoked only once, and the integrating applications have to prevent multiple uses.

RichLink

public abstract class RichLink extends Message

A RichLink message to display.

Text

public abstract class Text extends Message

Simple message representing only text content. This type of content is usually generated through User or Agent replying to each other.

Properties

attachments

private final Iterable<Attachment> attachments

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

author

private final MessageAuthor author

Author associated with this message.

createdAt

private final Date createdAt

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.

direction

private final MessageDirection direction

The direction in which the message is sent.

fallbackText

private final String fallbackText

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

private final UUID id

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

metadata

private final MessageMetadata metadata

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

threadId

private final UUID threadId

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

Functions

getAttachments

public abstract Iterable<Attachment> getAttachments()

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

getAuthor

public abstract MessageAuthor getAuthor()

Author associated with this message.

getCreatedAt

public abstract Date getCreatedAt()

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.

getDirection

public abstract MessageDirection getDirection()

The direction in which the message is sent.

getFallbackText

public abstract String getFallbackText()

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

getId

public abstract UUID getId()

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

getMetadata

public abstract MessageMetadata getMetadata()