Interface PublicWebChatState

This is the state made available by calling getState. This is a public method that returns immutable values.

interface PublicWebChatState {
    hasUserSentMessage: boolean;
    isConnectedWithHumanAgent: boolean;
    isConnectingWithHumanAgent: boolean;
    isDebugEnabled: boolean;
    isHomeScreenOpen: boolean;
    isTourActive: boolean;
    isWebChatOpen: boolean;
    serviceDesk: PublicWebChatServiceDeskState;
    viewState: ViewState;
}

Properties

hasUserSentMessage: boolean

Has the user sent a message that isn't requesting the welcome node.

isConnectedWithHumanAgent: boolean

Is the web chat currently connected with a human agent.

isConnectingWithHumanAgent: boolean

Indicates if web chat has requested to be connected to a human agent but an agent has not yet joined the conversation.

isDebugEnabled: boolean

Indicates if debugging is enabled.

isHomeScreenOpen: boolean

Is the home screen open.

isTourActive: boolean

Whether there is an active tour currently.

isWebChatOpen: boolean

Is the web chat currently in an open state.

State regarding service desks.

viewState: ViewState

The current viewState of the web chat.