Interface GridItem<TUserDefinedType>

The basic class for items returned from a back-end as part of a message response. These are the items contained in the MessageOutput.generic array.

interface GridItem<TUserDefinedType = Record<string, unknown>> {
    agent_message_type?: AgentMessageType;
    columns: { width: string }[];
    horizontal_alignment?: HorizontalCellAlignment;
    max_width?: WidthOptions;
    message_options?: GenericItemMessageOptions;
    response_type: MessageResponseTypes;
    rows: {
        cells: {
            horizontal_alignment?: HorizontalCellAlignment;
            items: GenericItem<Record<string, unknown>>[];
            vertical_alignment?: VerticalCellAlignment;
        }[];
    }[];
    streaming_metadata?: ItemStreamingMetadata;
    user_defined?: TUserDefinedType;
    vertical_alignment?: VerticalCellAlignment;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary, Expand)

Properties

agent_message_type? columns horizontal_alignment? max_width? message_options? response_type rows streaming_metadata? user_defined? vertical_alignment?

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.

columns

columns: { width: string }[]

The list of columns specifications. This will determine the maximum number of columns that can be rendered.

Optionalhorizontal_alignment

horizontal_alignment?: HorizontalCellAlignment

Determines the horizontal alignment of all items in the grid.

Optionalmax_width

max_width?: WidthOptions

Sets an optional max width of the component. Options are small, medium and large. By default, the component will be 100% width of the container.

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: {
    cells: {
        horizontal_alignment?: HorizontalCellAlignment;
        items: GenericItem<Record<string, unknown>>[];
        vertical_alignment?: VerticalCellAlignment;
    }[];
}[]

A list of rows to render.

Type declaration

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.

Optionaluser_defined

user_defined?: TUserDefinedType

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

Optionalvertical_alignment

vertical_alignment?: VerticalCellAlignment

Determines the vertical alignment of all items in the grid.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR