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

RichLink

public abstract class RichLink extends Message

A RichLink message to display.

Each RichLink message has a title and media image to display in conjunction with an associated URL. If the message is touched, then the URL should be opened.

Constructors

Message.RichLink

public Message.RichLink Message.RichLink()

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.

media

private final Media media

image media information to display in RichLink.

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.

title

private final String title

title to display.

url

private final String url

URL to open if the item is selected.

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.

getMedia

public abstract Media getMedia()

image media information to display in RichLink.

getMetadata

public abstract MessageMetadata getMetadata()

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

getThreadId

public abstract UUID getThreadId()

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

getTitle

public abstract String getTitle()

title to display.

getUrl

public abstract String getUrl()

URL to open if the item is selected.