Interface PauseItem<TUserDefinedType>

A pause item returned in a message response from a back-end. This indicates that the client should pause before displaying additional response items.

interface PauseItem<TUserDefinedType = Record<string, unknown>> {
    agent_message_type?: AgentMessageType;
    message_options?: GenericItemMessageOptions;
    response_type: MessageResponseTypes;
    streaming_metadata?: ItemStreamingMetadata;
    time?: number;
    typing?: boolean;
    user_defined?: TUserDefinedType;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary)

Properties

agent_message_type? message_options? response_type streaming_metadata? time? typing? 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.

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.

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.

Optionaltime

time?: number

How long to pause, in milliseconds.

Optionaltyping

typing?: boolean

Whether to display an "is typing" indicator during the pause.

Optionaluser_defined

user_defined?: TUserDefinedType

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

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR