This is an inner container for WorkersDirectory that renders the workers and queues tabs. Can be used to add or remove tabs on that component.
","tags":[{"originalTitle":"component","title":"component","text":""},{"originalTitle":"category","title":"category","text":"Components / Programmable"},{"originalTitle":"subcategory","title":"subcategory","text":"Components"}],"component":{"displayName":"WorkerDirectoryTabs","param":"WorkerDirectoryTabs.WorkerDirectoryTabsProps","type":"react","children":[{"key":"tabs","condition":"","description":"Worker directory tabs. Displays the workers list and search bar in one tab, and the queues list and search bar in another tab.","type":"React component","align":"left"},{"key":"workers","condition":"","description":"The specific tab item for the workers list. When clicked this will switch to the tab displaying the list of workers.","type":"React component","align":""},{"key":"workers-container","condition":"","description":"Wrapper for the workers-input-container, workers-input-field, item-container and specific worker details.","type":"styled(FlexBoxColumn)","align":""},{"key":"workers-input-container","condition":"","description":"This is a wrapper for the search bar.","type":"styled(div)","align":""},{"key":"workers-input-field","condition":"","description":"The search bar displayed above the cards of workers which can be used to search for a specific worker in the list.","type":"styled(Input)","align":"start"},{"key":"WKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","condition":"Will display once the details of the workers have loaded.","description":"The key of this component is dynamically generated, and will correspond to the worker sid. This item contains the worker avatar, worker name and worker status. This will have one or two transfer buttons if the worker is available. The cold transfer button is always available if the worker is available to take a call, the warm transfer button is only available if the warm transfers setting is enabled.","type":"React component","align":""},{"key":"queues","condition":"","description":"The specific tab item for the queues list. When clicked this will switch to the tab displaying the list of queues.","type":"React component","align":""},{"key":"queues-container","condition":"","description":"Wrapper for the queues-input-container, queues-input-field, item-container and specific queue details.","type":"styled(FlexBoxColumn)","align":""},{"key":"queues-input-container","condition":"","description":"This is a wrapper for the search bar.","type":"styled(div)","align":""},{"key":"queues-input-field","condition":"","description":"The search bar displayed above the cards of queues which can be used to search for a specific queue in the list.","type":"styled(Input)","align":"start"},{"key":"WQXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","condition":"Will display once the details of the queues have loaded.","description":"The key of this component is dynamically generated, and will correspond to the queue sid. This item contains the queue avatar and queue name and will have one or two transfer buttons. The cold transfer button is always available, the warm transfer button is only available if this setting is enabled.","type":"QueueItem","align":""},{"key":"directory","condition":"Only displayed if the warm transfers feature is enabled.","description":"The specific tab item for the directory. When clicked this will switch to the tab displaying the directory.","type":"React component","align":""},{"key":"directory-container","condition":"","description":"This contains the external transfer dialpad.","type":"styled(FlexBoxColumn)","align":""},{"key":"item-container","condition":"","description":"Wrapper which will contain either a loading symbol (if worker-item or queue-item is still loading) or will contain each individual worker-item or queue-item.","type":"styled(FlexBox)","align":"vertical"}]},"type":null}}]},"definitionsQuery":{"edges":[{"node":{"kind":"typedef","comment":"/**\n * Properties of WorkerDirectory\n *\n * @typedef {TaskContextProps} WorkerDirectoryTabs.WorkerDirectoryTabsProps\n * @property {boolean} isWarmTransferEnabled - Whether warm transfer is enabled.\n * @property {string} [hiddenWorkerFilter] - Extra query filter applied to the query of workers in addition to typed search.\n * @property {string} [hiddenQueueFilter] - DEPRECATED: use queueFilter instead. Extra query filter applied to the query of queues in addition to typed search.\n * @property {Function} [queueFilter] - Predicate function applied for custom queue filtering in addition to typed search.\n * @property {Theme} theme Theme\n */","name":"WorkerDirectoryTabsProps","type":{"names":["TaskContextProps"]},"properties":[{"name":"isWarmTransferEnabled","type":{"names":["boolean"]},"description":"Whether warm transfer is enabled.
","optional":null,"defaultvalue":""},{"name":"hiddenWorkerFilter","type":{"names":["string"]},"description":"Extra query filter applied to the query of workers in addition to typed search.
","optional":true,"defaultvalue":""},{"name":"hiddenQueueFilter","type":{"names":["string"]},"description":"DEPRECATED: use queueFilter instead. Extra query filter applied to the query of queues in addition to typed search.
","optional":true,"defaultvalue":""},{"name":"queueFilter","type":{"names":["function"]},"description":"Predicate function applied for custom queue filtering in addition to typed search.
","optional":true,"defaultvalue":""},{"name":"theme","type":{"names":["Theme"]},"description":"Theme
","optional":null,"defaultvalue":""}]}}]},"childrenDefinitionsQuery":{"edges":[]},"allDefinitionsQuery":{"edges":[{"node":{"kind":"typedef","comment":"/**\n * Callback that returns an array of orchestrations based on a task\n *\n * @callback ChatOrchestrator~ChatOrchestrationsCallback\n * @param {ITask} task task\n * @returns {Arrayorchestrations for reservation accepted events
","optional":null,"defaultvalue":""},{"name":"wrapup","type":{"names":["Setorchestrations for reservation wrapup events
","optional":null,"defaultvalue":""},{"name":"completed","type":{"names":["Setorchestrations for reservation completed events
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Information about the plugin\n * @category Flex Errors\n * @ignore\n * @typedef PluginInfo\n * @property {string} [name] Name of the plugin\n * @property {string} [version] Version of the plugin\n * @memberof FlexError\n */","name":"PluginInfo","type":null,"properties":[{"name":"name","type":{"names":["string"]},"description":"Name of the plugin
","optional":true,"defaultvalue":""},{"name":"version","type":{"names":["string"]},"description":"Version of the plugin
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Flex Error Content\n * @category Flex Errors\n * @ignore\n * @typedef FlexErrorContents\n * @property {FlexErrorType} [type] Type of the error\n * @property {Error} [wrappedError] The original error\n * @property {FlexError.PluginInfo} [plugin] Information about the plugin where the error occured (if applicable)\n * @property {string} [context] Error context, including theme customizations\n * @property {string} [description] Longer and more verbose description of the error than message property, possibly with variable metadata\n * @property {FlexErrorSeverity} [severity] Severity level of the error\n * @property {FlexErrorCategory} [category] Category indicating who is responsible for resolving the error\n * @memberof ErrorManager\n */","name":"FlexErrorContents","type":null,"properties":[{"name":"type","type":{"names":["FlexErrorType"]},"description":"Type of the error
","optional":true,"defaultvalue":""},{"name":"wrappedError","type":{"names":["Error"]},"description":"The original error
","optional":true,"defaultvalue":""},{"name":"plugin","type":{"names":["FlexError.PluginInfo"]},"description":"Information about the plugin where the error occured (if applicable)
","optional":true,"defaultvalue":""},{"name":"context","type":{"names":["string"]},"description":"Error context, including theme customizations
","optional":true,"defaultvalue":""},{"name":"description","type":{"names":["string"]},"description":"Longer and more verbose description of the error than message property, possibly with variable metadata
","optional":true,"defaultvalue":""},{"name":"severity","type":{"names":["FlexErrorSeverity"]},"description":"Severity level of the error
","optional":true,"defaultvalue":""},{"name":"category","type":{"names":["FlexErrorCategory"]},"description":"Category indicating who is responsible for resolving the error
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Information about the session where the error occured\n * @category Flex Errors\n * @ignore\n * @typedef SessionData\n * @property {Config} [config] Session configuration\n * @property {string} [reactVersion] React version\n * @property {string} [bundleType] Bundle type\n * @memberof FlexError\n */","name":"SessionData","type":null,"properties":[{"name":"config","type":{"names":["Config"]},"description":"Session configuration
","optional":true,"defaultvalue":""},{"name":"reactVersion","type":{"names":["string"]},"description":"React version
","optional":true,"defaultvalue":""},{"name":"bundleType","type":{"names":["string"]},"description":"Bundle type
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Keyboard shortcuts - including a key to be passed and the Keyboard Shortcut object\n *\n * @typedef {object} KeyboardShortcuts\n * @property {string} key The key to be associated with the keyboard shortcut\n * @property {KeyboardShortcut} shortcut The keyboard shortcut object\n * @memberof KeyboardShortcutManager\n */","name":"KeyboardShortcuts","type":{"names":["object"]},"properties":[{"name":"key","type":{"names":["string"]},"description":"The key to be associated with the keyboard shortcut
","optional":null,"defaultvalue":""},{"name":"shortcut","type":{"names":["KeyboardShortcut"]},"description":"The keyboard shortcut object
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Keyboard shortcut object containing the action, name and optional throttle\n *\n * @typedef {object} KeyboardShortcut\n * @property {Function} action The action which is triggered by the shortcut\n * @property {string} name The name of the shortcut which will be displayed in error messages if a shortcut does not work\n * @property {number} [throttle] The optional throttle time in ms which can be set to prevent the shortcut from being triggered again within the set amount of time. A notification will show if a shortcut is used repeatedly within the throttle limit time\n * @memberof KeyboardShortcutManager\n * @example\n * {\n * action: Flex.defaultActions.toggleActivityMenu,\n * name: \"Toggle Activity Menu\",\n * throttle: 100\n * }\n */","name":"KeyboardShortcut","type":{"names":["object"]},"properties":[{"name":"action","type":{"names":["function"]},"description":"The action which is triggered by the shortcut
","optional":null,"defaultvalue":""},{"name":"name","type":{"names":["string"]},"description":"The name of the shortcut which will be displayed in error messages if a shortcut does not work
","optional":null,"defaultvalue":""},{"name":"throttle","type":{"names":["number"]},"description":"The optional throttle time in ms which can be set to prevent the shortcut from being triggered again within the set amount of time. A notification will show if a shortcut is used repeatedly within the throttle limit time
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.StartOutboundCallPayload} StartOutboundCallPayload\n * @property {string} destination - destination phone number to make outbound call.\n * @property {string} [queueSid] - queue sid to assign for the task, if undefined it picks the default from service configuration.\n * @property {string} [callerId] - caller ID to make an outbound call. if undefined it picks the default from service configuration.\n * @property {object} [taskAttributes] - custom attributes to set on Task. For Example - Bring your own Carrier SID (byocSid).\n * @memberof Actions\n */","name":"StartOutboundCallPayload","type":{"names":["Actions.StartOutboundCallPayload"]},"properties":[{"name":"destination","type":{"names":["string"]},"description":"destination phone number to make outbound call.
","optional":null,"defaultvalue":""},{"name":"queueSid","type":{"names":["string"]},"description":"queue sid to assign for the task, if undefined it picks the default from service configuration.
","optional":true,"defaultvalue":""},{"name":"callerId","type":{"names":["string"]},"description":"caller ID to make an outbound call. if undefined it picks the default from service configuration.
","optional":true,"defaultvalue":""},{"name":"taskAttributes","type":{"names":["object"]},"description":"custom attributes to set on Task. For Example - Bring your own Carrier SID (byocSid).
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Callback to provide values for Flex. Called from various areas of Flex.\n * @callback TaskCallbackType\n * @param {ITask} task task\n * @param {React.ComponentType} componentType caller component type. One of Flex React components.\n * @param {Arraythe T value associated with the reservationStatus
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @callback TaskChannelApplicableCb\n * @param {ITask} task task to evaluate applicability for\n * @returns {boolean} true if task channel is applicable for given task\n * @memberof TaskChannelDefinition\n * @example\n * import { TaskChannelApplicableCb } from \"@twilio/flex-ui\";\n * const isCallTask: TaskChannelApplicableCb = (task) => task.taskChannelUniqueName === \"voice\";\n */","name":"TaskChannelApplicableCb","type":{"names":["function"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} TaskChannelComponentRegistration\n * @property {string} target of a Flex component. Component must have static \"Content\" property.\n * @property {React.ReactChild} component component to register\n * @property {ContentFragmentProps} options properties for component registration\n * @memberof TaskChannelDefinition\n */","name":"TaskChannelComponentRegistration","type":{"names":["object"]},"properties":[{"name":"target","type":{"names":["string"]},"description":"of a Flex component. Component must have static "Content" property.
","optional":null,"defaultvalue":""},{"name":"component","type":{"names":["React.ReactChild"]},"description":"component to register
","optional":null,"defaultvalue":""},{"name":"options","type":{"names":["ContentFragmentProps"]},"description":"properties for component registration
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} TaskChannelComponentRemoveRequest\n * @property {string} target of a Flex component. Component must have static \"Content\" property.\n * @property {string} key key of a component to remove\n * @property {ContentFragmentProps} options properties for component removal.\n * @memberof TaskChannelDefinition\n */","name":"TaskChannelComponentRemoveRequest","type":{"names":["object"]},"properties":[{"name":"target","type":{"names":["string"]},"description":"of a Flex component. Component must have static "Content" property.
","optional":null,"defaultvalue":""},{"name":"key","type":{"names":["string"]},"description":"key of a component to remove
","optional":null,"defaultvalue":""},{"name":"options","type":{"names":["ContentFragmentProps"]},"description":"properties for component removal.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {TaskStatusBasedTypeBase} TaskSounds\n * @memberof TaskChannelDefinition\n */","name":"TaskSounds","type":{"names":["TaskStatusBasedTypeBase"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Notification override\n * @typedef { Partialoverrides for NotificationId
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef TaskChannelNotificationOptions\n * @property {NotificationOverride} override Map of notification overrides\n * @memberof TaskChannelDefinition\n */","name":"TaskChannelNotificationOptions","type":null,"properties":[{"name":"override","type":{"names":["NotificationOverride"]},"description":"Map of notification overrides
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Interface to define a task channel for Flex\n * @typedef TaskChannelDefinition\n * @property {string} name name of the task channel definition\n * @property {TaskChannelApplicableCb} isApplicable Callback to determine whether this task channel is applicable for a given task.\n * @property {Setname of the task channel definition
","optional":null,"defaultvalue":""},{"name":"isApplicable","type":{"names":["TaskChannelApplicableCb"]},"description":"Callback to determine whether this task channel is applicable for a given task.
","optional":null,"defaultvalue":""},{"name":"capabilities","type":{"names":["Setcapabilities of task channel
","optional":null,"defaultvalue":""},{"name":"charLimit","type":{"names":["number"]},"description":"message character limit for task channel with chat capabilities
","optional":null,"defaultvalue":""},{"name":"colors","type":{"names":["object"]},"description":"colors to be used
","optional":true,"defaultvalue":""},{"name":"colors.main","type":{"names":["TaskStatusBasedType"]},"description":"main color code as string to use in TaskList, TaskCard, Canvases
","optional":true,"defaultvalue":""},{"name":"sounds","type":{"names":["TaskChannelDefinition.TaskSounds"]},"description":"sounds to be used for specific tasks
","optional":true,"defaultvalue":""},{"name":"icons","type":{"names":["object"]},"description":"icons to render for the task channel
","optional":true,"defaultvalue":""},{"name":"icons.list","type":{"names":["TaskStatusBasedType"]},"description":"list icon to be used in TaskList and TaskCardList
","optional":true,"defaultvalue":""},{"name":"icons.main","type":{"names":["TaskStatusBasedType"]},"description":"icon to be used in Tab headers if tab is not selected
","optional":true,"defaultvalue":""},{"name":"icons.active","type":{"names":["TaskStatusBasedType"]},"description":"icon to be used in Tab headers if tab is selected and in Task Canvases as the main icon
","optional":true,"defaultvalue":""},{"name":"templates","type":{"names":["object"]},"description":"template strings for components
","optional":true,"defaultvalue":""},{"name":"templates.IncomingTaskCanvas","type":{"names":["object"]},"description":"templates for IncomingTaskCanvas
","optional":true,"defaultvalue":""},{"name":"templates.IncomingTaskCanvas.firstLine","type":{"names":["TaskStatusBasedType"]},"description":"first line
","optional":true,"defaultvalue":""},{"name":"templates.IncomingTaskCanvas.secondLine","type":{"names":["TaskStatusBasedType"]},"description":"second line
","optional":true,"defaultvalue":""},{"name":"templates.CallCanvas","type":{"names":["object"]},"description":"templates for CallCanvas
","optional":true,"defaultvalue":""},{"name":"templates.CallCanvas.firstLine","type":{"names":["TaskStatusBasedType"]},"description":"first line
","optional":true,"defaultvalue":""},{"name":"templates.CallCanvas.secondLine","type":{"names":["TaskStatusBasedType"]},"description":"second line
","optional":true,"defaultvalue":""},{"name":"templates.TaskListItem","type":{"names":["object"]},"description":"templates for TaskListItem
","optional":true,"defaultvalue":""},{"name":"templates.TaskListItem.firstLine","type":{"names":["TaskStatusBasedType"]},"description":"first line
","optional":true,"defaultvalue":""},{"name":"templates.TaskListItem.secondLine","type":{"names":["TaskStatusBasedType"]},"description":"second line
","optional":true,"defaultvalue":""},{"name":"templates.TaskListItem.extraInfo","type":{"names":["TaskStatusBasedType"]},"description":"extra info to be shown
","optional":true,"defaultvalue":""},{"name":"templates.TaskCanvasHeader","type":{"names":["object"]},"description":"templates for TaskCanvasHeader
","optional":true,"defaultvalue":""},{"name":"templates.TaskCanvasHeader.title","type":{"names":["TaskStatusBasedType"]},"description":"title
","optional":true,"defaultvalue":""},{"name":"templates.TaskCanvasHeader.endButton","type":{"names":["TaskStatusBasedType"]},"description":"end button text
","optional":true,"defaultvalue":""},{"name":"templates.TaskCard","type":{"names":["object"]},"description":"templates for TaskCard
","optional":true,"defaultvalue":""},{"name":"templates.TaskCard.firstLine","type":{"names":["TaskStatusBasedType"]},"description":"first line
","optional":true,"defaultvalue":""},{"name":"templates.TaskCard.secondLine","type":{"names":["TaskStatusBasedType"]},"description":"second line
","optional":true,"defaultvalue":""},{"name":"templates.TaskInfoPanel","type":{"names":["object"]},"description":"templates for TaskInfoPanel
","optional":true,"defaultvalue":""},{"name":"templates.TaskInfoPanel.content","type":{"names":["TaskStatusBasedType"]},"description":"content of the panel
","optional":true,"defaultvalue":""},{"name":"templates.Supervisor","type":{"names":["object"]},"description":"templates for components for supervisors
","optional":true,"defaultvalue":""},{"name":"templates.Supervisor.TaskCanvasHeader","type":{"names":["object"]},"description":"templates for Supervisor.TaskCanvasHeader
","optional":true,"defaultvalue":""},{"name":"templates.Supervisor.TaskCanvasHeader.title","type":{"names":["TaskStatusBasedType"]},"description":"title
","optional":true,"defaultvalue":""},{"name":"templates.Supervisor.TaskCanvasHeader.endButton","type":{"names":["TaskStatusBasedType"]},"description":"end button text
","optional":true,"defaultvalue":""},{"name":"templates.Supervisor.TaskInfoPanel","type":{"names":["object"]},"description":"templates for Supervisor.TaskInfoPanel
","optional":true,"defaultvalue":""},{"name":"templates.Supervisor.TaskInfoPanel.content","type":{"names":["TaskStatusBasedType"]},"description":"content of the panel
","optional":true,"defaultvalue":""},{"name":"templates.Supervisor.TaskOverviewCanvas","type":{"names":["object"]},"description":"templates for Supervisor.TaskOverviewCanvas
","optional":true,"defaultvalue":""},{"name":"templates.Supervisor.TaskOverviewCanvas.firstLine","type":{"names":["TaskStatusBasedType"]},"description":"first line
","optional":true,"defaultvalue":""},{"name":"templates.Supervisor.TaskOverviewCanvas.secondLine","type":{"names":["TaskStatusBasedType"]},"description":"second line
","optional":true,"defaultvalue":""},{"name":"addedComponents","type":{"names":["Arraycomponents to be added for task channel
","optional":true,"defaultvalue":""},{"name":"replacedComponents","type":{"names":["Arraycomponents to be replaced for task channel
","optional":true,"defaultvalue":""},{"name":"removedComponents","type":{"names":["Arraycomponent removal request for task channel
","optional":true,"defaultvalue":""},{"name":"componentProps","type":{"names":["object"]},"description":"Object of task-channel specific components props
","optional":null,"defaultvalue":""},{"name":"notifications","type":{"names":["TaskChannelNotificationOptions"]},"description":"Notification properties
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} LeaveChannelPayload\n * @property {string} channelSid The associated channelSid\n * @memberof Actions\n * @since 2.9.0\n */","name":"LeaveChannelPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"channelSid","type":{"names":["string"]},"description":"The associated channelSid
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} PauseChannelPayload\n * @property {string} channelSid The associated channelSid\n * @memberof Actions\n * @since 2.9.0\n */","name":"PauseChannelPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"channelSid","type":{"names":["string"]},"description":"The associated channelSid
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} ResumeChannelPayload\n * @property {string} channelSid The associated channelSid\n * @memberof Actions\n * @since 2.9.0\n */","name":"ResumeChannelPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"channelSid","type":{"names":["string"]},"description":"The associated channelSid
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} SelectPausedConversationPayload\n * @property {string} sid The associated conversationSid\n * @memberof Actions\n * @since 2.9.0\n */","name":"SelectPausedConversationPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"sid","type":{"names":["string"]},"description":"The associated conversationSid
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {object} SelectViewPayload\n * @property {string} viewName\n * @memberof Actions\n */","name":"SelectViewPayload","type":{"names":["object"]},"properties":[{"name":"viewName","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef ToggleSidebarPayload\n * @property {boolean} [open]\n * @memberof Actions\n */","name":"ToggleSidebarPayload","type":null,"properties":[{"name":"open","type":{"names":["boolean"]},"description":null,"optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef SetComponentStatePayload\n * @property {string} name\n * @property {any} state\n * @memberof Actions\n */","name":"SetComponentStatePayload","type":null,"properties":[{"name":"name","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":""},{"name":"state","type":{"names":["any"]},"description":null,"optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef ReloadWindowPayload\n * @property {boolean} [forceLogin]\n * @memberof Actions\n */","name":"ReloadWindowPayload","type":null,"properties":[{"name":"forceLogin","type":{"names":["boolean"]},"description":null,"optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef SelectWorkerInSupervisorPayload\n * @property {IWorker} [worker] worker\n * @property {string} [workerSid] workerSid\n * @memberof Actions\n */","name":"SelectWorkerInSupervisorPayload","type":null,"properties":[{"name":"worker","type":{"names":["IWorker"]},"description":"worker
","optional":true,"defaultvalue":""},{"name":"workerSid","type":{"names":["string"]},"description":"workerSid
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef TaskInSupervisorPayload\n * @property {ITask} [task] task\n * @property {string} [sid] taskSid\n * @memberof Actions\n */","name":"TaskInSupervisorPayload","type":null,"properties":[{"name":"task","type":{"names":["ITask"]},"description":"task
","optional":true,"defaultvalue":""},{"name":"sid","type":{"names":["string"]},"description":"taskSid
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {TaskInSupervisorPayload} MonitorTaskPayload\n * @property {any} [extraParams] extra params\n * @memberof Actions\n */","name":"MonitorTaskPayload","type":{"names":["TaskInSupervisorPayload"]},"properties":[{"name":"extraParams","type":{"names":["any"]},"description":"extra params
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef ApplyTeamsViewFiltersPayload\n * @property {AppliedFilter[]} filters array of filters to apply\n * @property {string} [extraFilterQuery] query string for custom filters\n * @memberof Actions\n */","name":"ApplyTeamsViewFiltersPayload","type":null,"properties":[{"name":"filters","type":{"names":["Arrayarray of filters to apply
","optional":null,"defaultvalue":""},{"name":"extraFilterQuery","type":{"names":["string"]},"description":"query string for custom filters
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef ApplyTeamsViewSearchPayload\n * @property {string} search search string\n * @memberof Actions\n */","name":"ApplyTeamsViewSearchPayload","type":null,"properties":[{"name":"search","type":{"names":["string"]},"description":"search string
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef VoiceActionPayload\n * @property {ITask} [task] Task\n * @property {string} [sid] taskSid\n * @memberof Actions\n */","name":"VoiceActionPayload","type":null,"properties":[{"name":"task","type":{"names":["ITask"]},"description":"Task
","optional":true,"defaultvalue":""},{"name":"sid","type":{"names":["string"]},"description":"taskSid
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Hold Call Action Payload\n *\n * @typedef HoldCallActionPayload\n * @property {string} [participantCallSid] Sid of the participant within the call\n * @property {string} [holdMusicUrl] Request URL to fetch the hold music from\n * @property {string} [holdMusicMethod] Request method to fetch the hold music with\n * @memberof Actions\n */","name":"HoldCallActionPayload","type":null,"properties":[{"name":"participantCallSid","type":{"names":["string"]},"description":"Sid of the participant within the call
","optional":true,"defaultvalue":""},{"name":"holdMusicUrl","type":{"names":["string"]},"description":"Request URL to fetch the hold music from
","optional":true,"defaultvalue":""},{"name":"holdMusicMethod","type":{"names":["string"]},"description":"Request method to fetch the hold music with
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Unhold Call Action Payload\n *\n * @typedef UnholdCallActionPayload\n * @property {string} [participantCallSid] Sid of the participant within the call\n * @memberof Actions\n */","name":"UnholdCallActionPayload","type":null,"properties":[{"name":"participantCallSid","type":{"names":["string"]},"description":"Sid of the participant within the call
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef WorkerActionPayload\n * @property {ITask} [task] - targeted task object. Either this or sid property is required\n * @property {string} [sid] - targeted task object's sid. Either this or task property is required\n * @memberof Actions\n */","name":"WorkerActionPayload","type":null,"properties":[{"name":"task","type":{"names":["ITask"]},"description":"targeted task object. Either this or sid property is required
","optional":true,"defaultvalue":""},{"name":"sid","type":{"names":["string"]},"description":"targeted task object's sid. Either this or task property is required
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} TransferTaskPayload\n * @property {string} targetSid - sid of the worker or the queue to be transferred to\n * @property {any} [options] - transfer options (see [Taskrouter](https://www.twilio.com/docs/taskrouter) docs for options).\n * @memberof Actions\n */","name":"TransferTaskPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"targetSid","type":{"names":["string"]},"description":"sid of the worker or the queue to be transferred to
","optional":null,"defaultvalue":""},{"name":"options","type":{"names":["any"]},"description":"transfer options (see Taskrouter docs for options).
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} WorkerParticipantActionPayload\n * @property {string} [targetSid] - sid of the participant (either this or participant has to be provided)\n * @property {ConferenceParticipant} [participant] - participant object (either this or participant has to be provided)\n * @property {string} [holdMusicUrl] - url of audio to play when on hold\n * @property {string} [holdMusicMethod] - name of hold music method\n * @since 2.0.0\n * @memberof Actions\n */","name":"WorkerParticipantActionPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"targetSid","type":{"names":["string"]},"description":"sid of the participant (either this or participant has to be provided)
","optional":true,"defaultvalue":""},{"name":"participant","type":{"names":["ConferenceParticipant"]},"description":"participant object (either this or participant has to be provided)
","optional":true,"defaultvalue":""},{"name":"holdMusicUrl","type":{"names":["string"]},"description":"url of audio to play when on hold
","optional":true,"defaultvalue":""},{"name":"holdMusicMethod","type":{"names":["string"]},"description":"name of hold music method
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef WorkerSetActivityPayload\n * @property {boolean} [activityAvailable] if the activity is available\n * @property {string} [activityName] name of activity\n * @property {string} [activitySid] sid of activity\n * @property {boolean} [options.rejectPendingReservations] if pending reservations should be rejected\n * @memberof Actions\n */","name":"WorkerSetActivityPayload","type":null,"properties":[{"name":"activityAvailable","type":{"names":["boolean"]},"description":"if the activity is available
","optional":true,"defaultvalue":""},{"name":"activityName","type":{"names":["string"]},"description":"name of activity
","optional":true,"defaultvalue":""},{"name":"activitySid","type":{"names":["string"]},"description":"sid of activity
","optional":true,"defaultvalue":""},{"name":"options.rejectPendingReservations","type":{"names":["boolean"]},"description":"if pending reservations should be rejected
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef WorkerSetWorkerActivityPayload\n * @property {string} [workerSid] - sid of the worker\n * @memberof WorkerActions\n */","name":"WorkerSetWorkerActivityPayload","type":null,"properties":[{"name":"workerSid","type":{"names":["string"]},"description":"sid of the worker
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef WorkerLogoutPayload\n * @property {boolean} [forceLogout] - supress an error in case offline activity cannot be set for the worker\n * @property {string} [activitySid] - sid of the custom offline activity\n * @memberof Actions\n */","name":"WorkerLogoutPayload","type":null,"properties":[{"name":"forceLogout","type":{"names":["boolean"]},"description":"supress an error in case offline activity cannot be set for the worker
","optional":true,"defaultvalue":""},{"name":"activitySid","type":{"names":["string"]},"description":"sid of the custom offline activity
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef WorkerAcceptTaskActionPayload\n * @property {any} conferenceOptions conferenceOptions\n * @memberof Actions\n */","name":"WorkerAcceptTaskActionPayload","type":null,"properties":[{"name":"conferenceOptions","type":{"names":["any"]},"description":"conferenceOptions
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef ToggleDTMFDialpadPayload\n * @property {boolean} open if dialpad should be opened\n * @memberof Actions\n */","name":"ToggleDTMFDialpadPayload","type":null,"properties":[{"name":"open","type":{"names":["boolean"]},"description":"if dialpad should be opened
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef SetDTMFDialpadDigitsPayload\n * @property {string} digits dialpad input\n * @memberof Actions\n */","name":"SetDTMFDialpadDigitsPayload","type":null,"properties":[{"name":"digits","type":{"names":["string"]},"description":"dialpad input
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef SendDTMFDigitsPayload\n * @property {string} digits dialpad input to send\n * @memberof Actions\n */","name":"SendDTMFDigitsPayload","type":null,"properties":[{"name":"digits","type":{"names":["string"]},"description":"dialpad input to send
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef SetWorkerAttributesPayload\n * @property {WorkerAttributes} [attributes] - Attributes for worker.\n * @property {boolean} [mergeExisting=true] - Represents if new attributes are to be merged with the existing one\n * @memberof Actions\n */","name":"SetWorkerAttributesPayload","type":null,"properties":[{"name":"attributes","type":{"names":["WorkerAttributes"]},"description":"Attributes for worker.
","optional":true,"defaultvalue":""},{"name":"mergeExisting","type":{"names":["boolean"]},"description":"Represents if new attributes are to be merged with the existing one
","optional":true,"defaultvalue":"true"}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef UpdateWorkerTokenPayload\n * @property {string} token newToken\n * @memberof Actions\n */","name":"UpdateWorkerTokenPayload","type":null,"properties":[{"name":"token","type":{"names":["string"]},"description":"newToken
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} SetTaskAttributesPayload\n * @property {object} [attributes] - Attributes for the task.\n * @property {boolean} [mergeExisting] - Represents if new attributes are to be merged with the existing one\n * @memberof Actions\n */","name":"SetTaskAttributesPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"attributes","type":{"names":["object"]},"description":"Attributes for the task.
","optional":true,"defaultvalue":""},{"name":"mergeExisting","type":{"names":["boolean"]},"description":"Represents if new attributes are to be merged with the existing one
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} UpdateWorkerParticipantPayload\n * @property {ReservationParticipantOptions} options - See (ReservationParticipantOptions)(https://twilio.github.io/twilio-taskrouter.js/Reservation.html#.ParticipantOptions__anchor) for more info.\n * @memberof Actions\n */","name":"UpdateWorkerParticipantPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"options","type":{"names":["ReservationParticipantOptions"]},"description":"See (ReservationParticipantOptions)(https://twilio.github.io/twilio-taskrouter.js/Reservation.html#.ParticipantOptions__anchor) for more info.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} UpdateCustomerParticipantPayload\n * @property {TaskParticipantOptions} options - See [TaskPartipantOptions](https://twilio.github.io/twilio-taskrouter.js/Task.html#.ParticipantOptions__anchor) for more info.\n * @memberof Actions\n */","name":"UpdateCustomerParticipantPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"options","type":{"names":["TaskParticipantOptions"]},"description":"See TaskPartipantOptions for more info.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} IssueCallToWorkerPayload\n * @property {string} callerId - The caller id for the call to a Worker.\n * @property {string} twiMLUrl - A valid TwiML URI that is executed on the answering Worker's leg.\n * @property {CallOptions} options - See [CallOptions](https://twilio.github.io/twilio-taskrouter.js/Reservation.html#.CallOptions__anchor) for more info.\n * @memberof Actions\n */","name":"IssueCallToWorkerPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"callerId","type":{"names":["string"]},"description":"The caller id for the call to a Worker.
","optional":null,"defaultvalue":""},{"name":"twiMLUrl","type":{"names":["string"]},"description":"A valid TwiML URI that is executed on the answering Worker's leg.
","optional":null,"defaultvalue":""},{"name":"options","type":{"names":["CallOptions"]},"description":"See CallOptions for more info.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} DequeueTaskPayload\n * @property {DequeueOptions} options - See [DequeueOptions](https://twilio.github.io/twilio-taskrouter.js/Reservation.html#.DequeueOptions__anchor) for more info.\n * @memberof Actions\n */","name":"DequeueTaskPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"options","type":{"names":["DequeueOptions"]},"description":"See DequeueOptions for more info.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {Actions.WorkerActionPayload} IssueCallToWorkerPayload\n * @property {string} callSid - The sid of the Call to redirect.\n * @property {string} twiMLUrl - A valid TwiML URI that is executed on the Caller's leg upon redirecting.\n * @property {RedirectOptions} [options] - See [RedirectOptions](https://twilio.github.io/twilio-taskrouter.js/Reservation.html#.RedirectOptions__anchor) for more info.\n * @memberof Actions\n */","name":"IssueCallToWorkerPayload","type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"callSid","type":{"names":["string"]},"description":"The sid of the Call to redirect.
","optional":null,"defaultvalue":""},{"name":"twiMLUrl","type":{"names":["string"]},"description":"A valid TwiML URI that is executed on the Caller's leg upon redirecting.
","optional":null,"defaultvalue":""},{"name":"options","type":{"names":["RedirectOptions"]},"description":"See RedirectOptions for more info.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of AppStatusPanel theme.\n *\n * @typedef Theme.AppStatusPanelThemeProps\n * @property {CSSProps} Container - Styles container in AppStatusPanel.\n * @property {CSSProps} Container.disabled - Styles disabled state.\n * @property {CSSProps} Header - Styles header in AppStatusPanel.\n * @property {CSSProps} HeaderButton - Styles header button in AppStatusPanel.\n */","name":"AppStatusPanelThemeProps","type":null,"properties":[{"name":"Container","type":{"names":["CSSProps"]},"description":"Styles container in AppStatusPanel.
","optional":null,"defaultvalue":""},{"name":"Container.disabled","type":{"names":["CSSProps"]},"description":"Styles disabled state.
","optional":null,"defaultvalue":""},{"name":"Header","type":{"names":["CSSProps"]},"description":"Styles header in AppStatusPanel.
","optional":null,"defaultvalue":""},{"name":"HeaderButton","type":{"names":["CSSProps"]},"description":"Styles header button in AppStatusPanel.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of AppStatusPanel.\n *\n * @typedef AppStatusPanel.AppStatusPanelProps\n */","name":"AppStatusPanelProps","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of AppStatusPanelChildren.\n *\n * @typedef AppStatusPanel.AppStatusPanelChildrenProps\n * @property {WorkerState} [worker] - Worker state based on Worker SDK.\n * @property {boolean} [hasIncomingCallReservation] - Whether user has incoming call reservation.\n */","name":"AppStatusPanelChildrenProps","type":null,"properties":[{"name":"worker","type":{"names":["WorkerState"]},"description":"Worker state based on Worker SDK.
","optional":true,"defaultvalue":""},{"name":"hasIncomingCallReservation","type":{"names":["boolean"]},"description":"Whether user has incoming call reservation.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of CRMContainer.\n * @typedef CRMContainer.CRMContainerProps\n * @property {Function} [uriCallback=undefined] - A callback that returns an URI to be displayed in CRM container based on a selected task.\n * @property {string} [uri=undefined] - URI that is displayed in CRM container.\n */","name":"CRMContainerProps","type":null,"properties":[{"name":"uriCallback","type":{"names":["function"]},"description":"A callback that returns an URI to be displayed in CRM container based on a selected task.
","optional":true,"defaultvalue":""},{"name":"uri","type":{"names":["string"]},"description":"URI that is displayed in CRM container.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of CRMContainer.\n * @typedef {CRMContainer.CRMContainerProps} CRMContainer.CRMContainerChildrenProps\n */","name":"CRMContainerChildrenProps","type":{"names":["CRMContainer.CRMContainerProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of CustomerProfileView.\n *\n * @typedef CustomerProfileView.CustomerProfileViewProps\n * @property {Profile} [profile=null] - Profile object with customer data.\n * @property {ArrayProfile object with customer data.
","optional":true,"defaultvalue":"null"},{"name":"traits","type":{"names":["ArrayArray of trait mappings and categories.
","optional":true,"defaultvalue":"null"},{"name":"getProfileView","type":{"names":["function"]},"description":"A callback that returns an Profile JSON to be displayed in Profile View.
","optional":true,"defaultvalue":""},{"name":"onClickCancel","type":{"names":["React.MouseEventHandlerAction to dismiss the Profile view.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of CustomerProfileView.\n *\n * @typedef {CustomerProfileView.CustomerProfileViewProps} CustomerProfileView.CustomerProfileViewChildrenProps\n */","name":"CustomerProfileViewChildrenProps","type":{"names":["CustomerProfileView.CustomerProfileViewProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of FlexUnifyContainer.\n * @typedef FlexUnifyContainer.FlexUnifyContainerProps\n */","name":"FlexUnifyContainerProps","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of FlexUnifyContainer.\n * @typedef {FlexUnifyContainer.FlexUnifyContainerProps} FlexUnifyContainer.FlexUnifyContainerChildrenProps\n */","name":"FlexUnifyContainerChildrenProps","type":{"names":["FlexUnifyContainer.FlexUnifyContainerProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Tab properties.\n * @typedef ProfileConnectorTabs.TabProps\n * @property {string} [label] - Tab label.\n * @property {number} [index] - Tab index.\n */","name":"TabProps","type":null,"properties":[{"name":"label","type":{"names":["string"]},"description":"Tab label.
","optional":true,"defaultvalue":""},{"name":"index","type":{"names":["number"]},"description":"Tab index.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of ProfileConnectorTabs.\n * @typedef ProfileConnectorTabs.ProfileConnectorTabsProps\n * @property {string} [selectedTabName] - Selected tab name.\n * @property {React.ReactNode} [profileViewTab] - Content for Profile tab.\n * @property {React.ReactNode} [timelineViewTab] - Content for Timeline tab.\n * @property {React.ReactNode} [crmViewTab] - Content for CRM tab.\n * @property {TabProps} [profileViewTabProps] - Properties for Profile tab.\n * @property {TabProps} [timelineViewTabProps] - Properties for Timeline tab.\n * @property {TabProps} [crmViewTabProps] - Properties for CRM tab.\n */","name":"ProfileConnectorTabsProps","type":null,"properties":[{"name":"selectedTabName","type":{"names":["string"]},"description":"Selected tab name.
","optional":true,"defaultvalue":""},{"name":"profileViewTab","type":{"names":["React.ReactNode"]},"description":"Content for Profile tab.
","optional":true,"defaultvalue":""},{"name":"timelineViewTab","type":{"names":["React.ReactNode"]},"description":"Content for Timeline tab.
","optional":true,"defaultvalue":""},{"name":"crmViewTab","type":{"names":["React.ReactNode"]},"description":"Content for CRM tab.
","optional":true,"defaultvalue":""},{"name":"profileViewTabProps","type":{"names":["TabProps"]},"description":"Properties for Profile tab.
","optional":true,"defaultvalue":""},{"name":"timelineViewTabProps","type":{"names":["TabProps"]},"description":"Properties for Timeline tab.
","optional":true,"defaultvalue":""},{"name":"crmViewTabProps","type":{"names":["TabProps"]},"description":"Properties for CRM tab.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of ProfileConnectorTabs.\n * @typedef {ProfileConnectorTabs.ProfileConnectorTabsProps} ProfileConnectorTabs.ProfileConnectorTabsChildrenProps\n */","name":"ProfileConnectorTabsChildrenProps","type":{"names":["ProfileConnectorTabs.ProfileConnectorTabsProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of ProfileHeader.\n * @typedef ProfileHeader.ProfileHeaderProps\n * @property {RankedProfile} [rankedProfile=null] - RankedProfile object with customer data, optional status and match_percentage.\n * @property {string} [profileConnectorInstanceSid=\"\"] - The SID of the profile connector instance.\n * @property {Function} [getProfileHeader] - A callback that returns a Profile JSON to be displayed in Profile Header.\n * @property {string} [bridgeLabel] - Admin-UI defined value for Unidentified Profiles.\n */","name":"ProfileHeaderProps","type":null,"properties":[{"name":"rankedProfile","type":{"names":["RankedProfile"]},"description":"RankedProfile object with customer data, optional status and match_percentage.
","optional":true,"defaultvalue":"null"},{"name":"profileConnectorInstanceSid","type":{"names":["string"]},"description":"The SID of the profile connector instance.
","optional":true,"defaultvalue":"\"\""},{"name":"getProfileHeader","type":{"names":["function"]},"description":"A callback that returns a Profile JSON to be displayed in Profile Header.
","optional":true,"defaultvalue":""},{"name":"bridgeLabel","type":{"names":["string"]},"description":"Admin-UI defined value for Unidentified Profiles.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of ProfileHeader.\n * @typedef {ProfileHeader.ProfileHeaderProps} ProfileHeader.ProfileHeaderChildrenProps\n */","name":"ProfileHeaderChildrenProps","type":{"names":["ProfileHeader.ProfileHeaderProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of ProfileHeaderText.\n * @typedef ProfileHeaderText.ProfileHeaderTextProps\n * @property {boolean} [weakNameTextColor] - Display the Name title in weaker text color.\n * @property {boolean} [unknownProfileBadge] - Display the badge-style Created-At subtitle for an unknown profile.\n * @deprecated\n * @altRecommendation MappedData type has been replaced by ProfileHeaderMappedData. Use ProfileHeaderMappedData instead.\n * @altRecommendationExample ProfileHeaderMappedData\n * @deprecatedSince 2.13.0\n * @property {MappedData} [processedProfile] - Contains title and subtitle data to be displayed.\n * @since 2.9.0\n */","name":"ProfileHeaderTextProps","type":null,"properties":[{"name":"weakNameTextColor","type":{"names":["boolean"]},"description":"Display the Name title in weaker text color.
","optional":true,"defaultvalue":""},{"name":"unknownProfileBadge","type":{"names":["boolean"]},"description":"Display the badge-style Created-At subtitle for an unknown profile.
","optional":true,"defaultvalue":""},{"name":"processedProfile","type":{"names":["MappedData"]},"description":"Contains title and subtitle data to be displayed.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of ProfileHeaderText.\n * @typedef {ProfileHeaderText.ProfileHeaderTextProps} ProfileHeaderText.ProfileHeaderTextChildrenProps\n * @since 2.9.0\n */","name":"ProfileHeaderTextChildrenProps","type":{"names":["ProfileHeaderText.ProfileHeaderTextProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of ProfileHighlights\n * @typedef ProfileHighlights.ProfileHighlightsProps\n * @property {string} [profileHighlightsTitle] - Profile Highlights Title\n * @property {string} [profileSummary] - Profile Summary.\n * @property {string} [profileSummaryStatus] - Profile Summary Status.\n * @property {boolean} [profileSummaryError] - Profile Summary Error.\n * @property {boolean} [profileSummaryLoading] - Profile Summary Loading.\n * @since 2.9.0\n */","name":"ProfileHighlightsProps","type":null,"properties":[{"name":"profileHighlightsTitle","type":{"names":["string"]},"description":"Profile Highlights Title
","optional":true,"defaultvalue":""},{"name":"profileSummary","type":{"names":["string"]},"description":"Profile Summary.
","optional":true,"defaultvalue":""},{"name":"profileSummaryStatus","type":{"names":["string"]},"description":"Profile Summary Status.
","optional":true,"defaultvalue":""},{"name":"profileSummaryError","type":{"names":["boolean"]},"description":"Profile Summary Error.
","optional":true,"defaultvalue":""},{"name":"profileSummaryLoading","type":{"names":["boolean"]},"description":"Profile Summary Loading.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of ProfileLinkButton.\n * @typedef {ProfileLinkButton.ProfileLinkButtonProps} ProfileLinkButton.ProfileLinkButtonChildrenProps\n */","name":"ProfileLinkButtonChildrenProps","type":{"names":["ProfileLinkButton.ProfileLinkButtonProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of SearchListItem.\n * @typedef SearchListItem.SearchListItemProps\n * @property {Profile} [profile] - Profile object with customer data.\n * @property {React.MouseEventHandlerProfile object with customer data.
","optional":true,"defaultvalue":""},{"name":"onClick","type":{"names":["React.MouseEventHandlerAction to open the profile view.
","optional":true,"defaultvalue":""},{"name":"titleKey","type":{"names":["\"keyof Profile\""]},"description":"Title of the profile listed for the given search, should be a key of the Profile object.
","optional":true,"defaultvalue":"given_name"},{"name":"avatarImageKey","type":{"names":["\"keyof Profile\""]},"description":"URL of display picture of the profile listed for the given search, should be a key of Profile Object.
","optional":true,"defaultvalue":"profile_image_url"}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of SearchListItem.\n * @typedef {SearchListItem.SearchListItemProps} SearchListItem.SearchListItemChildrenProps\n */","name":"SearchListItemChildrenProps","type":{"names":["SearchListItem.SearchListItemProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of SearchView.\n * @typedef SearchView.SearchViewProps\n * @property {React.MouseEventHandlerAction to dismiss the search view.
","optional":true,"defaultvalue":""},{"name":"uniqueName","type":{"names":["string"]},"description":"Unique name of profile connector instance associated with segment.
","optional":true,"defaultvalue":"flex_connector"},{"name":"isReplacingProfile","type":{"names":["string"]},"description":"show if user is searching to replace a profile
","optional":true,"defaultvalue":"false"}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of SearchView.\n * @typedef {SearchView.SearchViewProps} SearchView.SearchViewChildrenProps\n */","name":"SearchViewChildrenProps","type":{"names":["SearchView.SearchViewProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Either segmentId or taskSid must be defined, or an error is thrown.\n *\n * @typedef {InsightsPlayerPlayActionPayload} InsightsPlayerPlayActionPayload\n * @memberof Actions\n * @property {string} [segmentId] Segment you want to play. Required if taskSid is not provided.\n * @property {string} [taskSid] Task you want to play. Required if segmentId is not provided.\n */","name":"InsightsPlayerPlayActionPayload","type":{"names":["InsightsPlayerPlayActionPayload"]},"properties":[{"name":"segmentId","type":{"names":["string"]},"description":"Segment you want to play. Required if taskSid is not provided.
","optional":true,"defaultvalue":""},{"name":"taskSid","type":{"names":["string"]},"description":"Task you want to play. Required if segmentId is not provided.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of LiveCommsBar.\n *\n * @typedef {object} LiveCommsBar.LiveCommsBarChildrenProps\n * @property {ITask} [monitoredTask] - Monitored task.\n * @property {ArrayMonitored task.
","optional":true,"defaultvalue":""},{"name":"monitoredWorkers","type":{"names":["ArrayArray of monitored workers.
","optional":true,"defaultvalue":""},{"name":"monitoringState","type":{"names":["CallMonitoringStatus"]},"description":"Call monitoring status.
","optional":true,"defaultvalue":""},{"name":"currentCallTask","type":{"names":["ITask"]},"description":"Current call task.
","optional":true,"defaultvalue":""},{"name":"currentCallOnHold","type":{"names":["boolean"]},"description":"Whether the current call is on hold or not.
","optional":true,"defaultvalue":""},{"name":"currentCallMuted","type":{"names":["boolean"]},"description":"Whether the current call is muted or not.
","optional":true,"defaultvalue":""},{"name":"selectedView","type":{"names":["string"]},"description":"Represents the current active view.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of LiveCommsBarItem.\n *\n * @typedef {LiveCommsBarItemProps} LiveCommsBarItem.LiveCommsBarItemChildrenProps\n */","name":"LiveCommsBarItemChildrenProps","type":{"names":["LiveCommsBarItemProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of LiveCommsBarItem.\n *\n * @typedef LiveCommsBarItem.LiveCommsBarItemProps\n * @property {DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of LiveCommsBarItemActions.\n *\n * @typedef LiveCommsBarItemActions.LiveCommsBarItemActionsProps\n * @property {ArrayActions
","optional":null,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of LiveCommsBarItemActions.\n *\n * @typedef {LiveCommsBarItemActions.LiveCommsBarItemActionsProps} LiveCommsBarItemActions.LiveCommsBarItemActionsChildrenProps\n */","name":"LiveCommsBarItemActionsChildrenProps","type":{"names":["LiveCommsBarItemActions.LiveCommsBarItemActionsProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of MainContainer.\n * @typedef MainContainer.MainContainerProps\n * @property {boolean} [keepSideNavOpen=false] - Whether the SideNav preview panel should be always visible. Default is false, which makes the preview show only after the whole app is wide enough.\n * @property {boolean} [showNotificationBar=true] - Whether notifications will be shown on the NotificationBar or not. If set to false, no notifications in NotificationBar will be shown.\n * @property {boolean} [showLiveCommsBar=true] - Whether to display an incoming call bar for views different from Agent Desktop or not.\n * @property {DynamicContentStore.DynamicComponentChildrenWhether the SideNav preview panel should be always visible. Default is false, which makes the preview show only after the whole app is wide enough.
","optional":true,"defaultvalue":"false"},{"name":"showNotificationBar","type":{"names":["boolean"]},"description":"Whether notifications will be shown on the NotificationBar or not. If set to false, no notifications in NotificationBar will be shown.
","optional":true,"defaultvalue":"true"},{"name":"showLiveCommsBar","type":{"names":["boolean"]},"description":"Whether to display an incoming call bar for views different from Agent Desktop or not.
","optional":true,"defaultvalue":"true"},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of MainContainer.\n * @typedef {MainContainerProps} MainContainer.MainContainerChildrenProps\n * @property {string} [activeView] - Represents the current active view.\n * @property {boolean} [showOutboundDialer] - If outbound dialer should be shown\n */","name":"MainContainerChildrenProps","type":{"names":["MainContainerProps"]},"properties":[{"name":"activeView","type":{"names":["string"]},"description":"Represents the current active view.
","optional":true,"defaultvalue":""},{"name":"showOutboundDialer","type":{"names":["boolean"]},"description":"If outbound dialer should be shown
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of MainHeader.\n * @typedef MainHeader.MainHeaderProps\n * @property {string} [logoUrl=undefined] - Logo URL shown in the main header.\n * @property {string} [logoAltText=undefined] - Logo alt text shown in the main header.\n * @property {ComponentBadgePropsLogo URL shown in the main header.
","optional":true,"defaultvalue":""},{"name":"logoAltText","type":{"names":["string"]},"description":"Logo alt text shown in the main header.
","optional":true,"defaultvalue":""},{"name":"Badge","type":{"names":["ComponentBadgePropsSet of properties for internal Badge element.
","optional":true,"defaultvalue":""},{"name":"Badge.children","type":{"names":["number","function"]},"description":"Children of internal Badge component.
","optional":true,"defaultvalue":""},{"name":"isSideNavOpen","type":{"names":["boolean"]},"description":"Whether the Sidebar is open or not.
","optional":true,"defaultvalue":""},{"name":"isOutboundDialerOpen","type":{"names":["boolean"]},"description":"Whether the Outbound dialer is open or not.
","optional":true,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of MainHeader.\n * @typedef {MainHeaderProps} MainHeader.MainHeaderChildrenProps\n * @property {boolean} [incomingTasks] - Deprecated - Whether there are any incoming tasks or not.\n * @property {boolean} [isLiveVoiceCall] - Whether there is a live voice call.\n * @property {boolean} [isLiveVoiceConnection] - Deprecated: use isLiveVoiceCall.\n * @property {Badge.BadgeProps} [Badge] - Set of properties for internal Badge element.\n */","name":"MainHeaderChildrenProps","type":{"names":["MainHeaderProps"]},"properties":[{"name":"incomingTasks","type":{"names":["boolean"]},"description":"Deprecated - Whether there are any incoming tasks or not.
","optional":true,"defaultvalue":""},{"name":"isLiveVoiceCall","type":{"names":["boolean"]},"description":"Whether there is a live voice call.
","optional":true,"defaultvalue":""},{"name":"isLiveVoiceConnection","type":{"names":["boolean"]},"description":"Deprecated: use isLiveVoiceCall.
","optional":true,"defaultvalue":""},{"name":"Badge","type":{"names":["Badge.BadgeProps"]},"description":"Set of properties for internal Badge element.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef Theme.ProfileCardThemeProps\n * @property {CSSProps} AvatarContainer - Styles for the container for the avatar\n */","name":"ProfileCardThemeProps","type":null,"properties":[{"name":"AvatarContainer","type":{"names":["CSSProps"]},"description":"Styles for the container for the avatar
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of UserControls.\n *\n * @typedef {object} UserControls.UserControlsChildrenProps\n * @property {WorkerState} [worker] - Worker state.\n */","name":"UserControlsChildrenProps","type":{"names":["object"]},"properties":[{"name":"worker","type":{"names":["WorkerState"]},"description":"Worker state.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of OutboundDialerPanel theme.\n *\n * @typedef Theme.OutboundDialerPanelThemeProps\n * @property {CSSProps} Container - Styles container in OutboundDialerPanel.\n * @property {CSSProps} Container.disabled - Styles disabled state.\n * @property {CSSProps} Header - Styles header in OutboundDialerPanel.\n * @property {CSSProps} HeaderButton - Styles header button in OutboundDialerPanel.\n */","name":"OutboundDialerPanelThemeProps","type":null,"properties":[{"name":"Container","type":{"names":["CSSProps"]},"description":"Styles container in OutboundDialerPanel.
","optional":null,"defaultvalue":""},{"name":"Container.disabled","type":{"names":["CSSProps"]},"description":"Styles disabled state.
","optional":null,"defaultvalue":""},{"name":"Header","type":{"names":["CSSProps"]},"description":"Styles header in OutboundDialerPanel.
","optional":null,"defaultvalue":""},{"name":"HeaderButton","type":{"names":["CSSProps"]},"description":"Styles header button in OutboundDialerPanel.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of OutboundDialerPanel.\n *\n * @typedef OutboundDialerPanel.OutboundDialerPanelProps\n */","name":"OutboundDialerPanelProps","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of OutboundDialerPanelChildren.\n *\n * @typedef OutboundDialerPanel.OutboundDialerPanelChildrenProps\n * @property {WorkerState} [worker] - Worker state based on Worker SDK.\n * @property {boolean} [hasIncomingCallReservation] - Whether user has incoming call reservation.\n */","name":"OutboundDialerPanelChildrenProps","type":null,"properties":[{"name":"worker","type":{"names":["WorkerState"]},"description":"Worker state based on Worker SDK.
","optional":true,"defaultvalue":""},{"name":"hasIncomingCallReservation","type":{"names":["boolean"]},"description":"Whether user has incoming call reservation.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of TimelineView.\n * @typedef {TimelineView.TimelineViewProps} TimelineView.TimelineViewChildrenProps\n */","name":"TimelineViewChildrenProps","type":{"names":["TimelineView.TimelineViewProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of RootContainer.\n *\n * @typedef {object} RootContainerChildrenProps\n * @property {string} [identity] - Identity of the current agent.\n * @property {string} [currentLoginState] - State of the login [UNKNOWN, LOGGING_IN, LOGGED_IN, LOGGED_OUT, ERROR].\n * @property {Config} config - Default configuration of flex.\n * @property {SingleSessionGuardState} [singleSessionGuard] - State of the single session guard.\n * @extends {ThemeProps}\n * @memberof ThemeProvider\n */","name":"RootContainerChildrenProps","type":{"names":["object"]},"properties":[{"name":"identity","type":{"names":["string"]},"description":"Identity of the current agent.
","optional":true,"defaultvalue":""},{"name":"currentLoginState","type":{"names":["string"]},"description":"State of the login [UNKNOWN, LOGGING_IN, LOGGED_IN, LOGGED_OUT, ERROR].
","optional":true,"defaultvalue":""},{"name":"config","type":{"names":["Config"]},"description":"Default configuration of flex.
","optional":null,"defaultvalue":""},{"name":"singleSessionGuard","type":{"names":["SingleSessionGuardState"]},"description":"State of the single session guard.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of SideNav.\n *\n * @typedef SideNav.SideNavProps\n * @property {boolean} [reserveSpace] - Whether the SideNav is shown in compact mode.\n * @property {DynamicComponentChildrenWhether the SideNav is shown in compact mode.
","optional":true,"defaultvalue":""},{"name":"children","type":{"names":["DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of SideNav.\n *\n * @typedef {SideNavProps} SideNav.SideNavChildrenProps\n * @property {boolean} [incomingTasks] - Whether there are incoming tasks or not. If there are, the SideNav shows an indicator in the agent-desktop icon.\n * @property {boolean} [isOpen] - Whether the Sidebar is open or not.\n * @property {string} [activeView] - Represents the current active view.\n */","name":"SideNavChildrenProps","type":{"names":["SideNavProps"]},"properties":[{"name":"incomingTasks","type":{"names":["boolean"]},"description":"Whether there are incoming tasks or not. If there are, the SideNav shows an indicator in the agent-desktop icon.
","optional":true,"defaultvalue":""},{"name":"isOpen","type":{"names":["boolean"]},"description":"Whether the Sidebar is open or not.
","optional":true,"defaultvalue":""},{"name":"activeView","type":{"names":["string"]},"description":"Represents the current active view.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of TaskList.\n *\n * @typedef TaskList.TaskListProps\n * @property {string} [selectedTaskSid] - Sid of the selected task.\n * @property {Function} [compareFunction=defaultTaskOrderCompare] - Callback to control how tasks should be sorted in task list. Negative number means task a should be above task b, positive number that a should be below b. 0 indicates equal priority.\n * @property {AppConfig.TaskFilterCallback} [staticFilter] - Callback to test if a task belongs to the static area (upper area before filters) in the task list.\n * @property {ArraySid of the selected task.
","optional":true,"defaultvalue":""},{"name":"compareFunction","type":{"names":["function"]},"description":"Callback to control how tasks should be sorted in task list. Negative number means task a should be above task b, positive number that a should be below b. 0 indicates equal priority.
","optional":true,"defaultvalue":"defaultTaskOrderCompare"},{"name":"staticFilter","type":{"names":["AppConfig.TaskFilterCallback"]},"description":"Callback to test if a task belongs to the static area (upper area before filters) in the task list.
","optional":true,"defaultvalue":""},{"name":"filters","type":{"names":["ArrayFilter tasks displayed in the list.
","optional":true,"defaultvalue":""},{"name":"onFilterChange","type":{"names":["function"]},"description":"Callback when a filter changes.
","optional":true,"defaultvalue":""},{"name":"onTaskSelected","type":{"names":["function"]},"description":"Callback when a task is selected from the list.
","optional":true,"defaultvalue":""},{"name":"tasks","type":{"names":["MapTasks.
","optional":true,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of TaskListItem.\n * @typedef {TaskListItemProps | TaskContextProps} TaskListItem.TaskListItemChildrenProps\n * @property { { children: number, variant: BadgeVariants } } [Badge] Set of properties for internal Badge element customisable by TaskChannel\n */","name":"TaskListItemChildrenProps","type":{"names":["TaskListItemProps","TaskContextProps"]},"properties":[{"name":"Badge","type":{"names":["Object"]},"description":"Set of properties for internal Badge element customisable by TaskChannel
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of TaskListContainer.\n *\n * @typedef {TaskListContainer.TaskListContainerProps} TaskListContainer.TaskListContainerChildrenProps\n */","name":"TaskListContainerChildrenProps","type":{"names":["TaskListContainer.TaskListContainerProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of TaskListContainer.\n *\n * @typedef TaskListContainer.TaskListContainerProps\n * @property {MapTasks to display.
","optional":true,"defaultvalue":""},{"name":"selectedTaskSid","type":{"names":["string"]},"description":"Sid of the selected task.
","optional":true,"defaultvalue":""},{"name":"taskFilters","type":{"names":["ArrayFilter tasks displayed in the list.
","optional":true,"defaultvalue":"TaskListContainer.defaultTaskFilters"},{"name":"staticTaskFilter","type":{"names":["TaskFilterCallback"]},"description":"Callback to test if a task belongs to the static area (upper area before filters) in the task list.
","optional":true,"defaultvalue":"TaskListContainer.defaultStaticTaskFilter"},{"name":"onTaskSelected","type":{"names":["function"]},"description":"Callback called when a task is selected
","optional":true,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of ViewCollection.\n *\n * @typedef ViewCollection.ViewCollectionProps\n * @property {string} [defaultLocation=/agent-desktop] - Default URL location of view\n * @property {DynamicContentStore.DynamicComponentChildrenDefault URL location of view
","optional":true,"defaultvalue":"/agent-desktop"},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of ViewCollection.\n *\n * @typedef {ViewCollection.ViewCollectionProps} ViewCollection.ViewCollectionChildrenProps\n * @property {string} defaultLocation - Router default location.\n */","name":"ViewCollectionChildrenProps","type":{"names":["ViewCollection.ViewCollectionProps"]},"properties":[{"name":"defaultLocation","type":{"names":["string"]},"description":"Router default location.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Additional properties of ViewCollection.\n *\n * @typedef ViewCollection.ViewAdditionalProps\n * @property {boolean} [isViewActive] - Whether the view is active or not\n * @property {RouteComponentProps} [route] - View route\n */","name":"ViewAdditionalProps","type":null,"properties":[{"name":"isViewActive","type":{"names":["boolean"]},"description":"Whether the view is active or not
","optional":true,"defaultvalue":""},{"name":"route","type":{"names":["RouteComponentProps"]},"description":"View route
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of WorkerDirectory\n *\n * @typedef {TaskContextProps} WorkerDirectoryTabs.WorkerDirectoryTabsProps\n * @property {boolean} isWarmTransferEnabled - Whether warm transfer is enabled.\n * @property {string} [hiddenWorkerFilter] - Extra query filter applied to the query of workers in addition to typed search.\n * @property {string} [hiddenQueueFilter] - DEPRECATED: use queueFilter instead. Extra query filter applied to the query of queues in addition to typed search.\n * @property {Function} [queueFilter] - Predicate function applied for custom queue filtering in addition to typed search.\n * @property {Theme} theme Theme\n */","name":"WorkerDirectoryTabsProps","type":{"names":["TaskContextProps"]},"properties":[{"name":"isWarmTransferEnabled","type":{"names":["boolean"]},"description":"Whether warm transfer is enabled.
","optional":null,"defaultvalue":""},{"name":"hiddenWorkerFilter","type":{"names":["string"]},"description":"Extra query filter applied to the query of workers in addition to typed search.
","optional":true,"defaultvalue":""},{"name":"hiddenQueueFilter","type":{"names":["string"]},"description":"DEPRECATED: use queueFilter instead. Extra query filter applied to the query of queues in addition to typed search.
","optional":true,"defaultvalue":""},{"name":"queueFilter","type":{"names":["function"]},"description":"Predicate function applied for custom queue filtering in addition to typed search.
","optional":true,"defaultvalue":""},{"name":"theme","type":{"names":["Theme"]},"description":"Theme
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef WorkerDirectory.WorkerDirectoryProps\n * @property {DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of WorkerDirectory\n *\n * @typedef {WorkerDirectory.WorkerDirectoryProps} WorkerDirectory.WorkerDirectoryChildrenProps\n * @property {boolean} [isOpen] - Whether the worker directory is opened or not.\n * @property {ITask} [task] - Task to be transferred\n * @property {boolean} [isWarmTransferEnabled] - Whether warm transfer is enabled.\n */","name":"WorkerDirectoryChildrenProps","type":{"names":["WorkerDirectory.WorkerDirectoryProps"]},"properties":[{"name":"isOpen","type":{"names":["boolean"]},"description":"Whether the worker directory is opened or not.
","optional":true,"defaultvalue":""},{"name":"task","type":{"names":["ITask"]},"description":"Task to be transferred
","optional":true,"defaultvalue":""},{"name":"isWarmTransferEnabled","type":{"names":["boolean"]},"description":"Whether warm transfer is enabled.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in call canvas.\n *\n * @typedef {TaskContextProps} CallCanvas.CallCanvasChildrenProps\n * @property {DialpadState} dialpadState - Represents the state of the dialpad.\n * @property {boolean} [compact] - if dialpad should be compact.\n */","name":"CallCanvasChildrenProps","type":{"names":["TaskContextProps"]},"properties":[{"name":"dialpadState","type":{"names":["DialpadState"]},"description":"Represents the state of the dialpad.
","optional":null,"defaultvalue":""},{"name":"compact","type":{"names":["boolean"]},"description":"if dialpad should be compact.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Call canvas action.\n * @typedef {TaskCanvasChildrenProps} CallCanvasActionsProps\n */","name":"CallCanvasActionsProps","type":{"names":["TaskCanvasChildrenProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in call canvas action.\n * @typedef {TaskContextProps} CallCanvasActions.CallCanvasActionsChildrenProps\n * @property {boolean} isOpen - isOpen.\n * @property {Theme.CallCanvasThemeProps} [theme.CallCanvas] - Theme\n */","name":"CallCanvasActionsChildrenProps","type":{"names":["TaskContextProps"]},"properties":[{"name":"isOpen","type":{"names":["boolean"]},"description":"isOpen.
","optional":null,"defaultvalue":""},{"name":"theme.CallCanvas","type":{"names":["Theme.CallCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of call canvas dialpad.\n *\n * @typedef {TaskContextProps} CallCanvasDialpad.CallCanvasDialpadProps\n * @property {DialpadState} dialpadState - Represents the state of the dialpad.\n * @property {boolean} [compact] - If dialpad should be compact.\n */","name":"CallCanvasDialpadProps","type":{"names":["TaskContextProps"]},"properties":[{"name":"dialpadState","type":{"names":["DialpadState"]},"description":"Represents the state of the dialpad.
","optional":null,"defaultvalue":""},{"name":"compact","type":{"names":["boolean"]},"description":"If dialpad should be compact.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in call canvas dialpad.\n *\n * @typedef {CallCanvasDialpadProps} CallCanvasDialpad.CallCanvasDialpadChildrenProps\n */","name":"CallCanvasDialpadChildrenProps","type":{"names":["CallCanvasDialpadProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of outbound call canvas theme.\n *\n * @typedef Theme.ConnectingOutboundCallCanvasThemeProps\n * @property {CSSProps} CancelCallButton - Styles cancel call button.\n */","name":"ConnectingOutboundCallCanvasThemeProps","type":null,"properties":[{"name":"CancelCallButton","type":{"names":["CSSProps"]},"description":"Styles cancel call button.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of outbound call canvas.\n *\n * @typedef {TaskContextProps} ConnectingOutboundCallCanvas.ConnectingOutboundCallCanvasProps\n * @property {string} [firstLine] - First line shown in the outbound call canvas.\n * @property {string} [secondLine] - Second line shown in the outbound call canvas.\n * @property {string} [titleLine] - Title string shown in the outbound call canvas.\n */","name":"ConnectingOutboundCallCanvasProps","type":{"names":["TaskContextProps"]},"properties":[{"name":"firstLine","type":{"names":["string"]},"description":"First line shown in the outbound call canvas.
","optional":true,"defaultvalue":""},{"name":"secondLine","type":{"names":["string"]},"description":"Second line shown in the outbound call canvas.
","optional":true,"defaultvalue":""},{"name":"titleLine","type":{"names":["string"]},"description":"Title string shown in the outbound call canvas.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in outbound call canvas.\n *\n * @typedef {ConnectingOutboundCallCanvasProps} ConnectingOutboundCallCanvas.ConnectingOutboundCallCanvasChildrenProps\n * @property {ConnectingOutboundCallCanvasThemeProps} [theme.ConnectingOutboundCallCanvas] - Theme\n */","name":"ConnectingOutboundCallCanvasChildrenProps","type":{"names":["ConnectingOutboundCallCanvasProps"]},"properties":[{"name":"theme.ConnectingOutboundCallCanvas","type":{"names":["ConnectingOutboundCallCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Outbound call canvas action.\n *\n * @typedef {TaskContextSource.TaskContextProps} ConnectingOutboundCallCanvasActionsProps\n * @memberof ConnectingOutboundCallCanvasActions\n */","name":"ConnectingOutboundCallCanvasActionsProps","type":{"names":["TaskContextSource.TaskContextProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in Outbound call canvas action.\n *\n * @typedef {ConnectingOutboundCallCanvasActions.ConnectingOutboundCallCanvasActionsProps} ConnectingOutboundCallCanvasActionsChildrenProps\n * @property {Theme.ConnectingOutboundCallCanvasThemeProps} [theme.ConnectingOutboundCallCanvas] - Theme\n * @memberof ConnectingOutboundCallCanvasActions\n */","name":"ConnectingOutboundCallCanvasActionsChildrenProps","type":{"names":["ConnectingOutboundCallCanvasActions.ConnectingOutboundCallCanvasActionsProps"]},"properties":[{"name":"theme.ConnectingOutboundCallCanvas","type":{"names":["Theme.ConnectingOutboundCallCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of incoming task canvas theme.\n *\n * @typedef Theme.IncomingTaskCanvasThemeProps\n * @property {CSSProps} AcceptTaskButton - Styles accept task button.\n * @property {CSSProps} RejectTaskButton - Styles reject task button.\n */","name":"IncomingTaskCanvasThemeProps","type":null,"properties":[{"name":"AcceptTaskButton","type":{"names":["CSSProps"]},"description":"Styles accept task button.
","optional":null,"defaultvalue":""},{"name":"RejectTaskButton","type":{"names":["CSSProps"]},"description":"Styles reject task button.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of incoming task canvas.\n *\n * @typedef {TaskContextProps} IncomingTaskCanvas.IncomingTaskCanvasProps\n * @property {string} [firstLine] - First line shown in the incoming task canvas.\n * @property {string} [secondLine] - Second line shown in the incoming task canvas.\n * @property {string} [titleLine] - Title string shown in the incoming task canvas.\n */","name":"IncomingTaskCanvasProps","type":{"names":["TaskContextProps"]},"properties":[{"name":"firstLine","type":{"names":["string"]},"description":"First line shown in the incoming task canvas.
","optional":true,"defaultvalue":""},{"name":"secondLine","type":{"names":["string"]},"description":"Second line shown in the incoming task canvas.
","optional":true,"defaultvalue":""},{"name":"titleLine","type":{"names":["string"]},"description":"Title string shown in the incoming task canvas.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in incoming task canvas.\n *\n * @typedef {IncomingTaskCanvasProps} IncomingTaskCanvas.IncomingTaskCanvasChildrenProps\n * @property {IncomingTaskCanvasThemeProps} [theme.IncomingTaskCanvas] - Theme\n */","name":"IncomingTaskCanvasChildrenProps","type":{"names":["IncomingTaskCanvasProps"]},"properties":[{"name":"theme.IncomingTaskCanvas","type":{"names":["IncomingTaskCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Incoming task canvas action.\n *\n * @typedef {TaskContextProps} IncomingTaskCanvasActionsProps\n * @memberof IncomingTaskCanvasActions\n */","name":"IncomingTaskCanvasActionsProps","type":{"names":["TaskContextProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in incoming task canvas action.\n *\n * @typedef {IncomingTaskCanvasActions.IncomingTaskCanvasActionsProps} IncomingTaskCanvasActionsChildrenProps\n * @property {Theme.IncomingTaskCanvasThemeProps} [theme.IncomingTaskCanvas] - Theme\n * @memberof IncomingTaskCanvasActions\n */","name":"IncomingTaskCanvasActionsChildrenProps","type":{"names":["IncomingTaskCanvasActions.IncomingTaskCanvasActionsProps"]},"properties":[{"name":"theme.IncomingTaskCanvas","type":{"names":["Theme.IncomingTaskCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of no task canvas theme.\n *\n * @typedef Theme.NoTasksCanvasThemeProps\n * @property {CSSProps} Container - Styles container.\n * @property {CSSProps} Hint - Styles hint text container.\n */","name":"NoTasksCanvasThemeProps","type":null,"properties":[{"name":"Container","type":{"names":["CSSProps"]},"description":"Styles container.
","optional":null,"defaultvalue":""},{"name":"Hint","type":{"names":["CSSProps"]},"description":"Styles hint text container.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in no task Canvas.\n *\n * @typedef NoTasksCanvas.NoTasksCanvasChildrenProps\n * @property {NoTasksCanvasThemeProps} [theme.NoTasksCanvas] - Theme\n * @property {WorkerState} [worker] - current worker.\n */","name":"NoTasksCanvasChildrenProps","type":null,"properties":[{"name":"theme.NoTasksCanvas","type":{"names":["NoTasksCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""},{"name":"worker","type":{"names":["WorkerState"]},"description":"current worker.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of participant canvas.\n *\n * @typedef ParticipantCanvas.ParticipantCanvasProps\n * @property {ConferenceParticipant} participant - Represents a single participant of a conference.\n * @property {number} participantWidth - Represents width of the participant container.\n * @property {boolean} [hideActions] - Identifies if the participant actions are hidden.\n * @property {boolean} [listMode] - Identifies if the participant are rendered in list mode.\n * @property {boolean} [isCCAICall] - Identifies if the active call is a CCAI call.\n */","name":"ParticipantCanvasProps","type":null,"properties":[{"name":"participant","type":{"names":["ConferenceParticipant"]},"description":"Represents a single participant of a conference.
","optional":null,"defaultvalue":""},{"name":"participantWidth","type":{"names":["number"]},"description":"Represents width of the participant container.
","optional":null,"defaultvalue":""},{"name":"hideActions","type":{"names":["boolean"]},"description":"Identifies if the participant actions are hidden.
","optional":true,"defaultvalue":""},{"name":"listMode","type":{"names":["boolean"]},"description":"Identifies if the participant are rendered in list mode.
","optional":true,"defaultvalue":""},{"name":"isCCAICall","type":{"names":["boolean"]},"description":"Identifies if the active call is a CCAI call.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in participant canvas.\n *\n * @typedef {ParticipantCanvasProps} ParticipantCanvas.ParticipantCanvasChildrenProps\n * @property {ParticipantCanvasThemeProps} [theme.ParticipantsCanvas.ParticipantCanvas] - Theme\n */","name":"ParticipantCanvasChildrenProps","type":{"names":["ParticipantCanvasProps"]},"properties":[{"name":"theme.ParticipantsCanvas.ParticipantCanvas","type":{"names":["ParticipantCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of participants canvas theme.\n *\n * @typedef Theme.ParticipantsCanvasNotificationThemeProps\n * @property {CSSProps} Container - Styles participants container.\n */","name":"ParticipantsCanvasNotificationThemeProps","type":null,"properties":[{"name":"Container","type":{"names":["CSSProps"]},"description":"Styles participants container.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef Theme.ParticipantsCanvasThemeProps\n * @property {ParticipantCanvasThemeProps} ParticipantCanvas - Styles for a single participant.\n * @property {ParticipantsCanvasNotificationThemeProps} Notification - Styles for notification in participants canvas.\n * @property {CSSProps} Disclosure - Styles for Disclosure Paste Component in Google CCAI flow.\n * @property {CSSProps} DisclosureContent - Styles for Disclosure Content Paste Component in Google CCAI flow.\n * @property {CSSProps} DisclosureHeading - Styles for Disclosure Header Paste Component in Google CCAI flow.\n */","name":"ParticipantsCanvasThemeProps","type":null,"properties":[{"name":"ParticipantCanvas","type":{"names":["ParticipantCanvasThemeProps"]},"description":"Styles for a single participant.
","optional":null,"defaultvalue":""},{"name":"Notification","type":{"names":["ParticipantsCanvasNotificationThemeProps"]},"description":"Styles for notification in participants canvas.
","optional":null,"defaultvalue":""},{"name":"Disclosure","type":{"names":["CSSProps"]},"description":"Styles for Disclosure Paste Component in Google CCAI flow.
","optional":null,"defaultvalue":""},{"name":"DisclosureContent","type":{"names":["CSSProps"]},"description":"Styles for Disclosure Content Paste Component in Google CCAI flow.
","optional":null,"defaultvalue":""},{"name":"DisclosureHeading","type":{"names":["CSSProps"]},"description":"Styles for Disclosure Header Paste Component in Google CCAI flow.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in participants canvas.\n *\n * @typedef ParticipantsCanvas.ParticipantsCanvasProps\n * @property {boolean} [includeMyself] - Identifies if current logged in worker is included.\n * @property {boolean} [hideActions] - Identifies if the participant actions are hidden\n * @property {boolean} [isCCAICall] - Identifies if the call is a Google CCAI call or not.\n */","name":"ParticipantsCanvasProps","type":null,"properties":[{"name":"includeMyself","type":{"names":["boolean"]},"description":"Identifies if current logged in worker is included.
","optional":true,"defaultvalue":""},{"name":"hideActions","type":{"names":["boolean"]},"description":"Identifies if the participant actions are hidden
","optional":true,"defaultvalue":""},{"name":"isCCAICall","type":{"names":["boolean"]},"description":"Identifies if the call is a Google CCAI call or not.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in participants canvas.\n *\n * @typedef {ParticipantsCanvasProps} ParticipantsCanvas.ParticipantsCanvasChildrenProps\n * @property {Arrayexternal call canvas participants.
","optional":null,"defaultvalue":""},{"name":"participantsByCallSid","type":{"names":["Recorddictionary of participants with participantSid as the key.
","optional":null,"defaultvalue":""},{"name":"theme.ParticipantsCanvas","type":{"names":["ParticipantsCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of task canvas theme.\n *\n * @typedef Theme.TaskCanvasThemeProps\n * @property {CSSProps} Container - Styles task canvas container.\n */","name":"TaskCanvasThemeProps","type":null,"properties":[{"name":"Container","type":{"names":["CSSProps"]},"description":"Styles task canvas container.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in task canvas.\n *\n * @typedef {TaskContextProps} TaskCanvas.TaskCanvasChildrenProps\n * @property {TaskCanvasThemeProps} [theme.TaskCanvas] - Theme\n */","name":"TaskCanvasChildrenProps","type":{"names":["TaskContextProps"]},"properties":[{"name":"theme.TaskCanvas","type":{"names":["TaskCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of task canvas header theme.\n *\n * @typedef Theme.TaskCanvasHeaderThemeProps\n * @property {CSSProps} Container - Styles task canvas header container.\n * @property {ButtonThemeProps} EndTaskButton - Styles end task button.\n * @property {ButtonThemeProps} WrapupTaskButton - Styles wrap up task button.\n */","name":"TaskCanvasHeaderThemeProps","type":null,"properties":[{"name":"Container","type":{"names":["CSSProps"]},"description":"Styles task canvas header container.
","optional":null,"defaultvalue":""},{"name":"EndTaskButton","type":{"names":["ButtonThemeProps"]},"description":"Styles end task button.
","optional":null,"defaultvalue":""},{"name":"WrapupTaskButton","type":{"names":["ButtonThemeProps"]},"description":"Styles wrap up task button.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Task Canvas Header.\n *\n * @typedef {PartialRepresents the actions component.
","optional":true,"defaultvalue":""},{"name":"icon","type":{"names":["string","React.ReactNode"]},"description":"Represents the icon.
","optional":true,"defaultvalue":""},{"name":"titleTemplateCode","type":{"names":["string"]},"description":"Represents title template code.
","optional":true,"defaultvalue":""},{"name":"titleTemplateContext","type":{"names":["any"]},"description":"Represents context for title templete.
","optional":true,"defaultvalue":""},{"name":"secondLineTemplateCode","type":{"names":["string"]},"description":"Represents second line template code.
","optional":true,"defaultvalue":""},{"name":"secondLineTemplateContext","type":{"names":["any"]},"description":"Represents context for second line templete.
","optional":true,"defaultvalue":""},{"name":"titleTemplate","type":{"names":["string"]},"description":"Title template.
","optional":null,"defaultvalue":""},{"name":"secondLineTemplate","type":{"names":["string"]},"description":"Second line template.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in task canvas header.\n *\n * @typedef {TaskCanvasHeaderProps} TaskCanvasHeader.TaskCanvasHeaderChildrenProps\n * @property {TaskCanvasHeaderThemeProps} [theme.TaskCanvasHeader] - Theme\n */","name":"TaskCanvasHeaderChildrenProps","type":{"names":["TaskCanvasHeaderProps"]},"properties":[{"name":"theme.TaskCanvasHeader","type":{"names":["TaskCanvasHeaderThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in task canvas tabs.\n * @typedef {TaskCanvasChildrenProps} TaskCanvasTabs.TaskCanvasTabsChildrenProps\n * @property {boolean} [hasMarkdownSupport] - Whether markdown feature is enabled or not\n * @property {string} [selectedTabName] - Selected tab name.\n */","name":"TaskCanvasTabsChildrenProps","type":{"names":["TaskCanvasChildrenProps"]},"properties":[{"name":"hasMarkdownSupport","type":{"names":["boolean"]},"description":"Whether markdown feature is enabled or not
","optional":true,"defaultvalue":""},{"name":"selectedTabName","type":{"names":["string"]},"description":"Selected tab name.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of task canvas tabs component.\n * @typedef TaskCanvasTabs.TaskCanvasTabsProps\n */","name":"TaskCanvasTabsProps","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of taks details panel theme.\n * @typedef Theme.TaskDetailsPanelThemeProps\n * @property {CSSProps} Container - Styles task details panel container.\n * @property {CSSProps} IconContainer - Styles icon container in task details panel.\n * @property {CSSProps} SecondLine - Styles second line container in task details panel.\n */","name":"TaskDetailsPanelThemeProps","type":null,"properties":[{"name":"Container","type":{"names":["CSSProps"]},"description":"Styles task details panel container.
","optional":null,"defaultvalue":""},{"name":"IconContainer","type":{"names":["CSSProps"]},"description":"Styles icon container in task details panel.
","optional":null,"defaultvalue":""},{"name":"SecondLine","type":{"names":["CSSProps"]},"description":"Styles second line container in task details panel.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Task Details Panel.\n * @typedef {TaskCanvasChildrenProps} TaskDetailsPanel.TaskDetailsPanelProps\n * @property {TaskDetailsPanelThemeProps} [theme.TaskDetailsPanel] - Theme\n * @property {DynamicContentStoreTheme
","optional":true,"defaultvalue":""},{"name":"content","type":{"names":["DynamicContentStoreRepresents dynamic content store.
","optional":null,"defaultvalue":""},{"name":"compact","type":{"names":["boolean"]},"description":"Whether a component should be rendered in the compact mode
","optional":true,"defaultvalue":"false"},{"name":"titleLine","type":{"names":["string"]},"description":"Title string shown in the task details panel.
","optional":true,"defaultvalue":""},{"name":"firstLine","type":{"names":["string"]},"description":"First line shown in the task details panel.
","optional":true,"defaultvalue":""},{"name":"secondLine","type":{"names":["string"]},"description":"Second line shown in the task details panel.
","optional":true,"defaultvalue":""},{"name":"IconComponent","type":{"names":["React.ComponentTypeRepresents the icon.
","optional":true,"defaultvalue":""},{"name":"ActionsComponent","type":{"names":["React.ComponentTypeRepresents the actions component.
","optional":true,"defaultvalue":""},{"name":"contentComponent","type":{"names":["React.ReactElement"]},"description":"Represents the content of the taks details panel.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in participants canvas.\n * @typedef {TaskDetailsPanelProps} TaskDetailsPanel.TaskDetailsPanelChildrenProps\n * @property {TaskDetailsPanelThemeProps} [theme.TaskDetailsPanel] - Theme\n */","name":"TaskDetailsPanelChildrenProps","type":{"names":["TaskDetailsPanelProps"]},"properties":[{"name":"theme.TaskDetailsPanel","type":{"names":["TaskDetailsPanelThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of taks info panel theme\n *\n * @typedef Theme.TaskInfoPanelThemeProps\n * @property {CSSProps} Container - Styles task info panel container.\n */","name":"TaskInfoPanelThemeProps","type":null,"properties":[{"name":"Container","type":{"names":["CSSProps"]},"description":"Styles task info panel container.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Task info panel.\n *\n * @typedef {PartialRepresents template code.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children of task info panel.\n *\n * @typedef {TaskInfoPanelProps} TaskInfoPanel.TaskInfoPanelChildrenProps\n */","name":"TaskInfoPanelChildrenProps","type":{"names":["TaskInfoPanelProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Task Transcription panel.\n * @typedef {PartialRepresents template code.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children of Task Transcription panel.\n * @typedef {TaskTranscriptionPanelProps} TaskTranscriptionPanel.TaskTranscriptionPanelChildrenProps\n */","name":"TaskTranscriptionPanelChildrenProps","type":{"names":["TaskTranscriptionPanelProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Task Wrapup panel.\n * @typedef {PartialRepresents template code.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children of Task Wrapup panel.\n * @typedef {TaskWrapupPanelProps} TaskWrapupPanel.TaskWrapupPanelChildrenProps\n */","name":"TaskWrapupPanelChildrenProps","type":{"names":["TaskWrapupPanelProps"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Task Context interface\n * @typedef {object} TaskContextProps\n * @property {ITask} [task] - Task.\n * @property {Call} [call] - Call state of the task.\n * @property {ConferenceState} [conference] - Conference state of the task.\n * @property {TaskChannelDefinition} [channelDefinition] - Channel definition of the task.\n * @property {ConversationState.ConversationState} [conversation] - Conversation state of the task. Present if task is chat-based.\n * @memberof TaskContext\n */","name":"TaskContextProps","type":{"names":["object"]},"properties":[{"name":"task","type":{"names":["ITask"]},"description":"Task.
","optional":true,"defaultvalue":""},{"name":"call","type":{"names":["Call"]},"description":"Call state of the task.
","optional":true,"defaultvalue":""},{"name":"conference","type":{"names":["ConferenceState"]},"description":"Conference state of the task.
","optional":true,"defaultvalue":""},{"name":"channelDefinition","type":{"names":["TaskChannelDefinition"]},"description":"Channel definition of the task.
","optional":true,"defaultvalue":""},{"name":"conversation","type":{"names":["ConversationState.ConversationState"]},"description":"Conversation state of the task. Present if task is chat-based.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Task Context Provider props interface\n * @typedef {object} TaskContextProviderProps\n * @property {string} taskSid - Sid of the task\n * @memberof TaskContextSource\n */","name":"TaskContextProviderProps","type":{"names":["object"]},"properties":[{"name":"taskSid","type":{"names":["string"]},"description":"Sid of the task
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef QueuesStatsView.fullscreen\n * @memberof QueuesStatsView\n * @description\n *\n * This property lets you enable and customize fullscreenability of QueuesStatsView.\n *
\n * Flex.QueuesStatsView.fullscreen = {\n * enabled: true\n * }\n * \n * \n * render prop to add a custom button, e.g.:\n *
\n *\n * fullscreen.renderButton = ({\n * isFullscreen,\n * toggleFullscreen\n * }) =>\n * <MyCustomButton\n * isVisible={!isFullscreen}\n * onClick={toggleFullscreen}\n * />\n * \n * @property {React.CSSProperties} [wrapperStyles={}] custom styles for the div wrapping the fullscreenable view\n */","name":"fullscreen","type":null,"properties":[{"name":"enabled","type":{"names":["boolean"]},"description":"adds a button to toggle fullscreen for the component
","optional":true,"defaultvalue":"false"},{"name":"renderButton","type":{"names":["function"]},"description":"\nrender prop to add a custom button, e.g.:\n
\n\nfullscreen.renderButton = ({\n isFullscreen,\n toggleFullscreen\n}) =>\n <MyCustomButton\n isVisible={!isFullscreen}\n onClick={toggleFullscreen}\n />\n","optional":true,"defaultvalue":"null"},{"name":"wrapperStyles","type":{"names":["React.CSSProperties"]},"description":"custom styles for the div wrapping the fullscreenable view
","optional":true,"defaultvalue":"{}"}]}},{"node":{"kind":"typedef","comment":"/**\n * QueuesStats.AggregatedQueuesDataTiles Props.\n * @typedef QueuesStats․AggregatedQueuesDataTilesProps\n * @memberof QueuesStats․AggregatedQueuesDataTiles\n * @property {React.ReactElementAdd\nadditional tiles using AggregatedDataTileV2 components wrapped in ContentFragment.
Callback to filter data tiles from the component.\nReturn false to exclude a card with a given id from the view. Default card ids are 'agents-by-activity-chart-tile'\nand 'all'. Channel tiles are identified by their task channel sid e.g. 'TC...', and can be removed accordingly.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Props passed to children of QueuesStats.AggregatedQueuesDataTiles\n * @typedef QueuesStats․AggregatedQueuesDataTilesChildrenProps\n * @memberof QueuesStats․AggregatedQueuesDataTiles\n * @property {Theme} theme theme\n */","name":"QueuesStats․AggregatedQueuesDataTilesChildrenProps","type":null,"properties":[{"name":"theme","type":{"names":["Theme"]},"description":"theme
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * QueuesDataTable Props.\n * @typedef QueuesStats․QueuesDataTableProps\n * @memberof QueuesStats․QueuesDataTable\n * @property {React.ReactElementAdd\nadditional columns using ColumnDefinition components wrapped in ContentFragment.\nContent renderer function passed to ColumnDefinition will receive QueuesStats․WorkerQueue as an argument.
Theme
","optional":null,"defaultvalue":""},{"name":"defaultSortColumn","type":{"names":["string"]},"description":"Default sort option, if undefined it will use friendly-name.
","optional":true,"defaultvalue":"\"friendly-name\""},{"name":"queuesList","type":{"names":["ArrayAn array of task queues to be passed to the data table.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Task Context Provider props interface\n *\n * @typedef {object} TaskContextProviderProps\n * @property {string} taskSid - Sid of the task\n * @memberof SupervisorTaskContextSource\n */","name":"TaskContextProviderProps","type":{"names":["object"]},"properties":[{"name":"taskSid","type":{"names":["string"]},"description":"Sid of the task
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of the Task Canvas.\n *\n * @typedef Supervisor․TaskCanvasProps\n * @memberOf Supervisor․TaskCanvas\n * @property {React.RefObjectref to handle the close button.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of task canvas theme.\n *\n * @typedef TaskCanvasThemeProps\n * @property {CSSProps} HeaderButton - Styles header button of the panel.\n * @property {CSSProps} Container - Styles task canvas container.\n * @property {CSSProps} MonitorActiveButton - Styles active monitoring button.\n * @property {CSSProps} Button - Styles all other buttons.\n * @property {CSSProps} Header - Styles task canvas panel header.\n * @memberof Supervisor․TaskCanvas\n */","name":"TaskCanvasThemeProps","type":null,"properties":[{"name":"HeaderButton","type":{"names":["CSSProps"]},"description":"Styles header button of the panel.
","optional":null,"defaultvalue":""},{"name":"Container","type":{"names":["CSSProps"]},"description":"Styles task canvas container.
","optional":null,"defaultvalue":""},{"name":"MonitorActiveButton","type":{"names":["CSSProps"]},"description":"Styles active monitoring button.
","optional":null,"defaultvalue":""},{"name":"Button","type":{"names":["CSSProps"]},"description":"Styles all other buttons.
","optional":null,"defaultvalue":""},{"name":"Header","type":{"names":["CSSProps"]},"description":"Styles task canvas panel header.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in task canvas.\n *\n * @typedef Supervisor․TaskCanvasChildrenProps\n * @memberOf Supervisor․TaskCanvas\n * @property { Supervisor.TaskCanvas.TaskCanvasThemeProps } [theme.Supervisor.TaskCanvas] - Theme\n */","name":"Supervisor․TaskCanvasChildrenProps","type":null,"properties":[{"name":"theme.Supervisor.TaskCanvas","type":{"names":["Supervisor.TaskCanvas.TaskCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in task canvas header.\n *\n * @typedef {TaskContextProps} TaskCanvasHeaderChildrenProps\n * @property { Supervisor.TaskCanvas.TaskCanvasThemeProps } [theme.Supervisor.TaskCanvasHeader] - Theme\n * @memberof Supervisor․TaskCanvas\n */","name":"TaskCanvasHeaderChildrenProps","type":{"names":["TaskContextProps"]},"properties":[{"name":"theme.Supervisor.TaskCanvasHeader","type":{"names":["Supervisor.TaskCanvas.TaskCanvasThemeProps"]},"description":"Theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of task canvas tabs component.\n *\n * @typedef Supervisor․TaskCanvasTabsProps\n * @memberof Supervisor․TaskCanvasTabs\n */","name":"Supervisor․TaskCanvasTabsProps","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children in task canvas tabs.\n *\n * @typedef Supervisor․TaskCanvasTabsChildrenProps\n * @property {boolean} [hasMarkdownSupport] - Whether markdown feature is enabled or not.\n * @property {string} [selectedTabName] - Selected tab name.\n * @memberof Supervisor․TaskCanvasTabs\n */","name":"Supervisor․TaskCanvasTabsChildrenProps","type":null,"properties":[{"name":"hasMarkdownSupport","type":{"names":["boolean"]},"description":"Whether markdown feature is enabled or not.
","optional":true,"defaultvalue":""},{"name":"selectedTabName","type":{"names":["string"]},"description":"Selected tab name.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Programmable properties of Supervisor․TaskInfoPanel.\n *\n * @typedef TaskInfoPanel.TaskInfoPanelProgrammableProps\n * @property {DynamicContentStoreRepresents dynamic content store.
","optional":true,"defaultvalue":""},{"name":"templateCode","type":{"names":["string"]},"description":"Represents template code.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of TaskCardProps.\n *\n * @typedef Supervisor․TaskCardProps\n * @memberof Supervisor․TaskCard\n * @property {string | React.ReactNode} [icon] - Task Card icon.\n * @property {React.ReactChild} [firstLine] - Task Card first line.\n * @property {React.ReactChild} [secondLine] - Task Card second line.\n * @property {Function} [onClick] - Callback called when task is selected.\n * @property {boolean} [highlighted] - Whether the task card is highlighted or no.\n * @property {boolean} [selected] - Whether the task card is selected or no.\n * @property {DynamicContentStore.DynamicComponentChildrenTask Card icon.
","optional":true,"defaultvalue":""},{"name":"firstLine","type":{"names":["React.ReactChild"]},"description":"Task Card first line.
","optional":true,"defaultvalue":""},{"name":"secondLine","type":{"names":["React.ReactChild"]},"description":"Task Card second line.
","optional":true,"defaultvalue":""},{"name":"onClick","type":{"names":["function"]},"description":"Callback called when task is selected.
","optional":true,"defaultvalue":""},{"name":"highlighted","type":{"names":["boolean"]},"description":"Whether the task card is highlighted or no.
","optional":true,"defaultvalue":""},{"name":"selected","type":{"names":["boolean"]},"description":"Whether the task card is selected or no.
","optional":true,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of TaskCard.\n *\n * @typedef Supervisor.TaskCardChildrenProps\n * @memberof Supervisor․TaskCard\n */","name":"TaskCardChildrenProps","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of TaskCardList.\n *\n * @typedef Supervisor․TaskCardListProps\n * @memberof Supervisor․TaskCardList\n * @property {ArrayList of tasks.
","optional":null,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Props passed to children of TaskCardList.\n *\n * @typedef Supervisor․TaskCardListChildrenProps\n * @memberof Supervisor․TaskCardList\n * @property {Function} [compareFunction] - A compare function that receives two tasks as arguments. Negative number means task a should be above task b, positive number that a should be below b. 0 indicates equal priority.\n * @property {Function} [filter] - Filter function used to filter tasks for this list.\n * @property {Function} [onCardSelected] - A function to call with ITask in order to select the task.\n * @property {string} [selectedTaskSid] - Sid of the selected task.\n * @property {string} [highlightedTaskSid] - Sid of the highlighted task.\n * @property {ArrayA compare function that receives two tasks as arguments. Negative number means task a should be above task b, positive number that a should be below b. 0 indicates equal priority.
","optional":true,"defaultvalue":""},{"name":"filter","type":{"names":["function"]},"description":"Filter function used to filter tasks for this list.
","optional":true,"defaultvalue":""},{"name":"onCardSelected","type":{"names":["function"]},"description":"A function to call with ITask in order to select the task.
","optional":true,"defaultvalue":""},{"name":"selectedTaskSid","type":{"names":["string"]},"description":"Sid of the selected task.
","optional":true,"defaultvalue":""},{"name":"highlightedTaskSid","type":{"names":["string"]},"description":"Sid of the highlighted task.
","optional":true,"defaultvalue":""},{"name":"tasks","type":{"names":["ArrayUnfiltered tasks in the list.
","optional":null,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Programmable properties of TaskCardList.\n *\n * @typedef Supervisor․TaskCardListProgrammableProps\n * @memberof Supervisor․TaskCardList\n * @property {Function} [compareFunction] - A compare function that receives two tasks as arguments. Negative number means task a should be above task b, positive number that a should be below b. 0 indicates equal priority.\n */","name":"Supervisor․TaskCardListProgrammableProps","type":null,"properties":[{"name":"compareFunction","type":{"names":["function"]},"description":"A compare function that receives two tasks as arguments. Negative number means task a should be above task b, positive number that a should be below b. 0 indicates equal priority.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of TaskOverviewCanvas.\n *\n * @typedef Supervisor․TaskOverviewCanvasProps\n * @property {string} [firstLine] - First line shown in task overview.\n * @property {string} [secondLine] - Second line shown in task overview.\n * @property {DynamicContentStore.DynamicComponentChildrenFirst line shown in task overview.
","optional":true,"defaultvalue":""},{"name":"secondLine","type":{"names":["string"]},"description":"Second line shown in task overview.
","optional":true,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef Supervisor․TeamFiltersPanelChildrenProps\n * @memberof Supervisor․TeamFiltersPanel\n * @property {ArrayRepresents applied filters.
","optional":true,"defaultvalue":""},{"name":"filters","type":{"names":["ArrayList of filters.
","optional":true,"defaultvalue":""},{"name":"isHidden","type":{"names":["boolean"]},"description":"Indicates whether the panel is currently hidden.
","optional":null,"defaultvalue":""},{"name":"isLoadingWorkers","type":{"names":["boolean"]},"description":"Indicates whether workers are loading.
","optional":null,"defaultvalue":""},{"name":"workers","type":{"names":["ArrayRepresents list of workers.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Worker Canvas.\n *\n * @typedef WorkerCanvas.WorkerCanvasProps\n * @property {boolean} [showSkills=true] - Whether or not the skills section for the agent details should be shown.\n */","name":"WorkerCanvasProps","type":null,"properties":[{"name":"showSkills","type":{"names":["boolean"]},"description":"Whether or not the skills section for the agent details should be shown.
","optional":true,"defaultvalue":"true"}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Worker Canvas.\n *\n * @typedef WorkerCanvas.WorkerCanvasChildrenProps\n * @property {IWorker} worker - Worker to display\n * @property {boolean} [showSkills=true] - Whether or not the skills section for the agent details should be shown.\n */","name":"WorkerCanvasChildrenProps","type":null,"properties":[{"name":"worker","type":{"names":["IWorker"]},"description":"Worker to display
","optional":null,"defaultvalue":""},{"name":"showSkills","type":{"names":["boolean"]},"description":"Whether or not the skills section for the agent details should be shown.
","optional":true,"defaultvalue":"true"}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef WorkerProfile.WorkerProfileProps\n * @property {IWorker} worker - Worker\n * @property {boolean} [editStatusPermission] - permission to edit the activity of other workers\n */","name":"WorkerProfileProps","type":null,"properties":[{"name":"worker","type":{"names":["IWorker"]},"description":"Worker
","optional":null,"defaultvalue":""},{"name":"editStatusPermission","type":{"names":["boolean"]},"description":"permission to edit the activity of other workers
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Worker Profile.\n *\n * @typedef WorkerProfile.WorkerProfileChildrenProps\n * @property {IWorker} worker - Worker\n * @property {boolean} [editStatusPermission] - permission to edit the activity of other workers\n * @memberof WorkerProfile\n */","name":"WorkerProfileChildrenProps","type":null,"properties":[{"name":"worker","type":{"names":["IWorker"]},"description":"Worker
","optional":null,"defaultvalue":""},{"name":"editStatusPermission","type":{"names":["boolean"]},"description":"permission to edit the activity of other workers
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Worker Skills.\n *\n * @typedef WorkerSkills.WorkerSkillsProps\n * @property {IWorker} worker - Worker\n * @property {ArrayWorker
","optional":null,"defaultvalue":""},{"name":"availableSkills","type":{"names":["ArrayAvailable skills
","optional":true,"defaultvalue":""},{"name":"editSkillsPermission","type":{"names":["boolean"]},"description":"permission to edit the skills
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Programmable properties of WorkerSkills.\n *\n * @typedef WorkerSkillsProps.WorkerSkillsProgrammableProps\n * @property {ArrayAvailable skills
","optional":true,"defaultvalue":""},{"name":"editSkillsPermission","type":{"names":["boolean"]},"description":"permission to edit the skills
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of WorkerSkills.\n *\n * @typedef {object} WorkerSkills.WorkerSkillsChildrenProps\n * @property {IWorker} [worker] Worker object\n * @property {ArrayWorker object
","optional":true,"defaultvalue":""},{"name":"availableSkills","type":{"names":["ArrayAvailable skill
","optional":true,"defaultvalue":""},{"name":"editSkillsPermission","type":{"names":["boolean"]},"description":"permission to edit the skills
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of the Worker Data Table\n * @typedef WorkersDataTable.WorkersDataTableProps\n * @property {boolean} isLoading - Indicates whether worker data table is loading.\n * @property {ArrayIndicates whether worker data table is loading.
","optional":null,"defaultvalue":""},{"name":"workers","type":{"names":["ArrayList of workers and their associated tasks.
","optional":null,"defaultvalue":""},{"name":"onTaskSelected","type":{"names":["function"]},"description":"Function called when task selected.
","optional":null,"defaultvalue":""},{"name":"onWorkerSelected","type":{"names":["function"]},"description":"Function called when worker selected.
","optional":null,"defaultvalue":""},{"name":"sortWorkers","type":{"names":["function"]},"description":"Compare function to use when sorting by workers.
","optional":true,"defaultvalue":"WorkersDataTable.defaultCompareFunction"},{"name":"sortCalls","type":{"names":["function"]},"description":"Compare function to use when sorting by calls.
","optional":true,"defaultvalue":""},{"name":"sortTasks","type":{"names":["function"]},"description":"Compare function to use when sorting by tasks.
","optional":true,"defaultvalue":""},{"name":"filters","type":{"names":["ArrayLegacy filters. Please use the filter API on the TeamsView component.
","optional":true,"defaultvalue":"WorkersDataTable.defaultFilters"},{"name":"taskFilter","type":{"names":["string"]},"description":"An expression used to filter out workers tasks.
","optional":true,"defaultvalue":"WorkersDataTable.taskFilter"},{"name":"defaultSortColumn","type":{"names":["string"]},"description":"Default sort column.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Programmable properties of WorkersDataTable.\n * @typedef WorkersDataTable.WorkersDataTableProgrammableProps\n */","name":"WorkersDataTableProgrammableProps","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Props passed to children of WorkersDataTable.\n * @typedef {object} WorkersDataTable.WorkersDataTableChildrenProps\n * @property {ArrayList of workers.
","optional":true,"defaultvalue":""},{"name":"selectedTask","type":{"names":["ITask"]},"description":"Selected task in the table.
","optional":true,"defaultvalue":""},{"name":"selectedWorker","type":{"names":["IWorker"]},"description":"Selected worker in the table.
","optional":true,"defaultvalue":""},{"name":"monitoredTaskSid","type":{"names":["string"]},"description":"Sid of the monitored task.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * ColumnDataCreationContext.\n * @typedef {object} WorkersDataTable.ColumnDataCreationContext\n * @property {Function} [onTaskSelected] - Callback called when a task is selected.\n * @property {ITask} [selectedTask] - Selected task.\n * @property {string} [monitoredTaskSid] - Sid of the monitored task.\n */","name":"ColumnDataCreationContext","type":{"names":["object"]},"properties":[{"name":"onTaskSelected","type":{"names":["function"]},"description":"Callback called when a task is selected.
","optional":true,"defaultvalue":""},{"name":"selectedTask","type":{"names":["ITask"]},"description":"Selected task.
","optional":true,"defaultvalue":""},{"name":"monitoredTaskSid","type":{"names":["string"]},"description":"Sid of the monitored task.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Base Flex colors\n * @typedef Theme.BaseThemeColors\n * @ignore\n * @property {string} holdColor - Color of the hold button\n * @property {string} declineColor - Color of the decline button\n * @property {string} declineTextColor - Color of the decline text\n * @property {string} acceptColor - Color of the accept button\n * @property {string} acceptTextColor - Color of the accept text\n * @property {string} completeTaskColor - Color of the \"complete task\" button\n * @property {string} flexBlueColor - FlexBlue color\n * @property {string} agentAvailableColor - Color that indicates available agent status\n * @property {string} agentBusyColor - Color that indicates busy agent status\n * @property {string} agentUnavailableColor - Color that indicates unavailable agent status\n * @property {string} agentOfflineColor - Color that indicates offline agent status\n */","name":"BaseThemeColors","type":null,"properties":[{"name":"holdColor","type":{"names":["string"]},"description":"Color of the hold button
","optional":null,"defaultvalue":""},{"name":"declineColor","type":{"names":["string"]},"description":"Color of the decline button
","optional":null,"defaultvalue":""},{"name":"declineTextColor","type":{"names":["string"]},"description":"Color of the decline text
","optional":null,"defaultvalue":""},{"name":"acceptColor","type":{"names":["string"]},"description":"Color of the accept button
","optional":null,"defaultvalue":""},{"name":"acceptTextColor","type":{"names":["string"]},"description":"Color of the accept text
","optional":null,"defaultvalue":""},{"name":"completeTaskColor","type":{"names":["string"]},"description":"Color of the "complete task" button
","optional":null,"defaultvalue":""},{"name":"flexBlueColor","type":{"names":["string"]},"description":"FlexBlue color
","optional":null,"defaultvalue":""},{"name":"agentAvailableColor","type":{"names":["string"]},"description":"Color that indicates available agent status
","optional":null,"defaultvalue":""},{"name":"agentBusyColor","type":{"names":["string"]},"description":"Color that indicates busy agent status
","optional":null,"defaultvalue":""},{"name":"agentUnavailableColor","type":{"names":["string"]},"description":"Color that indicates unavailable agent status
","optional":null,"defaultvalue":""},{"name":"agentOfflineColor","type":{"names":["string"]},"description":"Color that indicates offline agent status
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef ThemeProps\n * @property {Theme} [theme] The theme\n * @memberof Theme\n */","name":"ThemeProps","type":null,"properties":[{"name":"theme","type":{"names":["Theme"]},"description":"The theme
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Agent desktop theme props\n * @typedef Theme.AgentDesktopViewThemeProps\n * @property {CSSProps} Panel1 panel 1 styles\n * @property {CSSProps} Panel2 panel 2 styles\n * @property {CSSProps} ContentSplitter content splitter styles\n */","name":"AgentDesktopViewThemeProps","type":null,"properties":[{"name":"Panel1","type":{"names":["CSSProps"]},"description":"panel 1 styles
","optional":null,"defaultvalue":""},{"name":"Panel2","type":{"names":["CSSProps"]},"description":"panel 2 styles
","optional":null,"defaultvalue":""},{"name":"ContentSplitter","type":{"names":["CSSProps"]},"description":"content splitter styles
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of children from AgentDesktopView\n * @typedef AgentDesktopView.AgentDesktopViewChildrenProps\n * @property {string} [selectedTaskSid] SID of the currently selected task\n * @property {MapSID of the currently selected task
","optional":true,"defaultvalue":""},{"name":"tasks","type":{"names":["MapA map of the worker's tasks
","optional":null,"defaultvalue":""},{"name":"route","type":{"names":["RouteComponentProps"]},"description":"Routing object
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * AgentDesktopView properties\n * @typedef {ViewAdditionalProps} AgentDesktopView.AgentDesktopViewProps\n * @property {string} [selectedTaskSid] SID of the currently selected task\n * @property {AgentDesktopView.SplitterProps} [splitterOptions] Options to customise panels sizes\n * @property {boolean} [showPanel2] If set to false, this flag hides the second panel of the view\n * @property {RouteComponentProps} route Routing object\n * @property {DynamicContentStore.DynamicComponentChildrenSID of the currently selected task
","optional":true,"defaultvalue":""},{"name":"splitterOptions","type":{"names":["AgentDesktopView.SplitterProps"]},"description":"Options to customise panels sizes
","optional":true,"defaultvalue":""},{"name":"showPanel2","type":{"names":["boolean"]},"description":"If set to false, this flag hides the second panel of the view
","optional":true,"defaultvalue":""},{"name":"route","type":{"names":["RouteComponentProps"]},"description":"Routing object
","optional":null,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Splitter configuration\n * @typedef AgentDesktopView.SplitterProps\n * @property {string} [initialFirstPanelSize] initial size for the first panel. e.g 320px\n * @property {string} [minimumFirstPanelSize] minimum allowed size for the first panel. e.g 320px\n * @property {string} [minimumSecondPanelSize] minimum allowed size for the second panel. e.g 320px\n */","name":"SplitterProps","type":null,"properties":[{"name":"initialFirstPanelSize","type":{"names":["string"]},"description":"initial size for the first panel. e.g 320px
","optional":true,"defaultvalue":""},{"name":"minimumFirstPanelSize","type":{"names":["string"]},"description":"minimum allowed size for the first panel. e.g 320px
","optional":true,"defaultvalue":""},{"name":"minimumSecondPanelSize","type":{"names":["string"]},"description":"minimum allowed size for the second panel. e.g 320px
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Panel1 properties\n * @typedef {AgentDesktopViewChildrenProps} Panel1.AgentDesktopPanel1Props\n * @property {Panel1.SplitterOrientation} [splitterOrientation] Orientation of splitter component\n * @property {DynamicContentStore.DynamicComponentChildrenOrientation of splitter component
","optional":true,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Panel2 properties\n *\n * @typedef {AgentDesktopViewChildrenProps} Panel2.AgentDesktopPanel2Props\n * @property {Panel2.SplitterOrientation} [splitterOrientation] Orientation of splitter component\n * @property {DynamicContentStore.DynamicComponentChildrenOrientation of splitter component
","optional":true,"defaultvalue":""},{"name":"children","type":{"names":["DynamicContentStore.DynamicComponentChildrenchildren
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * QueuesStatsView Props\n *\n * @typedef QueuesStatsView.QueuesStatsViewProps\n * @property {ContextProvider.FlexContextType} [context] context\n * @property {React.ReactElementcontext
","optional":true,"defaultvalue":""},{"name":"children","type":{"names":["React.ReactElementChildren must be wrapped in ContentFragment
If you are using custom router and want to pass the route props to children
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Props passed to children of QueuesStatsView\n *\n * @typedef QueuesStatsView.QueuesStatsViewChildrensProps\n * @property {boolean} isLoading Is realtime queues stats data being fetched\n * @property {boolean} hasNoData If true, there are no queues set up\n * @property {boolean} [isViewActive=undefined] True/false if part of a {@link ViewCollection}, otherwise undefined\n * @property {RouteComponentProps} [route=undefined] Route component props if part of a {@link ViewCollection} or the route prop passed to {@link QueuesStatsView}\n * @property {Theme} theme theme\n */","name":"QueuesStatsViewChildrensProps","type":null,"properties":[{"name":"isLoading","type":{"names":["boolean"]},"description":"Is realtime queues stats data being fetched
","optional":null,"defaultvalue":""},{"name":"hasNoData","type":{"names":["boolean"]},"description":"If true, there are no queues set up
","optional":null,"defaultvalue":""},{"name":"isViewActive","type":{"names":["boolean"]},"description":"True/false if part of a {@link ViewCollection}, otherwise undefined
","optional":true,"defaultvalue":""},{"name":"route","type":{"names":["RouteComponentProps"]},"description":"Route component props if part of a {@link ViewCollection} or the route prop passed to {@link QueuesStatsView}
","optional":true,"defaultvalue":""},{"name":"theme","type":{"names":["Theme"]},"description":"theme
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {Function} TeamsView.FilterDefinitionFactory\n */","name":"FilterDefinitionFactory","type":{"names":["function"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Properties of Teams view.\n * @typedef TeamsView.TeamsViewProps\n * @property {RouteComponentPropsRepresents route params.
","optional":true,"defaultvalue":""},{"name":"filters","type":{"names":["Array<(FilterDefinition|FilterDefinitionFactory)>"]},"description":"List of filters or filterFactories
","optional":true,"defaultvalue":""},{"name":"hiddenFilter","type":{"names":["AppliedFilter","ArrayHidden filter definition
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of routes in teams view.\n * @typedef TeamsView.TeamsViewRouteParams\n * @property {(\"tasks\" | \"workers\")} [resources] Represents if task or worker is part of route resource.\n * @property {string} [sid] Represents the indentification of the task or worker\n */","name":"TeamsViewRouteParams","type":null,"properties":[{"name":"resources","type":{"names":["\"tasks\"","\"workers\""]},"description":"Represents if task or worker is part of route resource.
","optional":true,"defaultvalue":""},{"name":"sid","type":{"names":["string"]},"description":"Represents the indentification of the task or worker
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {TeamsViewImplProps} TeamsView.TeamsViewChildrenProps\n * @property {ArrayRepresents applied filters.
","optional":true,"defaultvalue":""},{"name":"filters","type":{"names":["ArrayList of filter definitions.
","optional":true,"defaultvalue":""},{"name":"monitoredTaskSid","type":{"names":["string"]},"description":"Represents current monitoring task.
","optional":true,"defaultvalue":""},{"name":"stickyWorker","type":{"names":["SupervisorWorkerState"]},"description":"Represents selected worker.
","optional":true,"defaultvalue":""},{"name":"workers","type":{"names":["ArrayRepresents list of workers.
","optional":true,"defaultvalue":""},{"name":"isViewActive","type":{"names":["boolean"]},"description":"Indicates whether the view is active.
","optional":null,"defaultvalue":""},{"name":"isLoadingWorkers","type":{"names":["boolean"]},"description":"Indicates whether workers are loading.
","optional":null,"defaultvalue":""},{"name":"isSearchFilterApplied","type":{"names":["boolean"]},"description":"Indicates whether search filter is applied.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef CompatibilityOptions\n * @property {string} yes=\"yes\"\n * @property {string} no=\"no\"\n * @property {string} deprecated=\"deprecated\"\n * @private\n */","name":"CompatibilityOptions","type":null,"properties":[{"name":"yes","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":"\"yes\""},{"name":"no","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":"\"no\""},{"name":"deprecated","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":"\"deprecated\""}]}},{"node":{"kind":"typedef","comment":"/**\n * Flex context interface\n * @typedef {object} FlexContextType\n * @property {Manager} manager - an instance of Flex Manager class\n * @property {boolean} [legacy] - force compatibility mode in case of differing react-redux versions\n * @memberof ContextProvider\n */","name":"FlexContextType","type":{"names":["object"]},"properties":[{"name":"manager","type":{"names":["Manager"]},"description":"an instance of Flex Manager class
","optional":null,"defaultvalue":""},{"name":"legacy","type":{"names":["boolean"]},"description":"force compatibility mode in case of differing react-redux versions
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Context Provider props interface\n * @typedef {ContextProvider.FlexContextType} ContextProviderProps\n * @memberof ContextProvider\n */","name":"ContextProviderProps","type":{"names":["ContextProvider.FlexContextType"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} FormatterTypeOptions\n * @property {PredefinedFormatters} type a type of a predefined formatter\n * @memberof Log\n */","name":"FormatterTypeOptions","type":{"names":["object"]},"properties":[{"name":"type","type":{"names":["PredefinedFormatters"]},"description":"a type of a predefined formatter
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef FormatterConfigurableOptions\n * @mixes Log.FormatterTypeOptions\n * @memberof Log\n */","name":"FormatterConfigurableOptions","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * A way to define a formatter for a log manager\n *\n * @typedef {CreateFormatter | FormatterConfigurableOptions} FormatterConfig\n * @memberof Log\n */","name":"FormatterConfig","type":{"names":["CreateFormatter","FormatterConfigurableOptions"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {object} ClassProxySpySpecificOptions\n * @property {Arraymethods of a target class to be spied on
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef ClassProxySpyOptions\n * @mixes Log.SpyCommonConfigurableOptions\n * @mixes Log.ClassProxySpySpecificOptions\n * @memberof Log\n */","name":"ClassProxySpyOptions","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {object} DOMEventsSpySpecificOptions\n * @property {Arrayevents to listen to
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef DOMEventsSpyOptions\n * @mixes Log.SpyCommonConfigurableOptions\n * @mixes Log.DOMEventsSpySpecificOptions\n * @memberof Log\n */","name":"DOMEventsSpyOptions","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {object} EventEmitterSpySpecificOptions\n * @property {Arrayevents to listen to
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef EventEmitterSpyOptions\n * @mixes Log.SpyCommonConfigurableOptions\n * @mixes Log.EventEmitterSpySpecificOptions\n * @memberof Log\n */","name":"EventEmitterSpyOptions","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @package\n * @typedef {object} LoglevelSpySpecificOptions\n * @property {Arraymethods of a target class to be spied on
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef LoglevelSpyOptions\n * @mixes Log.SpyCommonConfigurableOptions\n * @mixes Log.LoglevelSpySpecificOptions\n * @memberof Log\n */","name":"LoglevelSpyOptions","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Configurable options common to all spies\n *\n * @category Log Manager\n * @typedef {object} SpyCommonConfigurableOptions\n * @property {any} [target] an entity that is being tracked by spy\n * @property {string} [targetAlias] an human-readable description of a target\n * @property {OnStartCallback} [onStart] allows to run some logic after a spy started\n * @memberof Log\n */","name":"SpyCommonConfigurableOptions","type":{"names":["object"]},"properties":[{"name":"target","type":{"names":["any"]},"description":"an entity that is being tracked by spy
","optional":true,"defaultvalue":""},{"name":"targetAlias","type":{"names":["string"]},"description":"an human-readable description of a target
","optional":true,"defaultvalue":""},{"name":"onStart","type":{"names":["OnStartCallback"]},"description":"allows to run some logic after a spy started
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @category Log Manager\n * @typedef {object} SpyConstructorOptions\n * @property {NotifyCallback} trigger trigger callback\n * @mixes SpyCommonConfigurableOptions\n * @memberof Log\n */","name":"SpyConstructorOptions","type":{"names":["object"]},"properties":[{"name":"trigger","type":{"names":["NotifyCallback"]},"description":"trigger callback
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * An entity to spy on\n *\n * @typedef {any} Target\n * @memberof Log\n */","name":"Target","type":{"names":["any"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Data unit representing an atomic information collected by a spy\n *\n * @typedef {object} LogEntry\n * @property {Target} [target] an entity that is spied on\n * @property {string} [targetAlias] verbose name for target\n * @property {string} [subject] a name of a method, a property or a topic that the collected data relates to\n * @property {Arrayan entity that is spied on
","optional":true,"defaultvalue":""},{"name":"targetAlias","type":{"names":["string"]},"description":"verbose name for target
","optional":true,"defaultvalue":""},{"name":"subject","type":{"names":["string"]},"description":"a name of a method, a property or a topic that the collected data relates to
","optional":true,"defaultvalue":""},{"name":"args","type":{"names":["Arrayarguments passed to a subject (whenever it's function)
","optional":true,"defaultvalue":""},{"name":"result","type":{"names":["any"]},"description":"result of calling a subject (whenever it's function)
","optional":true,"defaultvalue":""},{"name":"timestamp","type":{"names":["number"]},"description":"the time at which the log entry is recorded
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} SpyTypeOptions\n * @property {PredefinedSpies} type a type of a predefined spy\n * @memberof Log\n */","name":"SpyTypeOptions","type":{"names":["object"]},"properties":[{"name":"type","type":{"names":["PredefinedSpies"]},"description":"a type of a predefined spy
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Options for predefined spies\n *\n * @typedef {object} SpyConfigurableOptions\n * @mixes Log.SpyTypeOptions\n * @mixes Log.ClassProxySpyOptions\n * @mixes Log.DOMEventsSpyOptions\n * @mixes Log.EventEmitterSpyOptions\n * @mixes Log.LoglevelSpyOptions\n * @memberof Log\n * @exampleunique identifier
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} Log.LocalStorageOptions\n * @mixes Log.LocalStorageSpecificOptions\n * @property {string} [identifier] unique identifier\n */","name":"LocalStorageOptions","type":{"names":["object"]},"properties":[{"name":"identifier","type":{"names":["string"]},"description":"unique identifier
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} Log.MemoryStorageSpecificOptions\n * @property {string} [identifier] Unique identifier\n * @property {boolean} [extendedLogs] Set to true to get, uncut, unprocessed logs from spy\n * @property {number} [maxLineLength] If extendedLogs is enabled, customise the maxLength of the stringified logs\n */","name":"MemoryStorageSpecificOptions","type":{"names":["object"]},"properties":[{"name":"identifier","type":{"names":["string"]},"description":"Unique identifier
","optional":true,"defaultvalue":""},{"name":"extendedLogs","type":{"names":["boolean"]},"description":"Set to true to get, uncut, unprocessed logs from spy
","optional":true,"defaultvalue":""},{"name":"maxLineLength","type":{"names":["number"]},"description":"If extendedLogs is enabled, customise the maxLength of the stringified logs
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} Log.MemoryStorageOptions\n * @mixes Log.MemoryStorageSpecificOptions\n * @property {string} [identifier] Unique identifier\n * @property {boolean} [extendedLogs] Set to true to get, uncut, unprocessed logs from spy\n * @property {number} [maxLineLength] If extendedLogs is enabled, customise the maxLength of the stringified logs\n */","name":"MemoryStorageOptions","type":{"names":["object"]},"properties":[{"name":"identifier","type":{"names":["string"]},"description":"Unique identifier
","optional":true,"defaultvalue":""},{"name":"extendedLogs","type":{"names":["boolean"]},"description":"Set to true to get, uncut, unprocessed logs from spy
","optional":true,"defaultvalue":""},{"name":"maxLineLength","type":{"names":["number"]},"description":"If extendedLogs is enabled, customise the maxLength of the stringified logs
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} StorageTypeOptions\n * @property {PredefinedStorages} type a type of a predefined storage\n * @memberof Log\n */","name":"StorageTypeOptions","type":{"names":["object"]},"properties":[{"name":"type","type":{"names":["PredefinedStorages"]},"description":"a type of a predefined storage
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Options for predefined storages\n *\n * @typedef {object} StorageConfigurableOptions\n * @mixes Log.StorageTypeOptions\n * @mixes Log.LocalStorageOptions\n * @property {PredefinedStorages} type a type of a predefined storage\n * @memberof Log\n */","name":"StorageConfigurableOptions","type":{"names":["object"]},"properties":[{"name":"type","type":{"names":["PredefinedStorages"]},"description":"a type of a predefined storage
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * A way to define a storage for a log manager\n *\n * @typedef {CreateStorage | StorageConfigurableOptions} StorageConfig\n * @memberof Log\n */","name":"StorageConfig","type":{"names":["CreateStorage","StorageConfigurableOptions"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} TransportTypeOptions\n * @property {PredefinedTransports} type a type of a predefined transport\n * @memberof Log\n */","name":"TransportTypeOptions","type":{"names":["object"]},"properties":[{"name":"type","type":{"names":["PredefinedTransports"]},"description":"a type of a predefined transport
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Options for predefined transports\n *\n * @typedef {object} TransportConfigurableOptions\n * @mixes Log.TransportTypeOptions\n * @memberof Log\n */","name":"TransportConfigurableOptions","type":{"names":["object"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * A way to define a transport for a log manager\n *\n * @typedef {CreateTransport | TransportConfigurableOptions} TransportConfig\n * @memberof Log\n */","name":"TransportConfig","type":{"names":["CreateTransport","TransportConfigurableOptions"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * User Info\n * @typedef {object} UserInfo\n * @property {string} identity identity\n * @property {Arrayidentity
","optional":null,"defaultvalue":""},{"name":"roles","type":{"names":["Arrayroles
","optional":null,"defaultvalue":""},{"name":"token","type":{"names":["string"]},"description":"access token
","optional":null,"defaultvalue":""},{"name":"tokenExpirationDate","type":{"names":["Date"]},"description":"token expiration date
","optional":null,"defaultvalue":""},{"name":"permissions","type":{"names":["Permissions"]},"description":"all permissions user have
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * OAuth2.0 Verifier Payload\n * @typedef {object} OAuthPayload\n * @property {string} nonce state identifier\n * @property {string} codeVerifier code verifier\n * @memberof SessionState\n */","name":"OAuthPayload","type":{"names":["object"]},"properties":[{"name":"nonce","type":{"names":["string"]},"description":"state identifier
","optional":null,"defaultvalue":""},{"name":"codeVerifier","type":{"names":["string"]},"description":"code verifier
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Flex Plugin\n *\n * @typedef {object} Plugin\n * @property {string} name name of the plugin\n * @property {PluginManager.InitCallback} init init function of the plugin. Instance of {@link Flex} and {@link Manager} will be passed as arguments.\n * @memberof PluginManager\n */","name":"Plugin","type":{"names":["object"]},"properties":[{"name":"name","type":{"names":["string"]},"description":"name of the plugin
","optional":null,"defaultvalue":""},{"name":"init","type":{"names":["PluginManager.InitCallback"]},"description":"init function of the plugin. Instance of {@link Flex} and {@link Manager} will be passed as arguments.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Plugin constructor type. Plugins must nave new() operator defined.\n *\n * @typedef {object} PluginConstructor\n * @property {PluginManager.Plugin} new() constructor of a plugin\n * @memberof PluginManager\n */","name":"PluginConstructor","type":{"names":["object"]},"properties":[{"name":"new()","type":{"names":["PluginManager.Plugin"]},"description":"constructor of a plugin
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * User Permissions\n * @typedef {object} Permissions\n * @property {boolean} teamsView permission to view teams page\n * @property {boolean} queueStatsView permission to view queues-stats page\n * @property {boolean} agentDesktopView permission to view agent-desktop page\n * @property {boolean} editSkills permission to edit other worker's skills\n * @property {boolean} editStatus permission to edit other worker's status\n * @property {boolean} monitorChat permission to monitor ongoing chat\n * @property {boolean} monitorCall permission to monitor ongoing call\n * @property {boolean} seeTaskInfo permission to see the info of ongoing task on teams view page\n * @property {boolean} selfEditStatus permission to edit own status\n * @property {boolean} readAdmin permission to view admin page\n * @property {boolean} writeAdmin permission to update settings on admin page\n */","name":"Permissions","type":{"names":["object"]},"properties":[{"name":"teamsView","type":{"names":["boolean"]},"description":"permission to view teams page
","optional":null,"defaultvalue":""},{"name":"queueStatsView","type":{"names":["boolean"]},"description":"permission to view queues-stats page
","optional":null,"defaultvalue":""},{"name":"agentDesktopView","type":{"names":["boolean"]},"description":"permission to view agent-desktop page
","optional":null,"defaultvalue":""},{"name":"editSkills","type":{"names":["boolean"]},"description":"permission to edit other worker's skills
","optional":null,"defaultvalue":""},{"name":"editStatus","type":{"names":["boolean"]},"description":"permission to edit other worker's status
","optional":null,"defaultvalue":""},{"name":"monitorChat","type":{"names":["boolean"]},"description":"permission to monitor ongoing chat
","optional":null,"defaultvalue":""},{"name":"monitorCall","type":{"names":["boolean"]},"description":"permission to monitor ongoing call
","optional":null,"defaultvalue":""},{"name":"seeTaskInfo","type":{"names":["boolean"]},"description":"permission to see the info of ongoing task on teams view page
","optional":null,"defaultvalue":""},{"name":"selfEditStatus","type":{"names":["boolean"]},"description":"permission to edit own status
","optional":null,"defaultvalue":""},{"name":"readAdmin","type":{"names":["boolean"]},"description":"permission to view admin page
","optional":null,"defaultvalue":""},{"name":"writeAdmin","type":{"names":["boolean"]},"description":"permission to update settings on admin page
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * SSO Token Payload\n * @typedef {object} SSOTokenPayload\n * @property {string} identity identity\n * @property {string[]} roles roles\n * @property {string} token access token\n * @property {string} expiration token expiration date\n * @property {Permissions} permissions all permissions user have\n * @property {string} accountSid Flex Account SID\n * @property {string} accessTokenExpiresAt timestamp when access token expires\n * @property {string} refreshTokenExpiresAt timestamp when refresh token expires (inactivity expiry)\n * @memberof AppState\n */","name":"SSOTokenPayload","type":{"names":["object"]},"properties":[{"name":"identity","type":{"names":["string"]},"description":"identity
","optional":null,"defaultvalue":""},{"name":"roles","type":{"names":["Arrayroles
","optional":null,"defaultvalue":""},{"name":"token","type":{"names":["string"]},"description":"access token
","optional":null,"defaultvalue":""},{"name":"expiration","type":{"names":["string"]},"description":"token expiration date
","optional":null,"defaultvalue":""},{"name":"permissions","type":{"names":["Permissions"]},"description":"all permissions user have
","optional":null,"defaultvalue":""},{"name":"accountSid","type":{"names":["string"]},"description":"Flex Account SID
","optional":null,"defaultvalue":""},{"name":"accessTokenExpiresAt","type":{"names":["string"]},"description":"timestamp when access token expires
","optional":null,"defaultvalue":""},{"name":"refreshTokenExpiresAt","type":{"names":["string"]},"description":"timestamp when refresh token expires (inactivity expiry)
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef TaskTransfer\n * @property {\"COLD\" | \"WARM\"} mode transfer mode\n * @property {string} sid - The sid of this Transfer\n * @property {\"INITIATED\" | \"FAILED\" | \"COMPLETE\" | \"CANCELED\"} status transfer status\n * @property {string} to - The sid of the Worker or TaskQueue this Transfer is intended for\n * @property {\"QUEUE\" | \"WORKER\"} type - The transfer type\n * @property {string} workerSid - The sid of the initiating Worker\n * @property {IWorker} [worker] - The instance of the initiating Worker\n * @property {IQueue} [queue] - Target queue instance\n * @memberof ITask\n */","name":"TaskTransfer","type":null,"properties":[{"name":"mode","type":{"names":["\"COLD\"","\"WARM\""]},"description":"transfer mode
","optional":null,"defaultvalue":""},{"name":"sid","type":{"names":["string"]},"description":"The sid of this Transfer
","optional":null,"defaultvalue":""},{"name":"status","type":{"names":["\"INITIATED\"","\"FAILED\"","\"COMPLETE\"","\"CANCELED\""]},"description":"transfer status
","optional":null,"defaultvalue":""},{"name":"to","type":{"names":["string"]},"description":"The sid of the Worker or TaskQueue this Transfer is intended for
","optional":null,"defaultvalue":""},{"name":"type","type":{"names":["\"QUEUE\"","\"WORKER\""]},"description":"The transfer type
","optional":null,"defaultvalue":""},{"name":"workerSid","type":{"names":["string"]},"description":"The sid of the initiating Worker
","optional":null,"defaultvalue":""},{"name":"worker","type":{"names":["IWorker"]},"description":"The instance of the initiating Worker
","optional":true,"defaultvalue":""},{"name":"queue","type":{"names":["IQueue"]},"description":"Target queue instance
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Information about the session where the error occured\n *\n * @category Flex Errors\n * @ignore\n * @typedef ErrorDetails\n * @extends {FlexErrorContents}\n * @property {string} message Error message.\n * @property {string} [wrappedError] The original error message.\n * @memberof FlexError\n */","name":"ErrorDetails","type":null,"properties":[{"name":"message","type":{"names":["string"]},"description":"Error message.
","optional":null,"defaultvalue":""},{"name":"wrappedError","type":{"names":["string"]},"description":"The original error message.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Information about the session where the error occured\n *\n * @category Flex Errors\n * @ignore\n * @typedef FlexErrorJSON\n * @property {string} title Normalized title of an error.\n * @property {string} name Raw name of an error.\n * @property {string} message Error message.\n * @property {string} logLine Normalized log line of an error.\n * @property {string} stack Represents stack trace of an error\n * @property {Monitor.ErrorDetails} details Contents more details of an error.\n * @property {string | Monitor.FlexErrorJSON} wrappedError The original error.\n * @property {string} logs Logs around the error.\n * @property {SessionData} sessionData Information about the session where the error occured.\n * @memberof FlexError\n */","name":"FlexErrorJSON","type":null,"properties":[{"name":"title","type":{"names":["string"]},"description":"Normalized title of an error.
","optional":null,"defaultvalue":""},{"name":"name","type":{"names":["string"]},"description":"Raw name of an error.
","optional":null,"defaultvalue":""},{"name":"message","type":{"names":["string"]},"description":"Error message.
","optional":null,"defaultvalue":""},{"name":"logLine","type":{"names":["string"]},"description":"Normalized log line of an error.
","optional":null,"defaultvalue":""},{"name":"stack","type":{"names":["string"]},"description":"Represents stack trace of an error
","optional":null,"defaultvalue":""},{"name":"details","type":{"names":["Monitor.ErrorDetails"]},"description":"Contents more details of an error.
","optional":null,"defaultvalue":""},{"name":"wrappedError","type":{"names":["string","Monitor.FlexErrorJSON"]},"description":"The original error.
","optional":null,"defaultvalue":""},{"name":"logs","type":{"names":["string"]},"description":"Logs around the error.
","optional":null,"defaultvalue":""},{"name":"sessionData","type":{"names":["SessionData"]},"description":"Information about the session where the error occured.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} ProvidersProps\n * @memberof ThemeProvider\n * @property {CustomizationProvider} [PasteThemeProvider] Paste theme provider\n * @property {ComponentWrapperPaste theme provider
","optional":true,"defaultvalue":""},{"name":"CustomProvider","type":{"names":["ComponentWrapperCustom provider component
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Theme configuration\n * @typedef DeprecatedThemeConfigProps\n * @property {PredefinedThemeName} [baseName] predefined theme name to take as base\n * @property {CoreThemeColors | BaseThemeColors} [colors] color overrides to be applied\n * @property {boolean} [light] whether theme is light or not\n * @property {DeepPartialpredefined theme name to take as base
","optional":true,"defaultvalue":""},{"name":"colors","type":{"names":["CoreThemeColors","BaseThemeColors"]},"description":"color overrides to be applied
","optional":true,"defaultvalue":""},{"name":"light","type":{"names":["boolean"]},"description":"whether theme is light or not
","optional":true,"defaultvalue":""},{"name":"overrides","type":{"names":["DeepPartialOverrides for the theme object
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef ThemeConfigProps\n * @memberof Config\n * @property {boolean} [isLight] Represents whether light or dark theme should be used\n * @property {DeepPartialRepresents whether light or dark theme should be used
","optional":true,"defaultvalue":""},{"name":"tokens","type":{"names":["DeepPartialPaste tokens. For more on each token information, please refer to Twilio Paste
","optional":true,"defaultvalue":""},{"name":"componentThemeOverrides","type":{"names":["Theme"]},"description":"Object containing styles of the component which is to be overridden. See Theme Interface
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Extension of the DeviceOptions interface to be used to initialise a Device, with an additional\n * acceptOptions property to be passed as a parameter when calling Call.accept()\n * See parent interface [here](https://www.twilio.com/docs/voice/sdks/javascript/twiliodevice#deviceoptions)\n * @typedef VoiceOptions\n * @property {Call.AcceptOptions} [acceptOptions] options to be passed in call.accept(). [See](https://www.twilio.com/docs/voice/sdks/javascript/twiliocall#callacceptacceptoptions)\n * @property {MediaTrackConstraints} [audioConstraints] options to be passed in device.audio.setAudioConstraints(). [See](https://www.twilio.com/docs/voice/sdks/javascript/twiliodevice/device-audio#deviceaudiosetaudioconstraintsaudioconstraints)\n * @property {string[]} [codecPreferences] codec names to be passed in device.options.codecPreferences. These can optionally use the `Device.Codec` type values from `@twilio/voice-sdk`.\n * @property {Recordoptions to be passed in call.accept(). See
","optional":true,"defaultvalue":""},{"name":"audioConstraints","type":{"names":["MediaTrackConstraints"]},"description":"options to be passed in device.audio.setAudioConstraints(). See
","optional":true,"defaultvalue":""},{"name":"codecPreferences","type":{"names":["Arraycodec names to be passed in device.options.codecPreferences. These can optionally use the Device.Codec type values from @twilio/voice-sdk.
sounds names to be passed in device.options.sounds. These can optionally use the Call.Sounds type values from @twilio/voice-sdk for the object keys.
options to pass to TaskRouter Worker SDK. See
","optional":true,"defaultvalue":""},{"name":"chat","type":{"names":["ConversationsOptions"]},"description":"options to pass to Chat SDK. See
","optional":true,"defaultvalue":""},{"name":"voice","type":{"names":["VoiceOptions"]},"description":"options to pass to Voice SDK. See
","optional":true,"defaultvalue":""},{"name":"insights","type":{"names":["object"]},"description":"options to pass to Sync SDK. See
","optional":true,"defaultvalue":""},{"name":"flex","type":{"names":["DeepPartialto pass to Flex SDK.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Predefined theme name\n * @typedef {\"GreyLight\" | \"GreyDark\" | \"FlexLight\" | \"FlexDark\"} PredefinedThemeName\n */","name":"PredefinedThemeName","type":{"names":["\"GreyLight\"","\"GreyDark\"","\"FlexLight\"","\"FlexDark\""]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Plugin Service interface\n * @typedef PluginService\n * @property {boolean} [enabled] Whether the plugin service is enabled or not\n * @memberof Config\n */","name":"PluginService","type":null,"properties":[{"name":"enabled","type":{"names":["boolean"]},"description":"Whether the plugin service is enabled or not
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Custom plugins interface\n * @typedef {object} CustomPlugins\n * @property {number} phase plugin phase\n * @property {string} name plugin name\n * @property {string} src url where plugin can be found\n * @property {string} [version] plugin version\n */","name":"CustomPlugins","type":{"names":["object"]},"properties":[{"name":"phase","type":{"names":["number"]},"description":"plugin phase
","optional":null,"defaultvalue":""},{"name":"name","type":{"names":["string"]},"description":"plugin name
","optional":null,"defaultvalue":""},{"name":"src","type":{"names":["string"]},"description":"url where plugin can be found
","optional":null,"defaultvalue":""},{"name":"version","type":{"names":["string"]},"description":"plugin version
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Plugin service attributes interface\n * @typedef {object} PluginServiceAttributes\n * @property {string} [custom_plugins_url] url to the plugin JSON\n * @property {CustomPlugins} [custom_plugins] array of plugins\n */","name":"PluginServiceAttributes","type":{"names":["object"]},"properties":[{"name":"custom_plugins_url","type":{"names":["string"]},"description":"url to the plugin JSON
","optional":true,"defaultvalue":""},{"name":"custom_plugins","type":{"names":["CustomPlugins"]},"description":"array of plugins
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} LocationConfig\n * @property {string} name region name\n * @property {Arrayregion name
","optional":null,"defaultvalue":""},{"name":"edge","type":{"names":["Arrayarray of edge names or edge name
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} OutboundConfig\n * @property {object} email Configuration object for outbound email\n * @property {string} email.defaultAddress.address_metadata.from_name The sender name\n * @property {string} email.defaultAddress.coordinates.address The senders email address\n * @property {string} email.defaultSettings.workflow_sid Sid of the workflow to use for task assignment\n * @property {string} email.defaultAddress.queue_sid Sid of the queue to use for task assignment\n * @memberof Config\n */","name":"OutboundConfig","type":{"names":["object"]},"properties":[{"name":"email","type":{"names":["object"]},"description":"Configuration object for outbound email
","optional":null,"defaultvalue":""},{"name":"email.defaultAddress.address_metadata.from_name","type":{"names":["string"]},"description":"The sender name
","optional":null,"defaultvalue":""},{"name":"email.defaultAddress.coordinates.address","type":{"names":["string"]},"description":"The senders email address
","optional":null,"defaultvalue":""},{"name":"email.defaultSettings.workflow_sid","type":{"names":["string"]},"description":"Sid of the workflow to use for task assignment
","optional":null,"defaultvalue":""},{"name":"email.defaultAddress.queue_sid","type":{"names":["string"]},"description":"Sid of the queue to use for task assignment
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} EmailChannelStatus\n * @property {object} status The current provision status\n */","name":"EmailChannelStatus","type":{"names":["object"]},"properties":[{"name":"status","type":{"names":["object"]},"description":"The current provision status
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} InsightsProvisionStatus\n * @property {object} enabled The current provision status\n * @property {object} timeZone The configured time zone\n */","name":"InsightsProvisionStatus","type":{"names":["object"]},"properties":[{"name":"enabled","type":{"names":["object"]},"description":"The current provision status
","optional":null,"defaultvalue":""},{"name":"timeZone","type":{"names":["object"]},"description":"The configured time zone
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} TeamsContextStatus\n * @property {boolean} team_setup_complete The team setup status\n * @since 2.10.0\n */","name":"TeamsContextStatus","type":{"names":["object"]},"properties":[{"name":"team_setup_complete","type":{"names":["boolean"]},"description":"The team setup status
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} ChannelConfig\n * @property {string} addressType Channel type\n * @property {object} cbmAttachments Configuration object for cbm attachment settings\n * @property {boolean} cbmAttachments.enabled Whether attachments are enabled\n * @property {number} cbmAttachments.numberOfAttachments Maximum number of attachments allowed\n * @property {number} cbmAttachments.maxFileSize Maximum allowed file size in bytes\n * @property {number} cbmAttachments.maxTotalFileSize Limit in bytes for the cumulative size of all attachments\n * @property {ArrayChannel type
","optional":null,"defaultvalue":""},{"name":"cbmAttachments","type":{"names":["object"]},"description":"Configuration object for cbm attachment settings
","optional":null,"defaultvalue":""},{"name":"cbmAttachments.enabled","type":{"names":["boolean"]},"description":"Whether attachments are enabled
","optional":null,"defaultvalue":""},{"name":"cbmAttachments.numberOfAttachments","type":{"names":["number"]},"description":"Maximum number of attachments allowed
","optional":null,"defaultvalue":""},{"name":"cbmAttachments.maxFileSize","type":{"names":["number"]},"description":"Maximum allowed file size in bytes
","optional":null,"defaultvalue":""},{"name":"cbmAttachments.maxTotalFileSize","type":{"names":["number"]},"description":"Limit in bytes for the cumulative size of all attachments
","optional":null,"defaultvalue":""},{"name":"cbmAttachments.acceptedExtensions","type":{"names":["ArrayArray of allowed file extensions
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Flex UI's configuration allows you to control the way the overall app loads, as well as the behavior of individual Flex Components.\n * In the configuration object, you can define the default properties of your Flex Components. You can also configure properties that are not tied to specific Components.\n * @typedef {object} Config\n * @category Overview\n * @docname Configuration\n * @menuorder 200\n * @property {string} [language] language code, not used\n * @property {\"silent\" | \"error\" | \"warning\" | \"info\" | \"debug\" | \"trace\"} [logLevel=\"error\"] level for logger\n * @property {ThemeConfigProps} [theme] theme configuration\n * @property {SDKOptions} [sdkOptions] SDK options\n * @property {SSOConfiguration} [sso] SSO configuration\n * @property {OAuthConfiguration} [oauth] OAuth2.0 configuration. Only available if account has set up SSO after using Flex UI >= 2.5.0. [See docs for more info.](https://www.twilio.com/docs/flex/admin-guide/setup/sso-configuration#enhanced-and-legacy-sso-configuration)\n * @property {PluginService} [pluginService] PluginService configuration\n * @property {object} [componentProps] Props to be set for React components. Key of the object is component name. e.g. { AgentDesktopView: { showPanel2: false } }\n * @property {object} [router] Router configuration\n * @property {\"browser\" | \"memory\"} [router.type] type of the router\n * @property {object} [router.history] history object to use for routing\n * @property {boolean} [router.isolate] whether to isolate Flex routing from other routing. Makes Flex to use memory router.\n * @property {boolean} [disableBrowserVoice] whether to disable Twilio Voice SDK instantiation\n * @property {boolean} [initialDeviceCheck] Whether to conduct an initial audio device check\n * @property {boolean} [rejectPendingReservations] whether to reject all pending reservations if user goes to an offline activity\n * @property {object} [insights] insights configuration object\n * @property {boolean} [enableClientCalling] Whether to enable client calling\n * @property {FileAttachmentConfig} [fileAttachment] File attachment configuration\n * @property {string} [holdMusicUrl] url for audio file to play when call is on hold\n * @property {string} [holdMusicMethod] holdMusicMethod\n * @property {Arraylanguage code, not used
","optional":true,"defaultvalue":""},{"name":"logLevel","type":{"names":["\"silent\"","\"error\"","\"warning\"","\"info\"","\"debug\"","\"trace\""]},"description":"level for logger
","optional":true,"defaultvalue":"\"error\""},{"name":"theme","type":{"names":["ThemeConfigProps"]},"description":"theme configuration
","optional":true,"defaultvalue":""},{"name":"sdkOptions","type":{"names":["SDKOptions"]},"description":"SDK options
","optional":true,"defaultvalue":""},{"name":"sso","type":{"names":["SSOConfiguration"]},"description":"SSO configuration
","optional":true,"defaultvalue":""},{"name":"oauth","type":{"names":["OAuthConfiguration"]},"description":"OAuth2.0 configuration. Only available if account has set up SSO after using Flex UI >= 2.5.0. See docs for more info.
","optional":true,"defaultvalue":""},{"name":"pluginService","type":{"names":["PluginService"]},"description":"PluginService configuration
","optional":true,"defaultvalue":""},{"name":"componentProps","type":{"names":["object"]},"description":"Props to be set for React components. Key of the object is component name. e.g. { AgentDesktopView: { showPanel2: false } }
","optional":true,"defaultvalue":""},{"name":"router","type":{"names":["object"]},"description":"Router configuration
","optional":true,"defaultvalue":""},{"name":"router.type","type":{"names":["\"browser\"","\"memory\""]},"description":"type of the router
","optional":true,"defaultvalue":""},{"name":"router.history","type":{"names":["object"]},"description":"history object to use for routing
","optional":true,"defaultvalue":""},{"name":"router.isolate","type":{"names":["boolean"]},"description":"whether to isolate Flex routing from other routing. Makes Flex to use memory router.
","optional":true,"defaultvalue":""},{"name":"disableBrowserVoice","type":{"names":["boolean"]},"description":"whether to disable Twilio Voice SDK instantiation
","optional":true,"defaultvalue":""},{"name":"initialDeviceCheck","type":{"names":["boolean"]},"description":"Whether to conduct an initial audio device check
","optional":true,"defaultvalue":""},{"name":"rejectPendingReservations","type":{"names":["boolean"]},"description":"whether to reject all pending reservations if user goes to an offline activity
","optional":true,"defaultvalue":""},{"name":"insights","type":{"names":["object"]},"description":"insights configuration object
","optional":true,"defaultvalue":""},{"name":"enableClientCalling","type":{"names":["boolean"]},"description":"Whether to enable client calling
","optional":true,"defaultvalue":""},{"name":"fileAttachment","type":{"names":["FileAttachmentConfig"]},"description":"File attachment configuration
","optional":true,"defaultvalue":""},{"name":"holdMusicUrl","type":{"names":["string"]},"description":"url for audio file to play when call is on hold
","optional":true,"defaultvalue":""},{"name":"holdMusicMethod","type":{"names":["string"]},"description":"holdMusicMethod
","optional":true,"defaultvalue":""},{"name":"locations","type":{"names":["Arrayarray of LocationConfig objects
","optional":true,"defaultvalue":""},{"name":"disableTelemetry","type":{"names":["boolean"]},"description":"whether to disable telemetry
","optional":true,"defaultvalue":""},{"name":"enableReduxLogging","type":{"names":["boolean"]},"description":"whether to enable redux logging
","optional":true,"defaultvalue":""},{"name":"markdown","type":{"names":["object"]},"description":"markdown configuration
","optional":true,"defaultvalue":""},{"name":"notifications","type":{"names":["object"]},"description":"Notification configuration
","optional":true,"defaultvalue":""},{"name":"outboundSettings","type":{"names":["OutboundConfig"]},"description":"Outbound configuration
","optional":true,"defaultvalue":""},{"name":"channelConfig","type":{"names":["Arrayarray of channel configurations
","optional":true,"defaultvalue":""},{"name":"flexUiStatusReport","type":{"names":["FlexUiStatusReport"]},"description":"configuration of UI display of status report
","optional":true,"defaultvalue":""},{"name":"debuggerIntegration","type":{"names":["DebuggerIntegration"]},"description":"configuration of debugger integration
","optional":true,"defaultvalue":""},{"name":"isEmailChannelEnabled","type":{"names":["boolean"]},"description":"whether email channel is enabled
","optional":true,"defaultvalue":""},{"name":"citrixVoiceVdi","type":{"names":["citrixVoiceVdi"]},"description":"configuration of Enable Voice on Citrix VDI
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Skill definition\n * @typedef Config.SkillDefinition\n * @property {string} name name of the skill\n * @property {boolean} multivalue whether skill may have a numerical level\n * @property {number} [minimum] maximum value for level\n * @property {number} [maximum] minimum value for level\n * @memberof Config\n * @memberof Configuration\n */","name":"SkillDefinition","type":null,"properties":[{"name":"name","type":{"names":["string"]},"description":"name of the skill
","optional":null,"defaultvalue":""},{"name":"multivalue","type":{"names":["boolean"]},"description":"whether skill may have a numerical level
","optional":null,"defaultvalue":""},{"name":"minimum","type":{"names":["number"]},"description":"maximum value for level
","optional":true,"defaultvalue":""},{"name":"maximum","type":{"names":["number"]},"description":"minimum value for level
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Service configuration\n * @typedef {object} ServiceConfiguration\n * @property {string} account_sid account SID\n * @property {string} chat_service_instance_sid chat service instance SID\n * @property {string} runtime_domain Twilio Runtime Domain\n * @property {string} taskrouter_workspace_sid Task Router Workspace SID for Flex\n * @property {string} taskrouter_target_taskqueue_sid Task Router Task Queue SID\n * @property {string} taskrouter_target_workflow_sid Task Router Workflow SID\n * @property {any} outbound_call_flows Outbound call flows\n * @property {Arrayaccount SID
","optional":null,"defaultvalue":""},{"name":"chat_service_instance_sid","type":{"names":["string"]},"description":"chat service instance SID
","optional":null,"defaultvalue":""},{"name":"runtime_domain","type":{"names":["string"]},"description":"Twilio Runtime Domain
","optional":null,"defaultvalue":""},{"name":"taskrouter_workspace_sid","type":{"names":["string"]},"description":"Task Router Workspace SID for Flex
","optional":null,"defaultvalue":""},{"name":"taskrouter_target_taskqueue_sid","type":{"names":["string"]},"description":"Task Router Task Queue SID
","optional":null,"defaultvalue":""},{"name":"taskrouter_target_workflow_sid","type":{"names":["string"]},"description":"Task Router Workflow SID
","optional":null,"defaultvalue":""},{"name":"outbound_call_flows","type":{"names":["any"]},"description":"Outbound call flows
","optional":null,"defaultvalue":""},{"name":"taskrouter_skills","type":{"names":["Arrayall possible skills that can be assigned
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * SSO Configuration interface\n * @typedef {object} SSOConfiguration\n * @property {string} [accountSid] account SID\n * @property {string} [idpUrl] idpUrl\n * @property {boolean} [loginPopup=false] whether to launch IdP login in a new window\n * @property {string} [loginPopupFeatures] standard window.open() features param to be applied to popup window\n * @property {Arrayaccount SID
","optional":true,"defaultvalue":""},{"name":"idpUrl","type":{"names":["string"]},"description":"idpUrl
","optional":true,"defaultvalue":""},{"name":"loginPopup","type":{"names":["boolean"]},"description":"whether to launch IdP login in a new window
","optional":true,"defaultvalue":"false"},{"name":"loginPopupFeatures","type":{"names":["string"]},"description":"standard window.open() features param to be applied to popup window
","optional":true,"defaultvalue":""},{"name":"products","type":{"names":["Arrayarray of products
","optional":true,"defaultvalue":""},{"name":"redirectUrl","type":{"names":["string"]},"description":"redirect url where to return back from identity provider to log in to Flex
","optional":true,"defaultvalue":"window.location.href"}]}},{"node":{"kind":"typedef","comment":"/**\n * OAuth2.0 Configuration interface\n * @typedef {object} OAuthConfiguration\n * @property {string} clientId client ID for the account\n * @property {string} connection connection name for the account. Referred to as `sso_profile_sid` in some services.\n * @property {boolean} [loginPopup=false] whether to launch OAuth2.0 login in a new window\n * @property {string} [redirectUrl] the url to redirect to after authorization. Used when Flex is self-hosted.\n * @property {string} [accountSid] account SID\n * @memberof Config\n */","name":"OAuthConfiguration","type":{"names":["object"]},"properties":[{"name":"clientId","type":{"names":["string"]},"description":"client ID for the account
","optional":null,"defaultvalue":""},{"name":"connection","type":{"names":["string"]},"description":"connection name for the account. Referred to as sso_profile_sid in some services.
whether to launch OAuth2.0 login in a new window
","optional":true,"defaultvalue":"false"},{"name":"redirectUrl","type":{"names":["string"]},"description":"the url to redirect to after authorization. Used when Flex is self-hosted.
","optional":true,"defaultvalue":""},{"name":"accountSid","type":{"names":["string"]},"description":"account SID
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Root Redux Flex application state\n * @typedef AppState\n * @property {Config} config configuration state\n * @property {SessionState} session session state\n * @property {ChatState} chat chat state\n * @property {WorkerState} worker worker state\n * @property {PhoneState} phone voice call state\n * @property {ViewState} view view state\n * @property {AppStatusState} appStatus app status\n * @property {ConnectionStatus} connectionStatus connection status\n * @property {InsightsState} insights insights state\n * @property {SupervisorState} supervisor supervisor state\n * @property {ConferencesState} conferences conferences state\n * @property {QueuesState} realtimeQueues realtimeQueues\n * @property {FeatureFlagsState} featureFlags featureFlags\n * @property {FlexErrorState} flexErrors flexErrors\n * @property {QualityManagementState} qualityManagement qualityManagement\n * @property {ParticipantState} participants participants state\n * @property {AgentCopilotState} agentCopilot agentCopilot state\n * @category State Management\n */","name":"AppState","type":null,"properties":[{"name":"config","type":{"names":["Config"]},"description":"configuration state
","optional":null,"defaultvalue":""},{"name":"session","type":{"names":["SessionState"]},"description":"session state
","optional":null,"defaultvalue":""},{"name":"chat","type":{"names":["ChatState"]},"description":"chat state
","optional":null,"defaultvalue":""},{"name":"worker","type":{"names":["WorkerState"]},"description":"worker state
","optional":null,"defaultvalue":""},{"name":"phone","type":{"names":["PhoneState"]},"description":"voice call state
","optional":null,"defaultvalue":""},{"name":"view","type":{"names":["ViewState"]},"description":"view state
","optional":null,"defaultvalue":""},{"name":"appStatus","type":{"names":["AppStatusState"]},"description":"app status
","optional":null,"defaultvalue":""},{"name":"connectionStatus","type":{"names":["ConnectionStatus"]},"description":"connection status
","optional":null,"defaultvalue":""},{"name":"insights","type":{"names":["InsightsState"]},"description":"insights state
","optional":null,"defaultvalue":""},{"name":"supervisor","type":{"names":["SupervisorState"]},"description":"supervisor state
","optional":null,"defaultvalue":""},{"name":"conferences","type":{"names":["ConferencesState"]},"description":"conferences state
","optional":null,"defaultvalue":""},{"name":"realtimeQueues","type":{"names":["QueuesState"]},"description":"realtimeQueues
","optional":null,"defaultvalue":""},{"name":"featureFlags","type":{"names":["FeatureFlagsState"]},"description":"featureFlags
","optional":null,"defaultvalue":""},{"name":"flexErrors","type":{"names":["FlexErrorState"]},"description":"flexErrors
","optional":null,"defaultvalue":""},{"name":"qualityManagement","type":{"names":["QualityManagementState"]},"description":"qualityManagement
","optional":null,"defaultvalue":""},{"name":"participants","type":{"names":["ParticipantState"]},"description":"participants state
","optional":null,"defaultvalue":""},{"name":"agentCopilot","type":{"names":["AgentCopilotState"]},"description":"agentCopilot state
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Conference type\n * @typedef Conference\n * @property {string} sid SID of the task\n * @property {ConferenceStatus} status status of the conference\n * @property {string} conferenceSid SID of the conference\n * @property {ArraySID of the task
","optional":null,"defaultvalue":""},{"name":"status","type":{"names":["ConferenceStatus"]},"description":"status of the conference
","optional":null,"defaultvalue":""},{"name":"conferenceSid","type":{"names":["string"]},"description":"SID of the conference
","optional":null,"defaultvalue":""},{"name":"participants","type":{"names":["Arrayparticipants in the conference, including the ones who have left
","optional":null,"defaultvalue":""},{"name":"liveParticipantCount","type":{"names":["number"]},"description":"count of currently live participants
","optional":null,"defaultvalue":""},{"name":"liveWorkerCount","type":{"names":["number"]},"description":"count of currently live workers
","optional":null,"defaultvalue":""},{"name":"liveWorkers","type":{"names":["Arrayactive worker participants in the conference
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Conference participant\n *\n * @typedef ConferenceParticipant\n * @property {IQueue} [queue] queue associated with the participant (in case of transfer to queue)\n * @property {IWorker} [worker] worker associated with the participant\n * @property {string} callSid call SID associated with the voice connection of the participant\n * @property {boolean} isCurrentWorker is participant associated with the currently logged in user\n * @property {boolean} onHold is participant on hold\n * @property {boolean} muted is participant muted\n * @property {boolean} connecting is participant in connecting state\n * @property {ParticipantStatus} status status of the participant\n * @property {ChannelParticipantType} participantType type of the participant\n * @property {string} reservationSid reservation SID for the participant\n * @property {string} workerSid SID of the worker\n * @property {string} participantSid SID of the participant if external\n * @property {string} phoneNumber Phone number of the participant if external\n * @memberof ConferencesState\n */","name":"ConferenceParticipant","type":null,"properties":[{"name":"queue","type":{"names":["IQueue"]},"description":"queue associated with the participant (in case of transfer to queue)
","optional":true,"defaultvalue":""},{"name":"worker","type":{"names":["IWorker"]},"description":"worker associated with the participant
","optional":true,"defaultvalue":""},{"name":"callSid","type":{"names":["string"]},"description":"call SID associated with the voice connection of the participant
","optional":null,"defaultvalue":""},{"name":"isCurrentWorker","type":{"names":["boolean"]},"description":"is participant associated with the currently logged in user
","optional":null,"defaultvalue":""},{"name":"onHold","type":{"names":["boolean"]},"description":"is participant on hold
","optional":null,"defaultvalue":""},{"name":"muted","type":{"names":["boolean"]},"description":"is participant muted
","optional":null,"defaultvalue":""},{"name":"connecting","type":{"names":["boolean"]},"description":"is participant in connecting state
","optional":null,"defaultvalue":""},{"name":"status","type":{"names":["ParticipantStatus"]},"description":"status of the participant
","optional":null,"defaultvalue":""},{"name":"participantType","type":{"names":["ChannelParticipantType"]},"description":"type of the participant
","optional":null,"defaultvalue":""},{"name":"reservationSid","type":{"names":["string"]},"description":"reservation SID for the participant
","optional":null,"defaultvalue":""},{"name":"workerSid","type":{"names":["string"]},"description":"SID of the worker
","optional":null,"defaultvalue":""},{"name":"participantSid","type":{"names":["string"]},"description":"SID of the participant if external
","optional":null,"defaultvalue":""},{"name":"phoneNumber","type":{"names":["string"]},"description":"Phone number of the participant if external
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Conference state\n *\n * @typedef ConferencesState.ConferenceState\n * @property {ConferencesState.Conference} source source object of the conference\n * @category State\n */","name":"ConferenceState","type":null,"properties":[{"name":"source","type":{"names":["ConferencesState.Conference"]},"description":"source object of the conference
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Participant type\n *\n * @typedef {\"worker\" | \"customer\" | \"transfer\" | \"supervisor\" | \"\"} ParticipantType\n * @memberof ConferencesState\n */","name":"ParticipantType","type":{"names":["\"worker\"","\"customer\"","\"transfer\"","\"supervisor\"","\"\""]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Participant status\n *\n * @typedef {\"left\" | \"joined\" | \"recently_left\"} ParticipantStatus\n * @memberof ConferencesState\n */","name":"ParticipantStatus","type":{"names":["\"left\"","\"joined\"","\"recently_left\""]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Conference status\n *\n * @typedef {\"left\" | \"joined\" | \"recently_left\"} ConferenceStatus\n * @memberof ConferencesState\n */","name":"ConferenceStatus","type":{"names":["\"left\"","\"joined\"","\"recently_left\""]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} FlexErrorState\n * @property {ArrayFlex errors
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Insights State\n *\n * @typedef InsightsState\n * @property {object} segmentsById - Dictionary of segments with the segmentId as the key\n * @property {number} [selectedMediaLink] - selected media link\n * @property {ArrayDictionary of segments with the segmentId as the key
","optional":null,"defaultvalue":""},{"name":"selectedMediaLink","type":{"names":["number"]},"description":"selected media link
","optional":true,"defaultvalue":""},{"name":"questionnaires","type":{"names":["Arrayarray of questionnaires
","optional":null,"defaultvalue":""},{"name":"assessments","type":{"names":["object"]},"description":"Dictionary of array of assessments with the segmentId as the key
","optional":null,"defaultvalue":""},{"name":"comments","type":{"names":["object"]},"description":"comments
","optional":null,"defaultvalue":""},{"name":"assessmentSettings","type":{"names":["IAssessmentSettings"]},"description":"assessmentSettings
","optional":null,"defaultvalue":""},{"name":"findingsBySegment","type":{"names":["object"]},"description":"findings by segment
","optional":null,"defaultvalue":""},{"name":"segmentId","type":{"names":["string","undefined"]},"description":"segmentId
","optional":null,"defaultvalue":""},{"name":"insightsProjectDashboards","type":{"names":["object"]},"description":"insights project dashboards
","optional":null,"defaultvalue":""},{"name":"insightsDashboardCategory","type":{"names":["object"]},"description":"insights dashboard category
","optional":null,"defaultvalue":""},{"name":"drillableItemsByDashboard","type":{"names":["object"]},"description":"drillable items by dashboard
","optional":null,"defaultvalue":""},{"name":"drillableItemsAttributes","type":{"names":["Arrayglobal drillable attributes
","optional":null,"defaultvalue":""},{"name":"profileInfo","type":{"names":["object"]},"description":"profile info
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Voice connection state\n * @deprecated\n * @deprecatedSince 2.0.0\n * @altRecommendation Use `getCurrentPhoneCallState` to access source connection (call) object\n * @altRecommendationExample\n * import { Flex } from \"@twilio/flex-ui\";\n * const activeCallState = Flex.StateHelper.getCurrentPhoneCallState;\n * @altRecommendationLink https://assets.flex.twilio.com/docs/releases/flex-ui/latest/advanced/state-management/StateHelper/#getcurrentphonecallstate-call\n * @ignore\n * @typedef PhoneCallState\n * @property {Call} source Source call object. [See](https://www.twilio.com/docs/voice/sdks/javascript/twiliocall)\n * @memberof PhoneState\n */","name":"PhoneCallState","type":null,"properties":[{"name":"source","type":{"names":["Call"]},"description":"Source call object. See
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef ActivityStatistic\n * @memberof Queue\n * @property {string} sid Activity sid\n * @property {number} workers Total number of workers\n * @property {string} friendly_name Friendly name\n * @property {number} available_workers Number of available workers\n */","name":"ActivityStatistic","type":null,"properties":[{"name":"sid","type":{"names":["string"]},"description":"Activity sid
","optional":null,"defaultvalue":""},{"name":"workers","type":{"names":["number"]},"description":"Total number of workers
","optional":null,"defaultvalue":""},{"name":"friendly_name","type":{"names":["string"]},"description":"Friendly name
","optional":null,"defaultvalue":""},{"name":"available_workers","type":{"names":["number"]},"description":"Number of available workers
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef WorkerQueue\n * @memberof QueuesStats\n * @property {string} friendly_name friendly name\n * @property {string} key unique key\n * @property {number} total_available_workers total available workers\n * @property {number} total_eligible_workers total eligible workers\n * @property {Arrayfriendly name
","optional":null,"defaultvalue":""},{"name":"key","type":{"names":["string"]},"description":"unique key
","optional":null,"defaultvalue":""},{"name":"total_available_workers","type":{"names":["number"]},"description":"total available workers
","optional":null,"defaultvalue":""},{"name":"total_eligible_workers","type":{"names":["number"]},"description":"total eligible workers
","optional":null,"defaultvalue":""},{"name":"activity_statistics","type":{"names":["Arrayactivity statistics
","optional":null,"defaultvalue":""},{"name":"tasks_by_priority","type":{"names":["Recordtasks by priority
","optional":null,"defaultvalue":""},{"name":"tasks_by_status","type":{"names":["Object"]},"description":"tasks by status
","optional":null,"defaultvalue":""},{"name":"total_tasks","type":{"names":["number"]},"description":"total tasks
","optional":null,"defaultvalue":""},{"name":"longest_task_waiting_sid","type":{"names":["string","null"]},"description":"longest task waiting sid
","optional":null,"defaultvalue":""},{"name":"longest_task_waiting_from","type":{"names":["string","null"]},"description":"longest task waiting from
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * An alias for a function used as a parameter for {@link QueuesStats.setFilter}.\n *(queue: [WorkerQueue]{@link QueuesStats.WorkerQueue}) => boolean\n * @typedef QueuesFilterFunction\n * @memberof QueuesStats\n */","name":"QueuesFilterFunction","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * State of a worker\n * @typedef SupervisorWorkerState\n * @property {IWorker} worker worker instance\n * @property {Arrayworker instance
","optional":null,"defaultvalue":""},{"name":"tasks","type":{"names":["Arraytasks of the worker
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Call monitoring state\n *\n * @typedef CallMonitoring\n * @property {CallMonitoringStatus} status status of the monitor call\n * @property {ITask} [task] Monitored task\n * @property {Arraystatus of the monitor call
","optional":null,"defaultvalue":""},{"name":"task","type":{"names":["ITask"]},"description":"Monitored task
","optional":true,"defaultvalue":""},{"name":"workers","type":{"names":["ArrayList of the participating the call
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Active filter\n *\n * @typedef TeamsView.AppliedFilter\n * @property {string} name name of the field to filter against\n * @property {FilterConditions} condition condition to use for the filter\n * @property {Arrayname of the field to filter against
","optional":null,"defaultvalue":""},{"name":"condition","type":{"names":["FilterConditions"]},"description":"condition to use for the filter
","optional":null,"defaultvalue":""},{"name":"values","type":{"names":["Arrayvalue or an array of values to filter
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {Store} EnhancedStore\n * @property {Function} [addReducer] - Function used to add reducer to an already created store.\n * @memberof Store\n */","name":"EnhancedStore","type":{"names":["Store"]},"properties":[{"name":"addReducer","type":{"names":["function"]},"description":"Function used to add reducer to an already created store.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * The arguments that make up the old createChatTaskChannel() signature,\n * with `name` property omitted. This type array ensures that arguments are\n * of correct types when TaskChannelConfiguration is not used in the signature.\n * @typedef ChatTaskChannelArgs\n */","name":"ChatTaskChannelArgs","type":null,"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @typedef {object} ThemeColorsDefinition\n * @property {boolean} isLight If the definition is light themed\n * @memberof ThemeColorsDefinitionCreator\n */","name":"ThemeColorsDefinition","type":{"names":["object"]},"properties":[{"name":"isLight","type":{"names":["boolean"]},"description":"If the definition is light themed
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef ActionFunction\n * @callback ActionFunction\n * @param {ActionsManager.ActionPayload} payload action payload\n * @returns {Promiseaction code
","optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["ActionsManager.ActionPayload"]},"description":"action payload
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Actions with payload\n * @typedef {object} ActionsWithPayload\n * @property {ActionsManager.ActionWithPayload} [first] first action with payload\n * @property {ActionsManager.ActionPayload} [ACTION_CODE] action payload by action code in key\n * @memberof ActionsManager\n */","name":"ActionsWithPayload","type":{"names":["object"]},"properties":[{"name":"first","type":{"names":["ActionsManager.ActionWithPayload"]},"description":"first action with payload
","optional":true,"defaultvalue":""},{"name":"ACTION_CODE","type":{"names":["ActionsManager.ActionPayload"]},"description":"action payload by action code in key
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Action payload\n * @typedef {any} ActionPayload\n * @memberof ActionsManager\n */","name":"ActionPayload","type":{"names":["any"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Action name\n * @typedef {string} ActionName\n * @memberof ActionsManager\n */","name":"ActionName","type":{"names":["string"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Predicate to match action by payload\n * @typedef MatchActionPayloadPredicate\n * @callback MatchActionPayloadPredicate\n * @param {ActionsManager.ActionPayload} payload action payload\n * @param {string} action action code\n * @returns {boolean} true if payload is matched\n * @memberof ActionsManager\n */","name":"MatchActionPayloadPredicate","type":{"names":["function"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Action payload or predicate to match\n * @typedef {(ActionsManager.MatchActionPayloadPredicate | ActionsManager.ActionPayload)} MatchActionPayload\n * @memberof ActionsManager\n */","name":"MatchActionPayload","type":{"names":["ActionsManager.MatchActionPayloadPredicate","ActionsManager.ActionPayload"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Audio Player error. This is the error type that you receive when the {@link import(\"./AudioPlayerManager\").ErrorHandler ErrorHandler function} is invoked\n *\n * @readonly\n * @typedef {object} Error\n * @extends Error\n * @property {AudioErrorCode} code - Error code\n * @memberof { import(\"./AudioPlayerManager\").AudioPlayerManager }\n */","name":"Error","type":{"names":["object"]},"properties":[{"name":"code","type":{"names":["AudioErrorCode"]},"description":"Error code
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Defines the type of the error callback function. Invoked when `play` method returns an error.\n *\n * @typedef {Function} ErrorHandler\n * @param {AudioPlayerManager.Error} error Audio Player error.\n * @returns {void}\n * @memberof AudioPlayerManager\n */","name":"ErrorHandler","type":{"names":["function"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Media data to be played.\n *\n * @typedef {object} MediaData\n * @property {string} url - URL of the media.\n * @property {boolean} repeatable - Whether the media should repeat or not.\n * @memberof AudioPlayerManager\n */","name":"MediaData","type":{"names":["object"]},"properties":[{"name":"url","type":{"names":["string"]},"description":"URL of the media.
","optional":null,"defaultvalue":""},{"name":"repeatable","type":{"names":["boolean"]},"description":"Whether the media should repeat or not.
","optional":null,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef ContentFragmentConditionFunction\n * @callback ContentFragmentConditionFunction\n * @param {object} props props T of the Component that includes the static prop named Content of type [DynamicContentStore](DynamicContentStore)function that returns whether the component should be removed or not.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Alignment of the fragment\n *\n * @typedef {\"start\" | \"end\"} ContentFragmentAlignment\n * @memberof DynamicContentStore\n */","name":"ContentFragmentAlignment","type":{"names":["\"start\"","\"end\""]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Props of content fragment\n *\n * @typedef ContentFragmentProps\n * @property {ContentFragmentAlignment} [align] - fragment alignment\n * @property {boolean} [replace] - whether the fragment should replace an existing one or not. Always set to true when calling `replace` method from [DynamicContentStore](DynamicContentStore#replace-child-options-cleanupfunction).\n * @property {number} [sortOrder] - index in which to position the fragment within the component.\n * @property {ContentFragmentConditionFunction} [if] - function that returns whether the content fragment should be added or replaced.\n * @property {boolean} [noChildProps] - whether the fragment should be rendered with props that other siblings was rendered with\n * @memberof DynamicContentStore\n */","name":"ContentFragmentProps","type":null,"properties":[{"name":"align","type":{"names":["ContentFragmentAlignment"]},"description":"fragment alignment
","optional":true,"defaultvalue":""},{"name":"replace","type":{"names":["boolean"]},"description":"whether the fragment should replace an existing one or not. Always set to true when calling replace method from DynamicContentStore.
index in which to position the fragment within the component.
","optional":true,"defaultvalue":""},{"name":"if","type":{"names":["ContentFragmentConditionFunction"]},"description":"function that returns whether the content fragment should be added or replaced.
","optional":true,"defaultvalue":""},{"name":"noChildProps","type":{"names":["boolean"]},"description":"whether the fragment should be rendered with props that other siblings was rendered with
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef CleanupFunction\n * @callback CleanupFunction\n * @returns {void}\n * @memberof DynamicContentStore\n */","name":"CleanupFunction","type":{"names":["function"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * Notification options for the browser notification handler\n *\n * @typedef {object} BrowserNotificationOptions\n * @property {string} [title] Notification heading\n * @property {string} [body] Notification content\n * @property {Function} [onClick] onclick event handler function\n * @property {Function} [onClose] onClose event handler function\n * @property {Function} [onShow] onShow event handler function\n * @property {Function} [onError] onError event handler function\n * @property {object} [options] The Notification options object from the JS Notifications API\n * @memberof NotificationManager\n */","name":"BrowserNotificationOptions","type":{"names":["object"]},"properties":[{"name":"title","type":{"names":["string"]},"description":"Notification heading
","optional":true,"defaultvalue":""},{"name":"body","type":{"names":["string"]},"description":"Notification content
","optional":true,"defaultvalue":""},{"name":"onClick","type":{"names":["function"]},"description":"onclick event handler function
","optional":true,"defaultvalue":""},{"name":"onClose","type":{"names":["function"]},"description":"onClose event handler function
","optional":true,"defaultvalue":""},{"name":"onShow","type":{"names":["function"]},"description":"onShow event handler function
","optional":true,"defaultvalue":""},{"name":"onError","type":{"names":["function"]},"description":"onError event handler function
","optional":true,"defaultvalue":""},{"name":"options","type":{"names":["object"]},"description":"The Notification options object from the JS Notifications API
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Properties of the Notification.\n * @typedef NotificationContentProps\n * @property {object} [notificationContext] - A optional context for the Notification.\n * @memberof NotificationManager\n */","name":"NotificationContentProps","type":null,"properties":[{"name":"notificationContext","type":{"names":["object"]},"description":"A optional context for the Notification.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * Notification options for handlers.\n * @typedef NotificationOptions\n * @property {BrowserNotificationOptions} browser - Browser notification options.\n * @property {string} [target] - Name of target component.\n * @memberof NotificationManager\n */","name":"NotificationOptions","type":null,"properties":[{"name":"browser","type":{"names":["BrowserNotificationOptions"]},"description":"Browser notification options.
","optional":null,"defaultvalue":""},{"name":"target","type":{"names":["string"]},"description":"Name of target component.
","optional":true,"defaultvalue":""}]}},{"node":{"kind":"typedef","comment":"/**\n * @typedef NotificationClickFunction\n * @callback NotificationClickFunction\n * @param {any} event Click event.\n * @returns {void}\n * @memberof NotificationManager\n */","name":"NotificationClickFunction","type":{"names":["function"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @typedef NotificationIsApplicableFunction\n * @callback NotificationIsApplicableFunction\n * @param {NotificationManager.Notification} notificationInstance Instance of notification to be shown.\n * @returns {boolean} Determines whether particular instance should be shown.\n * @memberof NotificationManager\n */","name":"NotificationIsApplicableFunction","type":{"names":["function"]},"properties":null}},{"node":{"kind":"typedef","comment":"/**\n * @typedef Notification\n * @property {string} id - The id for the notification.\n * @property {string} instanceId - The id for the shown instance of this notification. Not assignable: generated automatically for an active notification in showNotification.\n * @property {React.ReactText | React.ReactElement