ChoicesFormat

sealed interface ChoicesFormat : MessageFormat

A message format that presents selectable options to the user, rendered as quick replies, buttons, or a carousel.

Inheritors

Types

Link copied to clipboard
@JsonClass(generateAdapter = true)
class CarouselFormat(val items: List<TitleItem.TitleItemWithInteractions>, val images: List<FileAsset.ImageAsset.CarouselImage> = emptyList()) : ChoicesFormat

A choices message displayed as a horizontally scrollable carousel of rich cards.

Link copied to clipboard

The visual presentation style for a choices message.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class DisplayableOptionsFormat(val optionItems: List<OptionItem.TypedOptionItem>, val text: String) : ChoicesFormat

A choices message displayed as vertically stacked buttons.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class ExperienceTypeFormat(val message: String?, val targetType: String, val targetProperty: String?, val sourceType: String, val sourceProperty: String?, val optionType: String?, @Json(name = "options") val optionItems: List<OptionItem.TypedOptionItem.ExperienceTypeOptionItem>) : ChoicesFormat

A choices message used for experience-type selection routing.

Link copied to clipboard
@JsonClass(generateAdapter = true)
class QuickRepliesFormat(val optionItems: List<OptionItem.TypedOptionItem>, val text: String) : ChoicesFormat

A choices message displayed as quick reply suggestions below the message text.

Properties

Link copied to clipboard

The specific format type that determines how this message content is rendered.

Link copied to clipboard
abstract val optionItems: List<OptionItem>

The list of selectable options presented by this message.