AppState

configuration state

session state

• identity?: string - identity of a logged in user
• loginError?: any - last error that occurred when logging in
• loginState?: LoginState - current state of the session
• ssoTokenPayload?: SSOTokenPayload - SSO token payload
• identity: string - identity
• roles: Array<string> - roles
• token: string - access token
• expiration: string - token expiration date
• permissions: Permissions - all permissions user have
• degraded?: boolean - Indicates if session is degraded

chat state

• conversations: ConversationsState - State of conversations
• sid?: ConversationState - State of conversations by sid
• currentPaginator?: Paginator - Paginator class to request messages on previous or next pages. See structure here.
• isLoadingMessages: boolean - Indicates if messages are currently loading

  Default Value:

  false

• isLoadingParticipants: boolean - Indicates if participants are currently loading

  Default Value:

  false

• isLoadingConversation: boolean - Indicates if conversation is currently loading

  Default Value:

  false

• lastReadMessageIndex: number - Index of the last read message

  Default Value:

  0

• participants: Map<string, ParticipantState> - Participants of the chat
• messages: Array<MessageState> - Messages in the conversation

  Default Value:

  Map()

• inputText: string - Text of the message

  Default Value:

  ""

• selectionStart: number - Start index of the cursor selection

  Default Value:

  0

• selectionEnd: number - End index of the cursor selection

  Default Value:

  0

• attachedFiles?: Array<File> - Files attached to the message
• source?: Conversation - Reference to the conversation. See structure here.
• typers: Array<ParticipantState> - Participants, who are currently typing a message
• source: Participant - Represents the remote client in a Conversation. See structure here.
• friendlyName: string - It represents the friendly name of the remote client.
• online: boolean - It represents if the participant is online or not.
• errorWhileLoadingConversation: boolean - Indicates if there was an error while loading a conversation

  Default Value:

  false

• session: ChatSessionState - State of the user session
• connectionState: string - State of the connection

  Default Value:

  ""

• isActive: boolean - Indicates if chat session is active

  Default Value:

  true

• users: ChatUserState - State of chat users
• conversationInput: ConversationInputState - Conversation text input state
• messageList: ChatMessageListState - State of message list
• isScrollToBottom: boolean - Whether the ChatMessageList is currently scrolled to the bottom
• activeConversation: string - ID of the conversation currently shown in the ChatMessageList component

worker state

• tasks: Map<string, ITask> - map of active tasks by reservation SID
• activity: Activity - current Activity of the worker.
• activities: Map<string, Activity> - map of all Activities instances by SID.
• attributes: object - attributes of the Worker.
• worker: IWorker - current worker instance.

voice call state

• listener?: DeviceListener - device listener
• activeCall?: Call - Source call object. See

view state

• isSideNavOpen: boolean - whether the navigation sidebar is open
• isOutboundDialerOpen: boolean - whether the navigation sidebar is open
• activeView?: string - name of the currently active view
• selectedTaskSid?: string - ID of the selected task in Agent Desktop view
• selectedTaskInSupervisorSid?: string - ID of the selected task in Teams view
• selectedWorkerInSupervisorSid?: string - ID of the selected worker in Teams view
• isDirectoryOpen?: boolean - whether the call transfer panel is open in Agent Desktop view
• componentViewStates: object - object containing persistent components states. Use {@link Actions.SetComponentState} to update.

app status

• isAppStatusPanelOpen: boolean - whether the navigation sidebar is open

connection status

• timestampLastConnected: number - timestamp of last connection
• connectionState: SyncClient.ConnectionState - connection state of the sync client

insights state

• segmentsById: object - Dictionary of segments with the segmentId as the key
• selectedMediaLink?: number - selected media link
• questionnaires: Array<IQuestionnaire> - array of questionnaires
• assessments: object - Dictionary of array of assessments with the segmentId as the key
• comments: object - comments
• assessmentSettings: IAssessmentSettings - assessmentSettings
• findingsBySegment: object - findings by segment
• segmentId: string | undefined - segmentId
• insightsProjectDashboards: object - insights project dashboards
• insightsDashboardCategory: object - insights dashboard category
• drillableItemsByDashboard: object - drillable items by dashboard
• drillableItemsAttributes: Array<string> - global drillable attributes
• profileInfo: object - profile info

supervisor state

• callMonitoring: CallMonitoring - state of call monitoring
• status: CallMonitoringStatus - status of the monitor call
• task?: ITask - Monitored task
• workers?: Array<IWorker> - List of the participating the call
• stickyWorker?: SupervisorWorkerState - currently selected worker state
• worker: IWorker - worker instance
• tasks: Array<ITask> - tasks of the worker
• workers: Array<SupervisorWorkerState> - currently showing worker states
• worker: IWorker - worker instance
• tasks: Array<ITask> - tasks of the worker
• isLoadingWorkers: boolean - if workers are being loaded
• errorLoadingWorkers: LiveQueryError - instance of the error when loading workers
• appliedFilters: Array<AppliedFilter> - array of applied filters
• extraFilterQuery: string - query for custom filters
• search: string - search string

conferences state

• states: Map<string, ConferencesState.ConferenceState> - active conferences states by conference SID

realtimeQueues

featureFlags

flexErrors

• errors: Array<FlexError> - Flex errors

qualityManagement

participants state

• source: Participant - Represents the remote client in a Conversation. See structure here.
• friendlyName: string - It represents the friendly name of the remote client.
• online: boolean - It represents if the participant is online or not.

profileConnector state

• isProfileConnectorPanelOpen: boolean - whether the navigation sidebar is open

Unknown

LoggingIn

LoggedIn

LoggedOut

Error