AppState
Root Redux Flex application state
Properties:
config: Config
configuration state
session: SessionState
session state
identity?: string
- identity of a logged in userloginError?: any
- last error that occurred when logging inloginState?: LoginState
- current state of the sessionssoTokenPayload?: SSOTokenPayload
- SSO token payloadidentity: string
- identityroles: Array.<string>
- rolestoken: string
- access tokenexpiration: string
- token expiration datedegraded?: boolean
- Indicates if session is degraded
chat: ChatState
chat state
conversations: ConversationsState
- State of conversationssid?: ConversationState
- State of conversations by sidcurrentPaginator?: Paginator
- Paginator class to request messages on previous or next pages. See structure here: {@link https://media.twiliocdn.com/sdk/js/chat/releases/3.2.4/docs/Paginator.html}isLoadingMessages: boolean
- Indicates if messages are currently loadingisLoadingParticipants: boolean
- Indicates if participants are currently loadingisLoadingConversation: boolean
- Indicates if conversation is currently loadinglastReadMessageIndex: number
- Index of the last read messageparticipants: Map.<string, ParticipantState>
- Participants of the chatmessages: Array.<MessageState>
- Messages in the conversationinputText: string
- Text of the messageattachedFiles?: Array.<File>
- Files attached to the messagesource?: Conversation
- Reference to the conversation. See structure here: {@link http://media.twiliocdn.com/sdk/js/conversations/releases/1.1.0/docs/Conversation.html}typers: Array.<ParticipantState>
- Participants, who are currently typing a messagesource: Participant
- Represents the remote client in a Conversation. See structure here: {@link http://media.twiliocdn.com/sdk/js/conversations/releases/1.1.0/docs/Participant.html}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 conversationsession: ChatSessionState
- State of the user sessionconnectionState: string
- State of the connectionisActive: boolean
- Indicates if chat session is activeusers: ChatUserState
- State of chat usersconversationInput: ConversationInputState
- Conversation text input statemessageList: ChatMessageListState
- State of message listisScrollToBottom: boolean
- Whether the ChatMessageList is currently scrolled to the bottomactiveConversation: string
- ID of the conversation currently shown in the ChatMessageList component
worker: WorkerState
worker state
tasks: Map.<string, ITask>
- map of active tasks by reservation SIDactivity: Activity
- current {@link https://twilio.github.io/twilio-taskrouter.js/Activity.html} of the workeractivities: Map.<string, Activity>
- map of all {@link https://twilio.github.io/twilio-taskrouter.js/Activity.html} instances by SIDattributes: object
- attributes of the {@link https://twilio.github.io/twilio-taskrouter.js/Worker.html}worker: IWorker
- current worker instance
phone: PhoneState
voice call state
listener?: DeviceListener
- device listeneractiveCall?: Call
- Source call object {@link https://www.twilio.com/docs/voice/sdks/javascript/twiliocall}
view: ViewState
view state
isSideNavOpen: boolean
- whether the navigation sidebar is openisOutboundDialerOpen: boolean
- whether the navigation sidebar is openactiveView?: string
- name of the currently active viewselectedTaskSid?: string
- ID of the selected task in Agent Desktop viewselectedTaskInSupervisorSid?: string
- ID of the selected task in Teams viewselectedWorkerInSupervisorSid?: string
- ID of the selected worker in Teams viewisDirectoryOpen?: boolean
- whether the call transfer panel is open in Agent Desktop viewcomponentViewStates: object
- object containing persistent components states. Use {@link Actions.SetComponentState} to update.
connectionStatus: ConnectionStatus
connection status
timestampLastConnected: number
- timestamp of last connectionconnectionState: SyncClient.ConnectionState
- connection state of the sync client
insights: InsightsState
insights state
segmentsById: object
- Dictionary of segments with the segmentId as the keyselectedMediaLink?: number
- selected media linkquestionnaires: Array.<IQuestionnaire>
- array of questionnairesassessments: object
- Dictionary of array of assessments with the segmentId as the keycomments: object
- commentsassessmentSettings: IAssessmentSettings
- assessmentSettingsfindingsBySegment: object
- findings by segmentsegmentId: string | undefined
- segmentIdinsightsProjectDashboards: object
- insights project dashboardsinsightsDashboardCategory: object
- insights dashboard categorydrillableItemsByDashboard: object
- drillable items by dashboardprofileInfo: object
- profile info
supervisor: SupervisorState
supervisor state
callMonitoring: CallMonitoring
- state of call monitoringstatus: CallMonitoringStatus
- status of the monitor calltask?: ITask
- Monitored taskworkers?: Array.<IWorker>
- List of the participating the callstickyWorker?: SupervisorWorkerState
- currently selected worker stateworker: IWorker
- worker instancetasks: Array.<ITask>
- tasks of the workerworkers: Array.<SupervisorWorkerState>
- currently showing worker statesworker: IWorker
- worker instancetasks: Array.<ITask>
- tasks of the workerisLoadingWorkers: boolean
- if workers are being loadederrorLoadingWorkers: LiveQueryError
- instance of the error when loading workersappliedFilters: Array.<AppliedFilter>
- array of applied filtersextraFilterQuery: string
- query for custom filterssearch: string
- search string
conferences: ConferencesState
conferences state
client?: SyncClient
- Sync Clientstates: Map.<string, ConferencesState.ConferenceState>
- active conferences states by conference SID
realtimeQueues: QueuesState
realtimeQueues
featureFlags: FeatureFlagsState
featureFlags
flexErrors: FlexErrorState
flexErrors
errors: Array.<FlexError>
- Flex errors
qualityManagement: QualityManagementState
qualityManagement
participants: ParticipantState
participants state
source: Participant
- Represents the remote client in a Conversation. See structure here: {@link http://media.twiliocdn.com/sdk/js/conversations/releases/1.1.0/docs/Participant.html}friendlyName: string
- It represents the friendly name of the remote client.online: boolean
- It represents if the participant is online or not.
exports.LoginState: "UNKNOWN" | "LOGGING_IN" | "LOGGED_IN" | "LOGGED_OUT" | "ERROR"#
Login states
Properties:
Unknown: "UNKNOWN"
Unknown
LoggingIn: "LOGGING_IN"
LoggingIn
LoggedIn: "LOGGED_IN"
LoggedIn
LoggedOut: "LOGGED_OUT"
LoggedOut
Error: "ERROR"
Error