Session state interface
Properties:
| Name | Type | Description |
|---|---|---|
identity |
string | id of the current user |
isEntryPointExpanded |
boolean | Whether the chat window is expanded or not |
channelSid |
string | Chat channel Sid |
engagementStage |
SessionState.EngagementStage | Stage of the engagement |
ignorePersisted |
boolean | Whether ignore previous chat sessions are on page refresh or not |
avatars |
Map.<string, string> | Map of user avatars from 'avatar' property of chat users |
tokenPayload |
SessionState.TokenPayload | Token payload |
Members
"CF_INIT_ENGAGEMENT"
|
"CF_PRE_ENGAGEMENT"
|
"CF_IN_ENGAGEMENT"
|
"CF_WAITING_ENGAGEMENT"
# static exports.EngagementStage
State of the current engagement
Properties:
| Name | Type | Description |
|---|---|---|
INIT_ENGAGEMENT |
"CF_INIT_ENGAGEMENT" | |
PRE_ENGAGEMENT |
"CF_PRE_ENGAGEMENT" | |
IN_ENGAGEMENT |
"CF_IN_ENGAGEMENT" | |
WAITING_ENGAGEMENT |
"CF_WAITING_ENGAGEMENT" |
Type Definitions
Object
# TokenPayload
Token information
Properties:
| Name | Type | Description |
|---|---|---|
identity |
string | identity |
expiration |
string | token expiration date |
roles |
Array.<string> | roles |
token |
string | access token |