Interface OptionItem<TUserDefinedType>

An option item returned in a message response from a back-end. This response type is used when displaying a list of options to the user. How the options are displayed is up to the client but is often displayed in either a drop-down or as a list of buttons.

interface OptionItem<TUserDefinedType = Record<string, unknown>> {
    agent_message_type?: AgentMessageType;
    description?: string;
    message_options?: GenericItemMessageOptions;
    options: Option[];
    preference?: OptionItemPreference;
    response_type: MessageResponseTypes;
    streaming_metadata?: ItemStreamingMetadata;
    title?: string;
    user_defined?: TUserDefinedType;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary, Expand)

Properties

agent_message_type? description? message_options? options preference? response_type streaming_metadata? title? user_defined?

Properties

Optionalagent_message_type

agent_message_type?: AgentMessageType

For messages that are sent between the user and a human agent, we assign an agent type to the message to distinguish what type it is.

Optionaldescription

description?: string

An optional description to be shown alongside the options.

Optionalmessage_options

message_options?: GenericItemMessageOptions

Options that control additional features available for a message item.

options

options: Option[]

An array of objects describing the options from which the user can choose.

Optionalpreference

preference?: OptionItemPreference

The preferred type of control to display.

response_type

response_type: MessageResponseTypes

The response type of this message item.

Optionalstreaming_metadata

streaming_metadata?: ItemStreamingMetadata

Metadata used identify a generic item within the context of a stream in order to correlate any updates meant for a specific item.

Optionaltitle

title?: string

An optional title to be shown alongside the options.

Optionaluser_defined

user_defined?: TUserDefinedType

An optional buckets of additional user defined properties for this item.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR