Interface TourStepGenericItem<TUserDefinedType>

TODO TOUR: If we end up supporting this user_defined approach longer term, instead of something officially supported by the back-end, then we need to add this to the types repo.

interface TourStepGenericItem<TUserDefinedType = Record<string, unknown>> {
    agent_message_type?: AgentMessageType;
    message_options?: GenericItemMessageOptions;
    response_type: MessageResponseTypes;
    step_id: string;
    streaming_metadata?: ItemStreamingMetadata;
    user_defined?: TUserDefinedType;
}

Type Parameters

  • TUserDefinedType = Record<string, unknown>

Hierarchy (View Summary, Expand)

Properties

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

step_id

step_id: string

A way for the authors to label steps so they can use the TourFunctions.goToStep function to change to a specific tour step.

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.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR