{
    "componentChunkName": "component---src-templates-api-template-tsx",
    "path": "/advanced/helpers/TaskHelper/",
    "result": {"data":{"entityQuery":{"nodes":[{"name":"TaskHelper","docName":null,"properties":null,"description":null,"classdesc":null,"examples":null}]},"membersQuery":{"nodes":[{"name":"chat","docName":null,"longname":"TaskHelper#chat","description":"<p>Gets the helper for associated chat channel.</p>","defaultvalue":null,"type":{"names":["ConversationHelper"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst taskHelper = new TaskHelper(someTask);\nconsole.log(taskHelper.chat);"]},{"name":"isLiveCall","docName":null,"longname":"TaskHelper.isLiveCall","description":"<p>Returns true if task is a live (accepted) call.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst busy = TaskHelper.isLiveCall(someTask);"]},{"name":"isCallOnHold","docName":null,"longname":"TaskHelper.isCallOnHold","description":"<p>Returns true if call associated with a task is on hold.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst busy = TaskHelper.isCallOnHold(someTask);"]},{"name":"canKickWorkerParticipant","docName":null,"longname":"TaskHelper.canKickWorkerParticipant","description":"<p>Returns true if current worker can kick the worker participant in the live call task.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}},{"name":"participant","optional":null,"description":null,"type":{"names":["ConferenceParticipant"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst canRemoveWorker = TaskHelper.canKickWorkerParticipant(someTask, participant);"]},{"name":"canHold","docName":null,"longname":"TaskHelper.canHold","description":"<p>Returns true if task is live call task and worker can hold this call task.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst canHoldCall = TaskHelper.canHold(someTask);"]},{"name":"isCurrentWorkerOnHold","docName":null,"longname":"TaskHelper.isCurrentWorkerOnHold","description":"<p>Returns true if task is conference call and worker is on hold.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isWorkerOnHold = TaskHelper.isCurrentWorkerOnHold(someTask);"]},{"name":"canTransfer","docName":null,"longname":"TaskHelper.canTransfer","description":"<p>Returns true if task is live call task and worker can transfer this call task.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst canTransferTask = TaskHelper.canTransfer(someTask);"]},{"name":"isGroupCall","docName":null,"longname":"TaskHelper.isGroupCall","description":"<p>Returns true if task is Flex conference call with more than 2 participants.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isGroupCall = TaskHelper.isGroupCall(someTask);"]},{"name":"isLiveChat","docName":null,"longname":"TaskHelper.isLiveChat","description":"<p>Returns true if task is a live (accepted) chat based.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isLiveChat = TaskHelper.isLiveChat(someTask);"]},{"name":"isIncomingCall","docName":null,"longname":"TaskHelper.isIncomingCall","description":"<p>Returns true if task is an incoming call.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst incomingCall = TaskHelper.isIncomingCall(someTask);"]},{"name":"isChatBasedTask","docName":null,"longname":"TaskHelper.isChatBasedTask","description":"<p>Returns true if task is a chat based.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isChatTask = TaskHelper.isChatBasedTask(someTask);"]},{"name":"isCallTask","docName":null,"longname":"TaskHelper.isCallTask","description":"<p>Returns true if task is a call based task.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isCallTask = TaskHelper.isCallTask(someTask);"]},{"name":"isEmailTask","docName":null,"longname":"TaskHelper.isEmailTask","description":"<p>Returns true if the task is an email task</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isEmail = TaskHelper.isEmailTask(someTask);"]},{"name":"getTaskConversationSid","docName":null,"longname":"TaskHelper.getTaskConversationSid","description":"<p>Gets conversation sid for a task.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":"<p>Conversation sid.</p>","type":{"names":["string"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst conversationSid = TaskHelper.getTaskConversationSid(someTask);"]},{"name":"isPending","docName":null,"longname":"TaskHelper.isPending","description":"<p>Returns if reservation associated with the task is in pending state.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst pending = TaskHelper.isPending(someTask);"]},{"name":"isInWrapupMode","docName":null,"longname":"TaskHelper.isInWrapupMode","description":"<p>Returns if reservation associated with the task is in wrapping state.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isWrapup = TaskHelper.isInWrapupMode(someTask);"]},{"name":"isCompleted","docName":null,"longname":"TaskHelper.isCompleted","description":"<p>Returns if reservation associated with the task is in completed state.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst completed = TaskHelper.isCompleted(someTask);"]},{"name":"isTaskAssignedToCurrentWorker","docName":null,"longname":"TaskHelper.isTaskAssignedToCurrentWorker","description":"<p>Returns if reservation associated with the task is assigned to the current user.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isTaskAssignedToCurrentWorker = TaskHelper.isTaskAssignedToCurrentWorker(someTask);"]},{"name":"getTaskFromConversationSid","docName":null,"longname":"TaskHelper.getTaskFromConversationSid","description":"<p>Returns a task which is associated with provided chat channel sid.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"conversationSid","optional":null,"description":"<p>Unique identifier of the conversation.</p>","type":{"names":["string"]}}],"returns":[{"description":null,"type":{"names":["ITask","undefined"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst task = TaskHelper.getTaskFromConversationSid(\"CHXXXXXXXXXXXXXXXXX\");"]},{"name":"getTaskByTaskSid","docName":null,"longname":"TaskHelper.getTaskByTaskSid","description":"<p>Returns task by reservation sid.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"reservationSid","optional":null,"description":"<p>Reservation sid.</p>","type":{"names":["string"]}}],"returns":[{"description":null,"type":{"names":["ITask"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst task = TaskHelper.getTaskByTaskSid(\"WRXXXXXXXXXXXXXXXXX\");"]},{"name":"isTaskAccepted","docName":null,"longname":"TaskHelper.isTaskAccepted","description":"<p>Returns true if task is not pending.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isTaskAccepted = TaskHelper.isTaskAccepted(someTask);"]},{"name":"isOutboundCallTask","docName":null,"longname":"TaskHelper.isOutboundCallTask","description":"<p>Returns true if task is as outbound call task.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isOutboundCallTask = TaskHelper.isOutboundCallTask(someTask);"]},{"name":"isInitialOutboundAttemptTask","docName":null,"longname":"TaskHelper.isInitialOutboundAttemptTask","description":"<p>Returns true if the task is initial pending attempt for outbound call.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isInitialOutboundAttemptTask = TaskHelper.isInitialOutboundAttemptTask(someTask);"]},{"name":"isCBMTask","docName":null,"longname":"TaskHelper.isCBMTask","description":"<p>Returns true for tasks which include a <a href=\"https://www.twilio.com/docs/flex/developer/conversations/interactions-api/interactions\">Flex Interaction</a> Channel SID in its attributes. Refers to tasks created using Flex Conversations.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}}],"returns":[{"description":null,"type":{"names":["boolean"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst isCBMTask = TaskHelper.isCBMTask(someTask);"]},{"name":"findParticipant","docName":null,"longname":"TaskHelper.findParticipant","description":"<p>Find the Participant from Task channel</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}},{"name":"channelSid","optional":null,"description":null,"type":{"names":["string"]}},{"name":"type","optional":null,"description":null,"type":{"names":["string"]}}],"returns":[{"description":null,"type":{"names":["Promise<(IParticipant|undefined)>"]}}],"scope":"static","readonly":null,"kind":"function","examples":["const agent = await TaskHelper.findParticipant(task, channelSid, ParticipantType.AGENT);"]},{"name":"findParticipantByTaskSid","docName":null,"longname":"TaskHelper.findParticipantByTaskSid","description":"<p>Find the Participant based on taskSid  from Task channel</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"task","optional":null,"description":null,"type":{"names":["ITask"]}},{"name":"channelSid","optional":null,"description":null,"type":{"names":["string"]}},{"name":"type","optional":null,"description":null,"type":{"names":["string"]}},{"name":"options","optional":null,"description":null,"type":{"names":["object"]}}],"returns":[{"description":null,"type":{"names":["Promise<(IParticipant|undefined)>"]}}],"scope":"static","readonly":null,"kind":"function","examples":["const agent = await TaskHelper.findParticipantByTaskSid(task, channelSid, ParticipantType.AGENT);"]},{"name":"getTaskbyChannelSid","docName":null,"longname":"TaskHelper.getTaskbyChannelSid","description":"<p>Returns task by channel sid.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"channelSid","optional":null,"description":null,"type":{"names":["string"]}}],"returns":[{"description":null,"type":{"names":["ITask"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst task = TaskHelper.getTaskbyChannelSid(channelSid);"]},{"name":"getConversationByConversationSidFromPausedConversationMap","docName":null,"longname":"TaskHelper.getConversationByConversationSidFromPausedConversationMap","description":"<p>Returns task by conversation sid.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"conversationSid","optional":null,"description":null,"type":{"names":["string"]}}],"returns":[{"description":null,"type":{"names":["PausedEmailConversation"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst task = TaskHelper.getConversationfromConversationSid(conversationSid);"]},{"name":"getTaskbyChannelSidFromPauseConversationMap","docName":null,"longname":"TaskHelper.getTaskbyChannelSidFromPauseConversationMap","description":"<p>Returns task by channel sid.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"channelSid","optional":null,"description":null,"type":{"names":["string"]}}],"returns":[{"description":null,"type":{"names":["PausedEmailConversation"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst task = TaskHelper.getTaskbyChannelSidFromPauseConversationMap(channelSid);"]},{"name":"getWorkerStatus","docName":null,"longname":"TaskHelper.getWorkerStatus","description":"<p>Evaluates the current status of the logged-in worker based on their assigned tasks.\nDetermines whether the worker is currently busy (has any accepted task), and further breaks down\nwhether the worker is busy with a live voice call or a live chat.</p>","defaultvalue":null,"type":null,"properties":null,"params":[],"returns":[{"description":"<p>Object indicating the worker's current overall and detailed busy state.</p>","type":{"names":["Object"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst { busy, details } = TaskHelper.getWorkerStatus();"]},{"name":"durationSinceUpdate","docName":null,"longname":"TaskHelper#durationSinceUpdate","description":"<p>Duration since last update of a task. Uses <code>dateUpdated</code> property of a task.</p>","defaultvalue":null,"type":{"names":["string"]},"properties":[],"params":null,"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":["import { BaseTaskHelper } from \"@twilio/flex-ui\";\nconst taskHelper = new BaseTaskHelper(someTask);\nconsole.log(taskHelper.durationSinceUpdate);"]},{"name":"durationSinceUpdateShort","docName":null,"longname":"TaskHelper#durationSinceUpdateShort","description":"<p>Duration since last update of a task in short format. Uses <code>dateUpdated</code> property of a task.</p>","defaultvalue":null,"type":{"names":["string"]},"properties":[],"params":null,"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":["import { BaseTaskHelper } from \"@twilio/flex-ui\";\nconst taskHelper = new BaseTaskHelper(someTask);\nconsole.log(taskHelper.durationSinceUpdateShort);"]},{"name":"jsonString","docName":null,"longname":"TaskHelper#jsonString","description":"<p>Serializes task object to json string.</p>","defaultvalue":null,"type":{"names":["string"]},"properties":[],"params":null,"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":["import { TaskHelper } from \"@twilio/flex-ui\";\nconst taskHelper = new TaskHelper(someTask);\nconsole.log(taskHelper.jsonString);"]}]},"interfacesQuery":{"nodes":[{"name":"TaskStatusBasedType","docName":null,"longname":"TaskStatusBasedType","description":"<p>Used to define a value based on task status. TaskStatusBasedType accepts a type parameter T which defaults to string.</p>\n<p>The valid types are: T, TaskCallbackType<T> and TaskStatusBasedTypeBase<T><br></p>\n<ul>\n<li>T is a generic type.<br></li>\n<li>TaskCallbackType is a function to provide values for Flex. Called from various areas of Flex.<br></li>\n<li>TaskStatusBasedTypeBase is an object with ReservationStatus as its key and the parameter type T as the value.</li>\n</ul>","defaultvalue":null,"type":null,"properties":null,"params":null,"returns":null},{"name":"Actions","docName":null,"longname":"Actions","description":"<p>Predefined UI actions</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null},{"name":"LocalizationType","docName":null,"longname":"LocalizationType","description":"<p>Localization Type object containing the locale tag, available locales, and a function to set the locale preference</p>","defaultvalue":null,"type":null,"properties":[{"name":"localeTag","type":{"names":["string"]},"description":"<p>The preferred locale of the user</p>","optional":null,"defaultvalue":""},{"name":"availableLocales","type":{"names":["Array<AvailableLocale>"]},"description":"<p>The available locales in Flex UI</p>","optional":null,"defaultvalue":""},{"name":"setLocalePreference","type":{"names":["function"]},"description":"<p>An async function which sets the preference of the user</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"Strings","docName":null,"longname":"Strings","description":"<p>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 <code>h1</code>, <code>h2</code>, <code>p</code> or even <code>iframe</code>.\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 <code>{ }</code>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null},{"name":"AvailableLocale","docName":null,"longname":"AvailableLocale","description":"<p>Available locale containing the tag and name</p>","defaultvalue":null,"type":null,"properties":[{"name":"tag","type":{"names":["string"]},"description":"<p>The language tag of the locale</p>","optional":null,"defaultvalue":""},{"name":"name","type":{"names":["string"]},"description":"<p>The name of the locale</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"AgentCopilotState","docName":null,"longname":"AgentCopilotState","description":"<p>Agent Copilot State for current Agent</p>","defaultvalue":null,"type":null,"properties":[{"name":"config","type":{"names":["AgentCopilotConfigState"]},"description":"<p>AgentCopilotConfigState</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"AgentCopilotConfigState","docName":null,"longname":"AgentCopilotConfigState","description":"<p>Agent Copilot Configuration State for current Agent</p>","defaultvalue":null,"type":null,"properties":[{"name":"enabledQueues","type":{"names":["Array<string>"]},"description":"<p>List of queue SIDs that have Agent Copilot enabled, or all queues if empty</p>","optional":true,"defaultvalue":""},{"name":"displayNotes","type":{"names":["boolean"]},"description":"<p>Whether or not the Notes tab and related components are visible in the UI</p>","optional":null,"defaultvalue":""},{"name":"displaySentiment","type":{"names":["boolean"]},"description":"<p>Whether or not the sentiment input field is visible in the UI</p>","optional":null,"defaultvalue":""},{"name":"multiLanguageEnabled","type":{"names":["boolean"]},"description":"<p>Whether or not multilanguage is enabled for the account</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"AppStatusState","docName":null,"longname":"AppStatusState","description":"<p>State of the view</p>","defaultvalue":null,"type":null,"properties":[{"name":"isAppStatusPanelOpen","type":{"names":["boolean"]},"description":"<p>whether the navigation sidebar is open</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"ConferencesState","docName":null,"longname":"ConferencesState","description":"<p>State for known conferences</p>","defaultvalue":null,"type":null,"properties":[{"name":"states","type":{"names":["Map<string, ConferencesState.ConferenceState>"]},"description":"<p>active conferences states by conference SID</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"ConnectionStatus","docName":null,"longname":"ConnectionStatus","description":"<p>Connection status</p>","defaultvalue":null,"type":null,"properties":[{"name":"timestampLastConnected","type":{"names":["number"]},"description":"<p>timestamp of last connection</p>","optional":null,"defaultvalue":""},{"name":"connectionState","type":{"names":["SyncClient.ConnectionState"]},"description":"<p>connection state of the sync client</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"PhoneState","docName":null,"longname":"PhoneState","description":"<p>Voice call state</p>","defaultvalue":null,"type":null,"properties":[{"name":"listener","type":{"names":["DeviceListener"]},"description":"<p>device listener</p>","optional":true,"defaultvalue":""},{"name":"activeCall","type":{"names":["Call"]},"description":"<p>Source call object. <a href=\"https://www.twilio.com/docs/voice/sdks/javascript/twiliocall\">See</a></p>","optional":true,"defaultvalue":""}],"params":null,"returns":null},{"name":"SessionState","docName":null,"longname":"SessionState","description":"<p>Active session state</p>","defaultvalue":null,"type":null,"properties":[{"name":"identity","type":{"names":["string"]},"description":"<p>identity of a logged-in user</p>","optional":true,"defaultvalue":""},{"name":"loginError","type":{"names":["any"]},"description":"<p>last error that occurred when logging in</p>","optional":true,"defaultvalue":""},{"name":"loginState","type":{"names":["LoginState"]},"description":"<p>current state of the session</p>","optional":true,"defaultvalue":""},{"name":"ssoTokenPayload","type":{"names":["SSOTokenPayload"]},"description":"<p>SSO token payload</p>","optional":true,"defaultvalue":""},{"name":"degraded","type":{"names":["boolean"]},"description":"<p>Indicates if session is degraded</p>","optional":true,"defaultvalue":""}],"params":null,"returns":null},{"name":"SupervisorState","docName":null,"longname":"SupervisorState","description":"<p>State of the supervisor view</p>","defaultvalue":null,"type":null,"properties":[{"name":"callMonitoring","type":{"names":["CallMonitoring"]},"description":"<p>state of call monitoring</p>","optional":null,"defaultvalue":""},{"name":"stickyWorker","type":{"names":["SupervisorWorkerState"]},"description":"<p>currently selected worker state</p>","optional":true,"defaultvalue":""},{"name":"workers","type":{"names":["Array<SupervisorWorkerState>"]},"description":"<p>currently showing worker states</p>","optional":null,"defaultvalue":""},{"name":"isLoadingWorkers","type":{"names":["boolean"]},"description":"<p>if workers are being loaded</p>","optional":null,"defaultvalue":""},{"name":"errorLoadingWorkers","type":{"names":["LiveQueryError"]},"description":"<p>instance of the error when loading workers</p>","optional":null,"defaultvalue":""},{"name":"appliedFilters","type":{"names":["Array<AppliedFilter>"]},"description":"<p>array of applied filters</p>","optional":null,"defaultvalue":""},{"name":"extraFilterQuery","type":{"names":["string"]},"description":"<p>query for custom filters</p>","optional":null,"defaultvalue":""},{"name":"search","type":{"names":["string"]},"description":"<p>search string</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"ViewState","docName":null,"longname":"ViewState","description":"<p>State of the view</p>","defaultvalue":null,"type":null,"properties":[{"name":"isSideNavOpen","type":{"names":["boolean"]},"description":"<p>whether the navigation sidebar is open</p>","optional":null,"defaultvalue":""},{"name":"isOutboundDialerOpen","type":{"names":["boolean"]},"description":"<p>whether the navigation sidebar is open</p>","optional":null,"defaultvalue":""},{"name":"activeView","type":{"names":["string"]},"description":"<p>name of the currently active view</p>","optional":true,"defaultvalue":""},{"name":"selectedTaskSid","type":{"names":["string"]},"description":"<p>ID of the selected task in Agent Desktop view</p>","optional":true,"defaultvalue":""},{"name":"selectedTaskInSupervisorSid","type":{"names":["string"]},"description":"<p>ID of the selected task in Teams view</p>","optional":true,"defaultvalue":""},{"name":"selectedWorkerInSupervisorSid","type":{"names":["string"]},"description":"<p>ID of the selected worker in Teams view</p>","optional":true,"defaultvalue":""},{"name":"isDirectoryOpen","type":{"names":["boolean"]},"description":"<p>whether the call transfer panel is open in Agent Desktop view</p>","optional":true,"defaultvalue":""},{"name":"componentViewStates","type":{"names":["object"]},"description":"<p>object containing persistent components states. Use {@link Actions.SetComponentState} to update.</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"WorkerState","docName":null,"longname":"WorkerState","description":"<p>Worker state based on Worker SDK</p>","defaultvalue":null,"type":null,"properties":[{"name":"tasks","type":{"names":["Map<string, ITask>"]},"description":"<p>map of active tasks by reservation SID</p>","optional":null,"defaultvalue":""},{"name":"activity","type":{"names":["Activity"]},"description":"<p>current <a href=\"https://twilio.github.io/twilio-taskrouter.js/Activity.html\">Activity</a> of the worker.</p>","optional":null,"defaultvalue":""},{"name":"activities","type":{"names":["Map<string, Activity>"]},"description":"<p>map of all <a href=\"https://twilio.github.io/twilio-taskrouter.js/Activity.html\">Activities</a> instances by SID.</p>","optional":null,"defaultvalue":""},{"name":"attributes","type":{"names":["object"]},"description":"<p>attributes of the <a href=\"https://twilio.github.io/twilio-taskrouter.js/Worker.html\">Worker</a>.</p>","optional":null,"defaultvalue":""},{"name":"worker","type":{"names":["IWorker"]},"description":"<p>current worker instance.</p>","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":"<p>Flex application state</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null},{"name":"ChatTaskChannelConfiguration","docName":null,"longname":"ChatTaskChannelConfiguration","description":"<p>Interface to define an object with the parameters needed to configure a Chat Task Channel</p>","defaultvalue":null,"type":null,"properties":[{"name":"name","type":{"names":["string"]},"description":"<p>name of the task channel definition</p>","optional":null,"defaultvalue":""},{"name":"isApplicable","type":{"names":["TaskChannelDefinition.TaskChannelApplicableCb"]},"description":"<p>Callback to determine whether this task channel is applicable for a given task.</p>","optional":null,"defaultvalue":""},{"name":"icon","type":{"names":["string","React.ReactNode"]},"description":"<p>main icon to render for the task channel</p>","optional":true,"defaultvalue":""},{"name":"iconActive","type":{"names":["string","React.ReactNode"]},"description":"<p>active icon to render for the task channel</p>","optional":true,"defaultvalue":""},{"name":"color","type":{"names":["string"]},"description":"<p>main color to be used</p>","optional":true,"defaultvalue":""},{"name":"reservedTemplate","type":{"names":["string"]},"description":"<p>template string for pending chat request</p>","optional":true,"defaultvalue":""},{"name":"charLimit","type":{"names":["number"]},"description":"<p>message character limit for task channel with chat capabilities</p>","optional":true,"defaultvalue":""},{"name":"taskHeaderAcceptedTemplate","type":{"names":["string"]},"description":"<p>template string for chat task in accepted state</p>","optional":true,"defaultvalue":""},{"name":"taskLineChatAssignedTemplate","type":{"names":["string"]},"description":"<p>template string for an assigned chat task</p>","optional":true,"defaultvalue":""},{"name":"taskLineChatWrapupTemplate","type":{"names":["string"]},"description":"<p>template string for an wrapping up chat task</p>","optional":true,"defaultvalue":""},{"name":"notificationTitleTemplate","type":{"names":["string"]},"description":"<p>template string for in-app notification title of chat task</p>","optional":true,"defaultvalue":""},{"name":"browserNotificationTitleTemplate","type":{"names":["string"]},"description":"<p>template string for browser notification title of chat task</p>","optional":true,"defaultvalue":""},{"name":"browserNotificationBodyTemplate","type":{"names":["string"]},"description":"<p>template string for browser notification body of chat task</p>","optional":true,"defaultvalue":""},{"name":"contentTabHeaderTemplate","type":{"names":["string"]},"description":"<p>template string for header of content tab for chat tasks</p>","optional":true,"defaultvalue":""},{"name":"endButtonTemplates","type":{"names":["Record<string, any>"]},"description":"<p>template strings for button to end chat task</p>","optional":true,"defaultvalue":""}],"params":null,"returns":null},{"name":"NotificationHandler","docName":null,"longname":"NotificationHandler","description":"<p>Notification Handler interface.</p>","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":"<p>Use the disabled color</p>","optional":true,"defaultvalue":""},{"name":"lightHover","type":{"names":["boolean"]},"description":"<p>Use the light hover effect</p>","optional":true,"defaultvalue":""},{"name":"disabledColor","type":{"names":["string"]},"description":"<p>Use the disabled color</p>","optional":true,"defaultvalue":""},{"name":"lightHover","type":{"names":["boolean"]},"description":"<p>Use the light hover effect</p>","optional":true,"defaultvalue":""}],"params":null,"returns":null}]}},"pageContext":{"name":"TaskHelper","docName":null}},
    "staticQueryHashes": ["2573139180","3167116022","426031883"]}