Interface TableItem<TUserDefinedType>

A table item returned in a message response from a back-end. This response type is used when displaying a table of data to the user. The content of the table is up to the client and is authored using json.

interface TableItem<TUserDefinedType = Record<string, unknown>> {
    agent_message_type?: AgentMessageType;
    description?: string;
    headers: TableItemCell[];
    message_options?: GenericItemMessageOptions;
    response_type: MessageResponseTypes;
    rows: TableItemRow[];
    streaming_metadata?: ItemStreamingMetadata;
    title?: string;
    user_defined?: TUserDefinedType;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary, Expand)

Properties

agent_message_type? description? headers message_options? response_type rows 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

Optional description of the table.

headers

headers: TableItemCell[]

The array of headers for the table.

Optionalmessage_options

message_options?: GenericItemMessageOptions

Options that control additional features available for a message item.

response_type

response_type: MessageResponseTypes

The response type of this message item.

rows

rows: TableItemRow[]

The array of row objects for the table.

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

Optional title for the table.

Optionaluser_defined

user_defined?: TUserDefinedType

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

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR