Interface BusEventAgentPreStartChat<TPayloadType>

This event is fired before the user is connected to a service desk. This occurs as soon as the user clicks the "Request agent" button and before any attempt is made to communicate with the service desk.

interface BusEventAgentPreStartChat<TPayloadType = unknown> {
    cancelStartChat?: boolean;
    message: MessageResponse;
    preStartChatPayload?: TPayloadType;
    sessionHistoryKey: string;
    type: AGENT_PRE_START_CHAT;
}

Type Parameters

  • TPayloadType = unknown

Hierarchy (View Summary, Expand)

Properties

cancelStartChat? message preStartChatPayload? sessionHistoryKey type

Properties

OptionalcancelStartChat

cancelStartChat?: boolean

This flag can be set by a listener to indicate that the connection process should be cancelled.

message

message: MessageResponse

The message that was used to trigger the connection to the agent.

OptionalpreStartChatPayload

preStartChatPayload?: TPayloadType

Some arbitrary payload of data that will be passed to the service desk when a chat is started.

sessionHistoryKey

sessionHistoryKey: string

The key that can be provided for the agent app configuration to load an agent app version of web chat.

type

type: AGENT_PRE_START_CHAT

The type of the event.

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR