{ "componentChunkName": "component---src-templates-api-template-tsx", "path": "/ui-actions/Actions/", "result": {"data":{"entityQuery":{"nodes":[{"name":"Actions","docName":null,"properties":[],"description":"

Predefined UI actions

","classdesc":null,"examples":null},{"name":"Actions","docName":null,"properties":[],"description":"

Dynamic content properties for action buttons container

","classdesc":null,"examples":null},{"name":"Actions","docName":null,"properties":null,"description":"

A singleton instance of Actions manager

","classdesc":null,"examples":null},{"name":"Actions","docName":null,"properties":null,"description":null,"classdesc":null,"examples":null}]},"membersQuery":{"nodes":[{"name":"StartOutboundCallPayload","docName":null,"longname":"Actions.StartOutboundCallPayload","description":null,"defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"StartOutboundCall","docName":null,"longname":"Actions.StartOutboundCall","description":"

Start outbound call

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"StartOutboundCall\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.StartOutboundCallPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.destination","type":{"names":["string"]},"description":"

destination phone number to make outbound call.

","optional":null,"defaultvalue":""},{"name":"payload.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":"payload.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":"payload.taskAttributes","type":{"names":["object"]},"description":"

custom attributes to set on Task. For Example - Bring your own Carrier SID (byocSid).

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\n\n// Basic outbound call\nActions.invokeAction(\"StartOutboundCall\", {\n destination: \"+12345678910\",\n queueSid: \"WQXXXXXXXXXXXXXXXXX\"\n});\n\n// Outbound call with BYOC (Bring Your Own Carrier)\nActions.invokeAction(\"StartOutboundCall\", {\n destination: \"+12345678910\",\n taskAttributes: {\n byocSid: \"BYXXXXXXXXXXXXXXXXX\"\n }\n});"]},{"name":"ToggleOutboundDialer","docName":null,"longname":"Actions.ToggleOutboundDialer","description":"

Toggles visibility of outbound dialer panel.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"ToggleOutboundDialer\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"ToggleOutboundDialer\");"]},{"name":"LeaveChannelPayload","docName":null,"longname":"Actions.LeaveChannelPayload","description":null,"defaultvalue":null,"type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"channelSid","type":{"names":["string"]},"description":"

The associated channelSid

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"PauseChannelPayload","docName":null,"longname":"Actions.PauseChannelPayload","description":null,"defaultvalue":null,"type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"channelSid","type":{"names":["string"]},"description":"

The associated channelSid

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ResumeChannelPayload","docName":null,"longname":"Actions.ResumeChannelPayload","description":null,"defaultvalue":null,"type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"channelSid","type":{"names":["string"]},"description":"

The associated channelSid

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"SelectPausedConversationPayload","docName":null,"longname":"Actions.SelectPausedConversationPayload","description":null,"defaultvalue":null,"type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"sid","type":{"names":["string"]},"description":"

The associated conversationSid

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"LeaveChannel","docName":null,"longname":"Actions.LeaveChannel","description":"

Leave a conversation channel

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"LeaveChannel\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.LeaveChannelPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.channelSid","type":{"names":["string"]},"description":"

The associated channelSid

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"LeaveChannel\", {\n channelSid: UOXXXXXXXXXXXXXXXXX\n});"]},{"name":"PauseChannel","docName":null,"longname":"Actions.PauseChannel","description":"

Pause a conversation channel

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"PauseChannel\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.PauseChannelPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.channelSid","type":{"names":["string"]},"description":"

The associated channelSid

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"PauseChannel\", {\n channelSid: UOXXXXXXXXXXXXXXXXX\n});"]},{"name":"ResumeChannel","docName":null,"longname":"Actions.ResumeChannel","description":"

Resume a conversation channel

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"ResumeChannel\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ResumeChannelPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.channelSid","type":{"names":["string"]},"description":"

The associated channelSid

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"ResumeChannel\", {\n channelSid: UOXXXXXXXXXXXXXXXXX\n});"]},{"name":"GetPausedChannels","docName":null,"longname":"Actions.GetPausedChannels","description":"

Get all Paused conversation channels

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"GetPausedChannels\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"GetPausedChannels\");"]},{"name":"GetPausedEmailConversations","docName":null,"longname":"Actions.GetPausedEmailConversations","description":"

Pause an email conversation

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"GetPausedEmailConversations\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"GetPausedEmailConversations\");"]},{"name":"SelectPausedConversation","docName":null,"longname":"Actions.SelectPausedConversation","description":"

Select a pause Conversation in Agent UI. Deselect a current task if any selected and select the conversation.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SelectPausedConversation\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"SelectPausedConversation\", { sid: \"UOXXXXXXXXXXXXXXXXX\" });"]},{"name":"SelectViewPayload","docName":null,"longname":"Actions.SelectViewPayload","description":null,"defaultvalue":null,"type":{"names":["object"]},"properties":[{"name":"viewName","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ToggleSidebarPayload","docName":null,"longname":"Actions.ToggleSidebarPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"open","type":{"names":["boolean"]},"description":null,"optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"SetComponentStatePayload","docName":null,"longname":"Actions.SetComponentStatePayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":""},{"name":"state","type":{"names":["any"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ReloadWindowPayload","docName":null,"longname":"Actions.ReloadWindowPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"forceLogin","type":{"names":["boolean"]},"description":null,"optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"NavigateToView","docName":null,"longname":"Actions.NavigateToView","description":"

Navigate to a view defined by the provided view name

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"NavigateToView\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.SelectViewPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.viewName","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Use that action to go to view \nActions.invokeAction(\"NavigateToView\", {viewName: \"my-custom-page\"});"]},{"name":"HistoryPush","docName":null,"longname":"Actions.HistoryPush","description":"

Add a history entry, leading to view change or redirect

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"HistoryPush\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"location","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Use that action to change current location \nimport { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"HistoryPush\", \"/teams/\");"]},{"name":"HistoryReplace","docName":null,"longname":"Actions.HistoryReplace","description":"

Replace the current location in history

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"HistoryReplace\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"location","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Use that action to replace current location \nimport { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"HistoryReplace\", \"/teams/\");"]},{"name":"HistoryGo","docName":null,"longname":"Actions.HistoryGo","description":"

Move backwards or forwards a relative number of locations in history

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"HistoryGo\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"location","type":{"names":["number"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Use that action to move between existing locations in history \nimport { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"HistoryGo\", -1);"]},{"name":"HistoryGoBack","docName":null,"longname":"Actions.HistoryGoBack","description":"

Move backward one location in history

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"HistoryGoBack\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Use that action to move backward one location in history \nimport { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"HistoryGoBack\");"]},{"name":"HistoryGoForward","docName":null,"longname":"Actions.HistoryGoForward","description":"

Move forward one location in history

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"HistoryGoForward\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Use that action to move forward one location in history \nimport { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"HistoryGoForward\");"]},{"name":"ShowDirectory","docName":null,"longname":"Actions.ShowDirectory","description":"

Display workers directory at the agent desktop view

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"ShowDirectory\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"ShowDirectory\");"]},{"name":"HideDirectory","docName":null,"longname":"Actions.HideDirectory","description":"

Hide workers directory at the agent desktop view

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"HideDirectory\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"HideDirectory\");"]},{"name":"ToggleSidebar","docName":null,"longname":"Actions.ToggleSidebar","description":"

Open or close the sidebar

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"ToggleSidebar\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ToggleSidebarPayload"]},"description":null,"optional":true,"defaultvalue":""},{"name":"payload.open","type":{"names":["boolean"]},"description":null,"optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Open the sidebar\nimport { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"ToggleSidebar\", {open: true});"]},{"name":"SetComponentState","docName":null,"longname":"Actions.SetComponentState","description":"

Alters the current state of a component

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SetComponentState\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.SetComponentStatePayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.name","type":{"names":["string"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.state","type":{"names":["any"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"SetComponentState\", { name: \"AgentTaskCanvasTabs\", state: { selectedTabName: \"info\" } });"]},{"name":"ReloadWindow","docName":null,"longname":"Actions.ReloadWindow","description":"

Reload window

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"ReloadWindow\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ReloadWindowPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.forceLogin","type":{"names":["boolean"]},"description":null,"optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"ReloadWindow\", { forceLogin: true });"]},{"name":"SelectWorkerInSupervisorPayload","docName":null,"longname":"Actions.SelectWorkerInSupervisorPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"worker","type":{"names":["IWorker"]},"description":"

worker

","optional":true,"defaultvalue":""},{"name":"workerSid","type":{"names":["string"]},"description":"

workerSid

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"TaskInSupervisorPayload","docName":null,"longname":"Actions.TaskInSupervisorPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"task","type":{"names":["ITask"]},"description":"

task

","optional":true,"defaultvalue":""},{"name":"sid","type":{"names":["string"]},"description":"

taskSid

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"MonitorTaskPayload","docName":null,"longname":"Actions.MonitorTaskPayload","description":null,"defaultvalue":null,"type":{"names":["TaskInSupervisorPayload"]},"properties":[{"name":"extraParams","type":{"names":["any"]},"description":"

extra params

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ApplyTeamsViewFiltersPayload","docName":null,"longname":"Actions.ApplyTeamsViewFiltersPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"filters","type":{"names":["Array"]},"description":"

array of filters to apply

","optional":null,"defaultvalue":""},{"name":"extraFilterQuery","type":{"names":["string"]},"description":"

query string for custom filters

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ApplyTeamsViewSearchPayload","docName":null,"longname":"Actions.ApplyTeamsViewSearchPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"search","type":{"names":["string"]},"description":"

search string

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"MonitorCall","docName":null,"longname":"Actions.MonitorCall","description":"

Monitor a provided ongoing call of another agent

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"MonitorCall\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.TaskInSupervisorPayload","Actions.MonitorTaskPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

task

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

taskSid

","optional":true,"defaultvalue":""},{"name":"payload.extraParams","type":{"names":["any"]},"description":"

extra params

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"MonitorCall\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"StopMonitoringCall","docName":null,"longname":"Actions.StopMonitoringCall","description":"

Stop monitoring a call

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"StopMonitoringCall\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.TaskInSupervisorPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

task

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

taskSid

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"StopMonitoringCall\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"SelectTaskInSupervisor","docName":null,"longname":"Actions.SelectTaskInSupervisor","description":"

Select a task in Supervisor UI. Deselect a current task if provided task is undefined.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SelectTaskInSupervisor\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.TaskInSupervisorPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

task

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

taskSid

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"SelectTaskInSupervisor\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"SelectWorkerInSupervisor","docName":null,"longname":"Actions.SelectWorkerInSupervisor","description":"

Select an agent in Supervisor UI. Deselect a current worker if worker is undefined.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SelectTaskInSupervisor\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.SelectWorkerInSupervisorPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.worker","type":{"names":["IWorker"]},"description":"

worker

","optional":true,"defaultvalue":""},{"name":"payload.workerSid","type":{"names":["string"]},"description":"

workerSid

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"SelectWorkerInSupervisor\", { workerSid: \"WKXXXXXXXXXXXXXXXXX\" });"]},{"name":"ApplyTeamsViewFilters","docName":null,"longname":"Actions.ApplyTeamsViewFilters","description":"

Apply filters to Teams view

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"ApplyTeamsViewFilters\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ApplyTeamsViewFiltersPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.filters","type":{"names":["Array"]},"description":"

array of filters to apply

","optional":null,"defaultvalue":""},{"name":"payload.extraFilterQuery","type":{"names":["string"]},"description":"

query string for custom filters

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"ApplyTeamsViewFilters\", {\n filters: [\n {\n name: \"data.activity\",\n condition: FilterConditions.IN,\n values: [\"Idle\"]\n }\n ]\n});"]},{"name":"ApplyTeamsViewSearch","docName":null,"longname":"Actions.ApplyTeamsViewSearch","description":"

Search Teams view agents

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"ApplyTeamsViewSearch\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ApplyTeamsViewSearchPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.search","type":{"names":["string"]},"description":"

search string

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"ApplyTeamsViewSearch\", {\n search: \"John Smith\"\n});"]},{"name":"VoiceActionPayload","docName":null,"longname":"Actions.VoiceActionPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"task","type":{"names":["ITask"]},"description":"

Task

","optional":true,"defaultvalue":""},{"name":"sid","type":{"names":["string"]},"description":"

taskSid

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"HoldCallActionPayload","docName":null,"longname":"Actions.HoldCallActionPayload","description":"

Hold Call Action Payload

","defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"UnholdCallActionPayload","docName":null,"longname":"Actions.UnholdCallActionPayload","description":"

Unhold Call Action Payload

","defaultvalue":null,"type":null,"properties":[{"name":"participantCallSid","type":{"names":["string"]},"description":"

Sid of the participant within the call

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ToggleMute","docName":null,"longname":"Actions.ToggleMute","description":"

Mute current call (if there is one).

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"ToggleMute\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"ToggleMute\");"]},{"name":"HangupCall","docName":null,"longname":"Actions.HangupCall","description":"

Hang up current call (if there is one).

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"HangupCall\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.VoiceActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

Task

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

taskSid

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"HangupCall\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"EndCall","docName":null,"longname":"Actions.EndCall","description":"

Hang up current call (if there is one).

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"EndConferenceForAll\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.VoiceActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

Task

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

taskSid

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"EndConferenceForAll\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"HoldCall","docName":null,"longname":"Actions.HoldCall","description":"

Hold current call (if there is one).

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"HoldCall\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.VoiceActionPayload","Actions.HoldCallActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

Task

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

taskSid

","optional":true,"defaultvalue":""},{"name":"payload.participantCallSid","type":{"names":["string"]},"description":"

Sid of the participant within the call

","optional":true,"defaultvalue":""},{"name":"payload.holdMusicUrl","type":{"names":["string"]},"description":"

Request URL to fetch the hold music from

","optional":true,"defaultvalue":""},{"name":"payload.holdMusicMethod","type":{"names":["string"]},"description":"

Request method to fetch the hold music with

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"HoldCall\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"UnholdCall","docName":null,"longname":"Actions.UnholdCall","description":"

Unhold current call (if there is one).

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"UnholdCall\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.VoiceActionPayload","Actions.UnholdCallActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

Task

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

taskSid

","optional":true,"defaultvalue":""},{"name":"payload.participantCallSid","type":{"names":["string"]},"description":"

Sid of the participant within the call

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"UnholdCall\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"StartExternalWarmTransfer","docName":null,"longname":"Actions.StartExternalWarmTransfer","description":"

Unhold current call (if there is one).

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"StartExternalWarmTransfer\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.VoiceActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

Task

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

taskSid

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"StartExternalWarmTransfer\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"WorkerActionPayload","docName":null,"longname":"Actions.WorkerActionPayload","description":null,"defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"TransferTaskPayload","docName":null,"longname":"Actions.TransferTaskPayload","description":null,"defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"WorkerParticipantActionPayload","docName":null,"longname":"Actions.WorkerParticipantActionPayload","description":null,"defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"WorkerSetActivityPayload","docName":null,"longname":"Actions.WorkerSetActivityPayload","description":null,"defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"WorkerLogoutPayload","docName":null,"longname":"Actions.WorkerLogoutPayload","description":null,"defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"WorkerAcceptTaskActionPayload","docName":null,"longname":"Actions.WorkerAcceptTaskActionPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"conferenceOptions","type":{"names":["any"]},"description":"

conferenceOptions

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ToggleDTMFDialpadPayload","docName":null,"longname":"Actions.ToggleDTMFDialpadPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"open","type":{"names":["boolean"]},"description":"

if dialpad should be opened

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"SetDTMFDialpadDigitsPayload","docName":null,"longname":"Actions.SetDTMFDialpadDigitsPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"digits","type":{"names":["string"]},"description":"

dialpad input

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"SendDTMFDigitsPayload","docName":null,"longname":"Actions.SendDTMFDigitsPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"digits","type":{"names":["string"]},"description":"

dialpad input to send

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"SetWorkerAttributesPayload","docName":null,"longname":"Actions.SetWorkerAttributesPayload","description":null,"defaultvalue":null,"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"}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"UpdateWorkerTokenPayload","docName":null,"longname":"Actions.UpdateWorkerTokenPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"token","type":{"names":["string"]},"description":"

newToken

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"SetTaskAttributesPayload","docName":null,"longname":"Actions.SetTaskAttributesPayload","description":null,"defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"UpdateWorkerParticipantPayload","docName":null,"longname":"Actions.UpdateWorkerParticipantPayload","description":null,"defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"UpdateCustomerParticipantPayload","docName":null,"longname":"Actions.UpdateCustomerParticipantPayload","description":null,"defaultvalue":null,"type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"options","type":{"names":["TaskParticipantOptions"]},"description":"

See TaskPartipantOptions for more info.

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"IssueCallToWorkerPayload","docName":null,"longname":"Actions.IssueCallToWorkerPayload","description":null,"defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"DequeueTaskPayload","docName":null,"longname":"Actions.DequeueTaskPayload","description":null,"defaultvalue":null,"type":{"names":["Actions.WorkerActionPayload"]},"properties":[{"name":"options","type":{"names":["DequeueOptions"]},"description":"

See DequeueOptions for more info.

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"IssueCallToWorkerPayload","docName":null,"longname":"Actions.IssueCallToWorkerPayload","description":null,"defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"AcceptTask","docName":null,"longname":"Actions.AcceptTask","description":"

Accept a task

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"AcceptTask\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","Actions.WorkerAcceptTaskActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""},{"name":"payload.conferenceOptions","type":{"names":["any"]},"description":"

conferenceOptions

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"AcceptTask\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"RejectTask","docName":null,"longname":"Actions.RejectTask","description":"

Reject a task.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"RejectTask\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"RejectTask\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"EndVoiceTask","docName":null,"longname":"Actions.EndVoiceTask","description":"

Hang up a voice call by invoking the "HangupCall" action.\nDifferently from the latter, if there isn't a voice call to hang up, proceeds to invoke the "CompleteTask" or\n"WrapupTask" actions, depending on the task status and the taskChannel capabilities.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"EndVoiceTask\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"EndVoiceTask\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"CompleteTask","docName":null,"longname":"Actions.CompleteTask","description":"

Complete a task that is either pending or assigned. If applicable, will result in WrapupTask action being called.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"CompleteTask\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"CompleteTask\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"WrapupTask","docName":null,"longname":"Actions.WrapupTask","description":"

Wrap a task (if applicable)

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"WrapupTask\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"WrapupTask\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"SelectTask","docName":null,"longname":"Actions.SelectTask","description":"

Select a task in Supervisor UI. Deselect a current task if provided task is undefined.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SelectTask\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"SelectTask\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"SetActivity","docName":null,"longname":"Actions.SetActivity","description":"

Set an activity of the user (similar to selecting activity from Profile widget).

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SetActivity\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerSetActivityPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.activityAvailable","type":{"names":["boolean"]},"description":"

if the activity is available

","optional":true,"defaultvalue":""},{"name":"payload.activityName","type":{"names":["string"]},"description":"

name of activity

","optional":true,"defaultvalue":""},{"name":"payload.activitySid","type":{"names":["string"]},"description":"

sid of activity

","optional":true,"defaultvalue":""},{"name":"payload.options.rejectPendingReservations","type":{"names":["boolean"]},"description":"

if pending reservations should be rejected

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"SetActivity\", { activitySid: \"WAXXXXXXXXXXXXXXXXX\" });"]},{"name":"SetWorkerActivity","docName":null,"longname":"Actions.SetWorkerActivity","description":"

A supervisor changing a worker status

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SetWorkerActivity\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["WorkerActions.WorkerSetWorkerActivityPayload"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Actions.invokeAction(\"SetWorkerActivity\", { workerSid: \"WKXXXXXXXXXXXXXXXXX\", activitySid: \"WAXXXXXXXXXXXXXXXXX\" })"]},{"name":"TransferTask","docName":null,"longname":"Actions.TransferTask","description":"

Transfer a provided task to a target worker (similar to transferring via Worker Directory)

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"TransferTask\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","Actions.TransferTaskPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""},{"name":"payload.targetSid","type":{"names":["string"]},"description":"

sid of the worker or the queue to be transferred to

","optional":null,"defaultvalue":""},{"name":"payload.options","type":{"names":["any"]},"description":"

transfer options (see Taskrouter docs for options).

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"TransferTask\", {\n sid: \"WRXXXXXXXXXXXXXXXXX\",\n targetSid: someWorker.sid,\n options: { mode: \"COLD\"}\n});"]},{"name":"KickParticipant","docName":null,"longname":"Actions.KickParticipant","description":"

Remove a participant from a call

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"KickParticipant\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","Actions.WorkerParticipantActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""},{"name":"payload.targetSid","type":{"names":["string"]},"description":"

sid of the participant (either this or participant has to be provided)

","optional":true,"defaultvalue":""},{"name":"payload.participant","type":{"names":["ConferenceParticipant"]},"description":"

participant object (either this or participant has to be provided)

","optional":true,"defaultvalue":""},{"name":"payload.holdMusicUrl","type":{"names":["string"]},"description":"

url of audio to play when on hold

","optional":true,"defaultvalue":""},{"name":"payload.holdMusicMethod","type":{"names":["string"]},"description":"

name of hold music method

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"KickParticipant\", {\n sid: \"WRXXXXXXXXXXXXXXXXX\",\n targetSid: participant.workerSid\n});"]},{"name":"CancelTransfer","docName":null,"longname":"Actions.CancelTransfer","description":"

Cancel a task that was being transferred to a target worker.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"CancelTransfer\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","Actions.TransferTaskPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""},{"name":"payload.targetSid","type":{"names":["string"]},"description":"

sid of the worker or the queue to be transferred to

","optional":null,"defaultvalue":""},{"name":"payload.options","type":{"names":["any"]},"description":"

transfer options (see Taskrouter docs for options).

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"CancelTransfer\", { sid: \"WRXXXXXXXXXXXXXXXXX\" });"]},{"name":"Logout","docName":null,"longname":"Actions.Logout","description":"

Try to logout user from current session if there are no current activities preventing it.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"Logout\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerLogoutPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.forceLogout","type":{"names":["boolean"]},"description":"

supress an error in case offline activity cannot be set for the worker

","optional":true,"defaultvalue":""},{"name":"payload.activitySid","type":{"names":["string"]},"description":"

sid of the custom offline activity

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"Logout\", { forceLogout: true });"]},{"name":"HoldParticipant","docName":null,"longname":"Actions.HoldParticipant","description":"

Put a call participant on hold

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"HoldParticipant\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","Actions.WorkerParticipantActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""},{"name":"payload.targetSid","type":{"names":["string"]},"description":"

sid of the participant (either this or participant has to be provided)

","optional":true,"defaultvalue":""},{"name":"payload.participant","type":{"names":["ConferenceParticipant"]},"description":"

participant object (either this or participant has to be provided)

","optional":true,"defaultvalue":""},{"name":"payload.holdMusicUrl","type":{"names":["string"]},"description":"

url of audio to play when on hold

","optional":true,"defaultvalue":""},{"name":"payload.holdMusicMethod","type":{"names":["string"]},"description":"

name of hold music method

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"HoldParticipant\", {\n sid: \"WRXXXXXXXXXXXXXXXXX\",\n targetSid: participant.workerSid\n});"]},{"name":"UnholdParticipant","docName":null,"longname":"Actions.UnholdParticipant","description":"

Unhold a call participant

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"UnholdParticipant\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","Actions.WorkerParticipantActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""},{"name":"payload.targetSid","type":{"names":["string"]},"description":"

sid of the participant (either this or participant has to be provided)

","optional":true,"defaultvalue":""},{"name":"payload.participant","type":{"names":["ConferenceParticipant"]},"description":"

participant object (either this or participant has to be provided)

","optional":true,"defaultvalue":""},{"name":"payload.holdMusicUrl","type":{"names":["string"]},"description":"

url of audio to play when on hold

","optional":true,"defaultvalue":""},{"name":"payload.holdMusicMethod","type":{"names":["string"]},"description":"

name of hold music method

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"UnholdParticipant\", {\n sid: \"WRXXXXXXXXXXXXXXXXX\",\n targetSid: participant.workerSid\n});"]},{"name":"ToggleDTMFDialpad","docName":null,"longname":"Actions.ToggleDTMFDialpad","description":"

Show/hide the DTMF Dialpad for a call

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"ToggleDTMFDialpad\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","Actions.ToggleDTMFDialpadPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""},{"name":"payload.open","type":{"names":["boolean"]},"description":"

if dialpad should be opened

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"ToggleDTMFDialpad\", {\n sid: \"WRXXXXXXXXXXXXXXXXX\",\n open: true\n});"]},{"name":"SetDTMFDialpadDigits","docName":null,"longname":"Actions.SetDTMFDialpadDigits","description":"

Sets DTMF sending history for a task

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SetDTMFDialpadDigits\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","ActionPayload.SetDTMFDialpadDigitsPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"SetDTMFDialpadDigits\", {\n sid: \"WRXXXXXXXXXXXXXXXXX\",\n digits: \"123\"\n});"]},{"name":"SendDTMFDigits","docName":null,"longname":"Actions.SendDTMFDigits","description":"

Send DTMF sending history for a task. Calls SetDTMFDialpadDigits action internally

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SendDTMFDigits\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","ActionPayload.SendDTMFDigitsPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["// sends tone with digit 5 to the call\nimport { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"SendDTMFDigits\", {\n sid: \"WRXXXXXXXXXXXXXXXXX\",\n digits: \"5\"\n});"]},{"name":"StartOutboundEmailTask","docName":null,"longname":"Actions.StartOutboundEmailTask","description":"

Start email task

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"StartOutboundEmailTask\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["ActionPayload.StartOutboundEmailTask"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"StartOutboundEmailTask\", {\n destination: \"customer@company.com\",\n queueSid: \"defaultQueue\",\n from: \"test@flexy.flex\",\n fromName: \"support\"\n});"]},{"name":"SetWorkerAttributes","docName":null,"longname":"Actions.SetWorkerAttributes","description":"

Set worker attributes

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SetWorkerAttributes\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["ActionPayload.SetWorkerAttributesPayload"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"SetWorkerAttributes\", {\n attributes: {\n customWorkerAttribute: 1,\n contact_uri: \"client:workerName\"\n },\n mergeExisting: true\n});"]},{"name":"UpdateWorkerToken","docName":null,"longname":"Actions.UpdateWorkerToken","description":"

Update worker token

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"UpdateWorkerToken\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["ActionPayload.UpdateWorkerTokenPayload"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"UpdateWorkerToken\", {\n token: \"newToken\"\n});"]},{"name":"SetTaskAttributes","docName":null,"longname":"Actions.SetTaskAttributes","description":"

Update task attributes

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SetTaskAttributes\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","ActionPayload.SetTaskAttributesPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\n Actions.invokeAction(\"SetTaskAttributes\", {\n sid: \"WRxxxxx\",\n attributes: {},\n mergeExisting: true\n});"]},{"name":"IssueCallToWorker","docName":null,"longname":"Actions.IssueCallToWorker","description":"

Issue a Call to a Worker

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"IssueCallToWorker\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","ActionPayload.IssueCallToWorkerPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"IssueCallToWorker\", {\n callerId: \"callerId\",\n twiMLUrl: \"twiMLUrl\",\n task: myTask\n});"]},{"name":"DequeueTask","docName":null,"longname":"Actions.DequeueTask","description":"

Dequeue the Reservation to the Worker.\nThis will perform telephony to dequeue a Task that was enqueued using the Enqueue TwiML verb.\nA contact_uri must exist in the Worker's attributes for this call to go through.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"DequeueTask\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","ActionPayload.DequeueTaskPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"DequeueTask\", {\n task: myTask\n});"]},{"name":"RedirectCallTask","docName":null,"longname":"Actions.RedirectCallTask","description":"

Redirect the active Call tied to this Reservation

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"RedirectCallTask\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","ActionPayload.RedirectCallTaskPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"RedirectCallTask\", {\n callerId: \"callerId\",\n twiMLUrl: \"twiMLUrl\",\n task: myTask\n});"]},{"name":"UpdateWorkerParticipant","docName":null,"longname":"Actions.UpdateWorkerParticipant","description":"

Update the Worker's leg in the Conference associated to this Reservation

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"UpdateWorkerParticipant\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","ActionPayload.UpdateWorkerParticipantPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"UpdateWorkerParticipant\", {\n task: myTask\n});"]},{"name":"UpdateCustomerParticipant","docName":null,"longname":"Actions.UpdateCustomerParticipant","description":"

Update the Customer leg in the Conference associated to this Task

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"UpdateCustomerParticipant\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.WorkerActionPayload","ActionPayload.UpdateCustomerParticipantPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.task","type":{"names":["ITask"]},"description":"

targeted task object. Either this or sid property is required

","optional":true,"defaultvalue":""},{"name":"payload.sid","type":{"names":["string"]},"description":"

targeted task object's sid. Either this or task property is required

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"UpdateCustomerParticipant\", {\n task: myTask\n});"]},{"name":"InsightsPlayerPlayActionPayload","docName":null,"longname":"Actions.InsightsPlayerPlayActionPayload","description":"

Either segmentId or taskSid must be defined, or an error is thrown.

","defaultvalue":null,"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":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"InsightsPlayerPlay","docName":null,"longname":"Actions.InsightsPlayerPlay","description":"

Shows player and plays recording.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"InsightsPlayerPlay\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["InsightsPlayerPlayActionPayload"]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import * as Flex from \"@twilio/flex-ui\";\nFlex.Actions.invokeAction(\"InsightsPlayerPlay\", {segmentId: \"e5c46a75-0f56...\"})"]},{"name":"InsightsPlayerInitialized","docName":null,"longname":"Actions.InsightsPlayerInitialized","description":"

Invoked when the player is rendered.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"InsightsPlayerInitialized\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"InsightsPlayerInitialized\");"]},{"name":"InsightsPlayerHide","docName":null,"longname":"Actions.InsightsPlayerHide","description":"

Hides the player.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"InsightsPlayerHide\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"InsightsPlayerHide\");"]},{"name":"InsightsPlayerShow","docName":null,"longname":"Actions.InsightsPlayerShow","description":"

Shows the player.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"InsightsPlayerShow\""]},"description":null,"optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Actions } from \"@twilio/flex-ui\";\nActions.invokeAction(\"InsightsPlayerShow\");"]},{"name":"ChatActionPayload","docName":null,"longname":"Actions.ChatActionPayload","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"conversationSid","type":{"names":["string"]},"description":"

Unique identifier of the conversation.

","optional":true,"defaultvalue":""},{"name":"conversation","type":{"names":["ConversationState"]},"description":"

Represents a remote conversation.

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ChatActionInputTextPayload","docName":null,"longname":"Actions.ChatActionInputTextPayload","description":null,"defaultvalue":null,"type":{"names":["Actions.ChatActionPayload"]},"properties":[{"name":"body","type":{"names":["string"]},"description":"

Content of the message.

","optional":null,"defaultvalue":""},{"name":"selectionStart","type":{"names":["number"]},"description":"

Represents the selection start position in the message body.

","optional":true,"defaultvalue":""},{"name":"selectionEnd","type":{"names":["number"]},"description":"

Represents the selection end position in the message body.

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ChatActionAttachFilePayload","docName":null,"longname":"Actions.ChatActionAttachFilePayload","description":null,"defaultvalue":null,"type":{"names":["Actions.ChatActionPayload"]},"properties":[{"name":"file","type":{"names":["File"]},"description":"

Media file to be attached

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ChatActionAttachFilePayload","docName":null,"longname":"Actions.ChatActionAttachFilePayload","description":null,"defaultvalue":null,"type":{"names":["Actions.ChatActionPayload"]},"properties":[{"name":"files","type":{"names":["Array"]},"description":"

Media files to be attached

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ChatActionDownloadMediaPayload","docName":null,"longname":"Actions.ChatActionDownloadMediaPayload","description":null,"defaultvalue":null,"type":{"names":["Actions.ChatActionPayload"]},"properties":[{"name":"media","type":{"names":["Media"]},"description":"

Represents a downloadable media file

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ChatActionSendMessageTextPayload","docName":null,"longname":"Actions.ChatActionSendMessageTextPayload","description":null,"defaultvalue":null,"type":{"names":["Actions.ChatActionPayload"]},"properties":[{"name":"body","type":{"names":["string"]},"description":"

Content of the message.

","optional":null,"defaultvalue":""},{"name":"messageAttributes","type":{"names":["any"]},"description":"

Represents chat message attributes to set.

","optional":true,"defaultvalue":""},{"name":"subject","type":{"names":["string"]},"description":"

Subject of the message.

","optional":null,"defaultvalue":""},{"name":"attachedFiles","type":{"names":["Array"]},"description":"

Media files to be attached (only if new send message behaviour is enabled)

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ChatActionContentTemplateVariable","docName":null,"longname":"Actions.ChatActionContentTemplateVariable","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["string"]},"description":"

The name of the content template variable.

","optional":null,"defaultvalue":""},{"name":"value","type":{"names":["string"]},"description":"

The value of the content template variable.

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ChatActionSendRichContentMessagePayload","docName":null,"longname":"Actions.ChatActionSendRichContentMessagePayload","description":null,"defaultvalue":null,"type":{"names":["Actions.ChatActionPayload"]},"properties":[{"name":"contentSid","type":{"names":["string"]},"description":"

The content template sid to send.

","optional":null,"defaultvalue":""},{"name":"contentVariables","type":{"names":["Array"]},"description":"

Optional array of variables defined for the content template. [{ name: "variable_name", value: "variable_value" }]

","optional":true,"defaultvalue":""},{"name":"messageAttributes","type":{"names":["any"]},"description":"

Represents chat message attributes to set.

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ChatActionSendMediaMessagePayload","docName":null,"longname":"Actions.ChatActionSendMediaMessagePayload","description":null,"defaultvalue":null,"type":{"names":["Actions.ChatActionPayload"]},"properties":[{"name":"file","type":{"names":["File"]},"description":"

Media file to send.

","optional":null,"defaultvalue":""},{"name":"messageAttributes","type":{"names":["any"]},"description":"

Represents chat message attributes to set.

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"ChatActionAttachFilePayload","docName":null,"longname":"Actions.ChatActionAttachFilePayload","description":null,"defaultvalue":null,"type":{"names":["Actions.ChatActionPayload"]},"properties":[{"name":"accordionId","type":{"names":["string"]},"description":"

Id of the accordion to be opened

","optional":null,"defaultvalue":""},{"name":"open","type":{"names":["boolean"]},"description":"

Set true to open the accordion, false to close it, undefined to just toggle it

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"SendMessage","docName":null,"longname":"Actions.SendMessage","description":"

Send message.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SendMessage\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ChatActionPayload","Actions.ChatActionSendMessageTextPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.conversationSid","type":{"names":["string"]},"description":"

Unique identifier of the conversation.

","optional":true,"defaultvalue":""},{"name":"payload.conversation","type":{"names":["ConversationState"]},"description":"

Represents a remote conversation.

","optional":true,"defaultvalue":""},{"name":"payload.body","type":{"names":["string"]},"description":"

Content of the message.

","optional":null,"defaultvalue":""},{"name":"payload.messageAttributes","type":{"names":["any"]},"description":"

Represents chat message attributes to set.

","optional":true,"defaultvalue":""},{"name":"payload.subject","type":{"names":["string"]},"description":"

Subject of the message.

","optional":null,"defaultvalue":""},{"name":"payload.attachedFiles","type":{"names":["Array"]},"description":"

Media files to be attached (only if new send message behaviour is enabled)

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Actions.invokeAction(\"SendMessage\", { body: \"some text\", conversationSid: \"unique_conversation_identifier\" });"]},{"name":"SendRichContentMessage","docName":null,"longname":"Actions.SendRichContentMessage","description":"

Send a rich content message using a content template.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SendRichContentMessage\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ChatActionPayload","Actions.ChatActionSendRichContentMessagePayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.conversationSid","type":{"names":["string"]},"description":"

Unique identifier of the conversation.

","optional":true,"defaultvalue":""},{"name":"payload.conversation","type":{"names":["ConversationState"]},"description":"

Represents a remote conversation.

","optional":true,"defaultvalue":""},{"name":"payload.contentSid","type":{"names":["string"]},"description":"

The content template sid to send.

","optional":null,"defaultvalue":""},{"name":"payload.contentVariables","type":{"names":["Array"]},"description":"

Optional array of variables defined for the content template. [{ name: "variable_name", value: "variable_value" }]

","optional":true,"defaultvalue":""},{"name":"payload.messageAttributes","type":{"names":["any"]},"description":"

Represents chat message attributes to set.

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Actions.invokeAction(\"SendRichContentMessage\", { conversationSid: \"unique_conversation_identifier\", contentSid: \"unique_content_template_sid\" });\n// with variables\nActions.invokeAction(\"SendRichContentMessage\", {\n conversationSid: \"unique_conversation_identifier\",\n contentSid: \"unique_content_template_sid\",\n contentVariables: [{ name: \"variable_name\", value: \"variable_value\" }]\n);"]},{"name":"SendTyping","docName":null,"longname":"Actions.SendTyping","description":"

Send typing indicator.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SendTyping\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ChatActionPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.conversationSid","type":{"names":["string"]},"description":"

Unique identifier of the conversation.

","optional":true,"defaultvalue":""},{"name":"payload.conversation","type":{"names":["ConversationState"]},"description":"

Represents a remote conversation.

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Actions.invokeAction(\"SendTyping\", { conversationSid: \"unique_conversation_identifier\" });"]},{"name":"SetInputText","docName":null,"longname":"Actions.SetInputText","description":"

Set message input text.

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"SetInputText\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ChatActionPayload","Actions.ChatActionInputTextPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.conversationSid","type":{"names":["string"]},"description":"

Unique identifier of the conversation.

","optional":true,"defaultvalue":""},{"name":"payload.conversation","type":{"names":["ConversationState"]},"description":"

Represents a remote conversation.

","optional":true,"defaultvalue":""},{"name":"payload.body","type":{"names":["string"]},"description":"

Content of the message.

","optional":null,"defaultvalue":""},{"name":"payload.selectionStart","type":{"names":["number"]},"description":"

Represents the selection start position in the message body.

","optional":true,"defaultvalue":""},{"name":"payload.selectionEnd","type":{"names":["number"]},"description":"

Represents the selection end position in the message body.

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Actions.invokeAction(\"SetInputText\", { body: \"some text\", conversationSid: \"unique_conversation_identifier\" });"]},{"name":"AttachFiles","docName":null,"longname":"Actions.AttachFiles","description":"

Attach files to the message input

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"AttachFiles\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ChatActionPayload","Actions.ChatActionAttachFilesPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.conversationSid","type":{"names":["string"]},"description":"

Unique identifier of the conversation.

","optional":true,"defaultvalue":""},{"name":"payload.conversation","type":{"names":["ConversationState"]},"description":"

Represents a remote conversation.

","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Actions.invokeAction(\"AttachFiles\", { files: [File], conversationSid: \"unique_conversation_identifier\" });"]},{"name":"DetachFile","docName":null,"longname":"Actions.DetachFile","description":"

Detach a file from the message input

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"DetachFile\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ChatActionPayload","Actions.ChatActionAttachFilePayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.conversationSid","type":{"names":["string"]},"description":"

Unique identifier of the conversation.

","optional":true,"defaultvalue":""},{"name":"payload.conversation","type":{"names":["ConversationState"]},"description":"

Represents a remote conversation.

","optional":true,"defaultvalue":""},{"name":"payload.file","type":{"names":["File"]},"description":"

Media file to be attached

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Actions.invokeAction(\"DetachFile\", { file: File, conversationSid: \"unique_conversation_identifier\" });"]},{"name":"DownloadMedia","docName":null,"longname":"Actions.DownloadMedia","description":"

Download a media file attachment

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["\"DownloadMedia\""]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload","type":{"names":["Actions.ChatActionPayload","Actions.ChatActionDownloadMediaPayload"]},"description":null,"optional":null,"defaultvalue":""},{"name":"payload.conversationSid","type":{"names":["string"]},"description":"

Unique identifier of the conversation.

","optional":true,"defaultvalue":""},{"name":"payload.conversation","type":{"names":["ConversationState"]},"description":"

Represents a remote conversation.

","optional":true,"defaultvalue":""},{"name":"payload.media","type":{"names":["Media"]},"description":"

Represents a downloadable media file

","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["Actions.invokeAction(\"DownloadMedia\", { media, conversationSid });"]}]},"interfacesQuery":{"nodes":[{"name":"TaskStatusBasedType","docName":null,"longname":"TaskStatusBasedType","description":"

Used to define a value based on task status. TaskStatusBasedType accepts a type parameter T which defaults to string.

\n

The valid types are: T, TaskCallbackType and TaskStatusBasedTypeBase

\n
    \n
  • T is a generic type.
    • \n
  • TaskCallbackType is a function to provide values for Flex. Called from various areas of Flex.
    • \n
  • TaskStatusBasedTypeBase is an object with ReservationStatus as its key and the parameter type T as the value.
    • \n
","defaultvalue":null,"type":null,"properties":null,"params":null,"returns":null},{"name":"Actions","docName":null,"longname":"Actions","description":"

Predefined UI actions

","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null},{"name":"LocalizationType","docName":null,"longname":"LocalizationType","description":"

Localization Type object containing the locale tag, available locales, and a function to set the locale preference

","defaultvalue":null,"type":null,"properties":[{"name":"localeTag","type":{"names":["string"]},"description":"

The preferred locale of the user

","optional":null,"defaultvalue":""},{"name":"availableLocales","type":{"names":["Array"]},"description":"

The available locales in Flex UI

","optional":null,"defaultvalue":""},{"name":"setLocalePreference","type":{"names":["function"]},"description":"

An async function which sets the preference of the user

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"Strings","docName":null,"longname":"Strings","description":"

You can override any string in Flex by editing the strings object on the Flex Manager instance.\nLanguage strings can technically contain any HTML tag like h1, h2, p or even iframe.\nThe Flex UI will not filter these values. Flex uses Handlebars for templating and supports Mustache-style syntax and\nexpressions within content strings, ie. embedding value placeholders between double braces { }.

","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null},{"name":"AvailableLocale","docName":null,"longname":"AvailableLocale","description":"

Available locale containing the tag and name

","defaultvalue":null,"type":null,"properties":[{"name":"tag","type":{"names":["string"]},"description":"

The language tag of the locale

","optional":null,"defaultvalue":""},{"name":"name","type":{"names":["string"]},"description":"

The name of the locale

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"AgentCopilotState","docName":null,"longname":"AgentCopilotState","description":"

Agent Copilot State for current Agent

","defaultvalue":null,"type":null,"properties":[{"name":"config","type":{"names":["AgentCopilotConfigState"]},"description":"

AgentCopilotConfigState

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"AgentCopilotConfigState","docName":null,"longname":"AgentCopilotConfigState","description":"

Agent Copilot Configuration State for current Agent

","defaultvalue":null,"type":null,"properties":[{"name":"enabledQueues","type":{"names":["Array"]},"description":"

List of queue SIDs that have Agent Copilot enabled, or all queues if empty

","optional":true,"defaultvalue":""},{"name":"displayNotes","type":{"names":["boolean"]},"description":"

Whether or not the Notes tab and related components are visible in the UI

","optional":null,"defaultvalue":""},{"name":"displaySentiment","type":{"names":["boolean"]},"description":"

Whether or not the sentiment input field is visible in the UI

","optional":null,"defaultvalue":""},{"name":"multiLanguageEnabled","type":{"names":["boolean"]},"description":"

Whether or not multilanguage is enabled for the account

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"AppStatusState","docName":null,"longname":"AppStatusState","description":"

State of the view

","defaultvalue":null,"type":null,"properties":[{"name":"isAppStatusPanelOpen","type":{"names":["boolean"]},"description":"

whether the navigation sidebar is open

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"ConferencesState","docName":null,"longname":"ConferencesState","description":"

State for known conferences

","defaultvalue":null,"type":null,"properties":[{"name":"states","type":{"names":["Map"]},"description":"

active conferences states by conference SID

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"ConnectionStatus","docName":null,"longname":"ConnectionStatus","description":"

Connection status

","defaultvalue":null,"type":null,"properties":[{"name":"timestampLastConnected","type":{"names":["number"]},"description":"

timestamp of last connection

","optional":null,"defaultvalue":""},{"name":"connectionState","type":{"names":["SyncClient.ConnectionState"]},"description":"

connection state of the sync client

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"PhoneState","docName":null,"longname":"PhoneState","description":"

Voice call state

","defaultvalue":null,"type":null,"properties":[{"name":"listener","type":{"names":["DeviceListener"]},"description":"

device listener

","optional":true,"defaultvalue":""},{"name":"activeCall","type":{"names":["Call"]},"description":"

Source call object. See

","optional":true,"defaultvalue":""}],"params":null,"returns":null},{"name":"SessionState","docName":null,"longname":"SessionState","description":"

Active session state

","defaultvalue":null,"type":null,"properties":[{"name":"identity","type":{"names":["string"]},"description":"

identity of a logged-in user

","optional":true,"defaultvalue":""},{"name":"loginError","type":{"names":["any"]},"description":"

last error that occurred when logging in

","optional":true,"defaultvalue":""},{"name":"loginState","type":{"names":["LoginState"]},"description":"

current state of the session

","optional":true,"defaultvalue":""},{"name":"ssoTokenPayload","type":{"names":["SSOTokenPayload"]},"description":"

SSO token payload

","optional":true,"defaultvalue":""},{"name":"degraded","type":{"names":["boolean"]},"description":"

Indicates if session is degraded

","optional":true,"defaultvalue":""}],"params":null,"returns":null},{"name":"SupervisorState","docName":null,"longname":"SupervisorState","description":"

State of the supervisor view

","defaultvalue":null,"type":null,"properties":[{"name":"callMonitoring","type":{"names":["CallMonitoring"]},"description":"

state of call monitoring

","optional":null,"defaultvalue":""},{"name":"stickyWorker","type":{"names":["SupervisorWorkerState"]},"description":"

currently selected worker state

","optional":true,"defaultvalue":""},{"name":"workers","type":{"names":["Array"]},"description":"

currently showing worker states

","optional":null,"defaultvalue":""},{"name":"isLoadingWorkers","type":{"names":["boolean"]},"description":"

if workers are being loaded

","optional":null,"defaultvalue":""},{"name":"errorLoadingWorkers","type":{"names":["LiveQueryError"]},"description":"

instance of the error when loading workers

","optional":null,"defaultvalue":""},{"name":"appliedFilters","type":{"names":["Array"]},"description":"

array of applied filters

","optional":null,"defaultvalue":""},{"name":"extraFilterQuery","type":{"names":["string"]},"description":"

query for custom filters

","optional":null,"defaultvalue":""},{"name":"search","type":{"names":["string"]},"description":"

search string

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"ViewState","docName":null,"longname":"ViewState","description":"

State of the view

","defaultvalue":null,"type":null,"properties":[{"name":"isSideNavOpen","type":{"names":["boolean"]},"description":"

whether the navigation sidebar is open

","optional":null,"defaultvalue":""},{"name":"isOutboundDialerOpen","type":{"names":["boolean"]},"description":"

whether the navigation sidebar is open

","optional":null,"defaultvalue":""},{"name":"activeView","type":{"names":["string"]},"description":"

name of the currently active view

","optional":true,"defaultvalue":""},{"name":"selectedTaskSid","type":{"names":["string"]},"description":"

ID of the selected task in Agent Desktop view

","optional":true,"defaultvalue":""},{"name":"selectedTaskInSupervisorSid","type":{"names":["string"]},"description":"

ID of the selected task in Teams view

","optional":true,"defaultvalue":""},{"name":"selectedWorkerInSupervisorSid","type":{"names":["string"]},"description":"

ID of the selected worker in Teams view

","optional":true,"defaultvalue":""},{"name":"isDirectoryOpen","type":{"names":["boolean"]},"description":"

whether the call transfer panel is open in Agent Desktop view

","optional":true,"defaultvalue":""},{"name":"componentViewStates","type":{"names":["object"]},"description":"

object containing persistent components states. Use {@link Actions.SetComponentState} to update.

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"WorkerState","docName":null,"longname":"WorkerState","description":"

Worker state based on Worker SDK

","defaultvalue":null,"type":null,"properties":[{"name":"tasks","type":{"names":["Map"]},"description":"

map of active tasks by reservation SID

","optional":null,"defaultvalue":""},{"name":"activity","type":{"names":["Activity"]},"description":"

current Activity of the worker.

","optional":null,"defaultvalue":""},{"name":"activities","type":{"names":["Map"]},"description":"

map of all Activities instances by SID.

","optional":null,"defaultvalue":""},{"name":"attributes","type":{"names":["object"]},"description":"

attributes of the Worker.

","optional":null,"defaultvalue":""},{"name":"worker","type":{"names":["IWorker"]},"description":"

current worker instance.

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"FlexState","docName":null,"longname":"FlexState","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"flex","type":{"names":["AppState"]},"description":"

Flex application state

","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"ChatTaskChannelConfiguration","docName":null,"longname":"ChatTaskChannelConfiguration","description":"

Interface to define an object with the parameters needed to configure a Chat Task Channel

","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["string"]},"description":"

name of the task channel definition

","optional":null,"defaultvalue":""},{"name":"isApplicable","type":{"names":["TaskChannelDefinition.TaskChannelApplicableCb"]},"description":"

Callback to determine whether this task channel is applicable for a given task.

","optional":null,"defaultvalue":""},{"name":"icon","type":{"names":["string","React.ReactNode"]},"description":"

main icon to render for the task channel

","optional":true,"defaultvalue":""},{"name":"iconActive","type":{"names":["string","React.ReactNode"]},"description":"

active icon to render for the task channel

","optional":true,"defaultvalue":""},{"name":"color","type":{"names":["string"]},"description":"

main color to be used

","optional":true,"defaultvalue":""},{"name":"reservedTemplate","type":{"names":["string"]},"description":"

template string for pending chat request

","optional":true,"defaultvalue":""},{"name":"charLimit","type":{"names":["number"]},"description":"

message character limit for task channel with chat capabilities

","optional":true,"defaultvalue":""},{"name":"taskHeaderAcceptedTemplate","type":{"names":["string"]},"description":"

template string for chat task in accepted state

","optional":true,"defaultvalue":""},{"name":"taskLineChatAssignedTemplate","type":{"names":["string"]},"description":"

template string for an assigned chat task

","optional":true,"defaultvalue":""},{"name":"taskLineChatWrapupTemplate","type":{"names":["string"]},"description":"

template string for an wrapping up chat task

","optional":true,"defaultvalue":""},{"name":"notificationTitleTemplate","type":{"names":["string"]},"description":"

template string for in-app notification title of chat task

","optional":true,"defaultvalue":""},{"name":"browserNotificationTitleTemplate","type":{"names":["string"]},"description":"

template string for browser notification title of chat task

","optional":true,"defaultvalue":""},{"name":"browserNotificationBodyTemplate","type":{"names":["string"]},"description":"

template string for browser notification body of chat task

","optional":true,"defaultvalue":""},{"name":"contentTabHeaderTemplate","type":{"names":["string"]},"description":"

template string for header of content tab for chat tasks

","optional":true,"defaultvalue":""},{"name":"endButtonTemplates","type":{"names":["Record"]},"description":"

template strings for button to end chat task

","optional":true,"defaultvalue":""}],"params":null,"returns":null},{"name":"NotificationHandler","docName":null,"longname":"NotificationHandler","description":"

Notification Handler interface.

","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null},{"name":"ButtonThemeProps","docName":null,"longname":"Theme.ButtonThemeProps","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"disabledColor","type":{"names":["string"]},"description":"

Use the disabled color

","optional":true,"defaultvalue":""},{"name":"lightHover","type":{"names":["boolean"]},"description":"

Use the light hover effect

","optional":true,"defaultvalue":""},{"name":"disabledColor","type":{"names":["string"]},"description":"

Use the disabled color

","optional":true,"defaultvalue":""},{"name":"lightHover","type":{"names":["boolean"]},"description":"

Use the light hover effect

","optional":true,"defaultvalue":""}],"params":null,"returns":null}]}},"pageContext":{"name":"Actions","docName":null}}, "staticQueryHashes": ["2573139180","3167116022","426031883"]}