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

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.

Constructors

Message.ListPicker

public Message.ListPicker Message.ListPicker()

Properties

actions

private final Iterable<Action> actions

List of options to be displayed to the user.

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.

text

private final String text

Additional text to be displayed after clicking on the picker list.

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 of the List Picker in the conversation.

Functions

getActions

public abstract Iterable<Action> getActions()

List of options to be displayed to the user.

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()

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

getText

public abstract String getText()

Additional text to be displayed after clicking on the picker list.

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 of the List Picker in the conversation.