Interface IFrameItem<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 IFrameItem<TUserDefinedType = Record<string, unknown>> {
    agent_message_type?: AgentMessageType;
    description?: string;
    display?: IFrameItemDisplayOption;
    image_url?: string;
    message_options?: GenericItemMessageOptions;
    response_type: MessageResponseTypes;
    source: string;
    streaming_metadata?: ItemStreamingMetadata;
    title?: string;
    user_defined?: TUserDefinedType;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary, Expand)

Properties

agent_message_type? description? display? image_url? message_options? response_type source 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

The description of the source URL. This property is unfurled from the source URL at runtime. It is used when IFrameItemDisplayOption is set to 'panel' for the preview card to open the panel.

Optionaldisplay

display?: IFrameItemDisplayOption

How the iframe should be displayed.

Optionalimage_url

image_url?: string

The preview image of the source URL. This property is unfurled from the source URL at runtime. It is used when IFrameItemDisplayOption is set to 'panel' for the preview card to open the panel.

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.

source

source: string

The source URL to an embeddable page

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

The title of the source URL. This property is unfurled from the source URL at runtime. It is used when IFrameItemDisplayOption is set to 'panel' for the preview card to open the panel.

Optionaluser_defined

user_defined?: TUserDefinedType

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

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR