{
    "componentChunkName": "component---src-templates-api-template-tsx",
    "path": "/advanced/interfaces/ITask/",
    "result": {"data":{"entityQuery":{"nodes":[{"name":"ITask","docName":null,"properties":[{"name":"source","type":{"names":["Task"]},"description":"<p>source object backing the task</p>","optional":null,"defaultvalue":""},{"name":"sourceObject","type":{"names":["object"]},"description":"<p>source object backing the instance (any)</p>","optional":null,"defaultvalue":""},{"name":"addOns","type":{"names":["object"]},"description":"<p>the addons attached to the Task</p>","optional":null,"defaultvalue":""},{"name":"age","type":{"names":["number"]},"description":"<p>the age of the Task in seconds</p>","optional":null,"defaultvalue":""},{"name":"attributes","type":{"names":["object"]},"description":"<p>the attributes of the Task</p>","optional":null,"defaultvalue":""},{"name":"dateCreated","type":{"names":["Date"]},"description":"<p>the date the Task was created</p>","optional":null,"defaultvalue":""},{"name":"dateUpdated","type":{"names":["Date"]},"description":"<p>the date the Task was last updated</p>","optional":null,"defaultvalue":""},{"name":"priority","type":{"names":["number"]},"description":"<p>the priority of the Task</p>","optional":null,"defaultvalue":""},{"name":"queueName","type":{"names":["string"]},"description":"<p>the friendly name of the TaskQueue the Task is currently in</p>","optional":null,"defaultvalue":""},{"name":"queueSid","type":{"names":["string"]},"description":"<p>the sid of the TaskQueue the Task is currently in</p>","optional":null,"defaultvalue":""},{"name":"reason","type":{"names":["string"]},"description":"<p>the reason the Task was completed or canceled, if applicable</p>","optional":null,"defaultvalue":""},{"name":"sid","type":{"names":["string"]},"description":"<p>the sid of the Reservation</p>","optional":null,"defaultvalue":""},{"name":"status","type":{"names":["ITask.TaskReservationStatus"]},"description":"<p>the status of the Reservation</p>","optional":null,"defaultvalue":""},{"name":"taskSid","type":{"names":["string"]},"description":"<p>the sid of the Task</p>","optional":null,"defaultvalue":""},{"name":"taskStatus","type":{"names":["ITask.TaskTaskStatus"]},"description":"<p>the status of the Task</p>","optional":null,"defaultvalue":""},{"name":"taskChannelSid","type":{"names":["string"]},"description":"<p>the sid of the Task Channel associated to the Task in MultiTask mode</p>","optional":null,"defaultvalue":""},{"name":"taskChannelUniqueName","type":{"names":["string"]},"description":"<p>the unique name of the Task Channel associated to the Task in MultiTask mode</p>","optional":null,"defaultvalue":""},{"name":"timeout","type":{"names":["number"]},"description":"<p>the number of seconds the Task is allowed to live</p>","optional":null,"defaultvalue":""},{"name":"workflowName","type":{"names":["string"]},"description":"<p>the name of the Workflow responsible for routing the Task</p>","optional":null,"defaultvalue":""},{"name":"workflowSid","type":{"names":["string"]},"description":"<p>the sid of the Workflow responsible for routing the Task</p>","optional":null,"defaultvalue":""},{"name":"workerSid","type":{"names":["string"]},"description":"<p>the sid of the worker the task is assigned to</p>","optional":null,"defaultvalue":""},{"name":"incomingTransferObject","type":{"names":["ITask.TaskTransfer"]},"description":"<p>transfer object if Task was transferred to the current user</p>","optional":true,"defaultvalue":""},{"name":"outgoingTransferObject","type":{"names":["ITask.TaskTransfer"]},"description":"<p>transfer object if is being transferred to another user by current user</p>","optional":true,"defaultvalue":""},{"name":"routingTarget","type":{"names":["string"]},"description":"<p>the final target for task assignemnt</p>","optional":null,"defaultvalue":""},{"name":"channelType","type":{"names":["string"]},"description":"<p>channel type - either <code>channelType</code> property defined in the attributes of Task or <code>taskChannelUniqueName</code> property</p>","optional":null,"defaultvalue":""},{"name":"defaultFrom","type":{"names":["string"]},"description":"<p>default initiator of a Task. Either <code>name</code> or <code>from</code> property defined in the attributes. If not specified then 'Anonymous' is returned</p>","optional":null,"defaultvalue":""},{"name":"formattedAttributes","type":{"names":["object"]},"description":"<p>formatted task attributes used by flex ui</p>","optional":null,"defaultvalue":""},{"name":"formattedAttributes.from","type":{"names":["string"]},"description":"<p>formatted <code>from</code> phone number with country code</p>","optional":true,"defaultvalue":""},{"name":"formattedAttributes.outbound_to","type":{"names":["string"]},"description":"<p>formatted <code>outbound_to</code> phone number with country code</p>","optional":true,"defaultvalue":""},{"name":"conference","type":{"names":["Conference"]},"description":"<p>the conference related to this task</p>","optional":true,"defaultvalue":""}],"description":"<p>Task interface for actionable Reservations from TaskRouter SDK</p>","classdesc":null,"examples":null}]},"membersQuery":{"nodes":[{"name":"TaskTransfer","docName":null,"longname":"ITask.TaskTransfer","description":null,"defaultvalue":null,"type":null,"properties":[{"name":"mode","type":{"names":["\"COLD\"","\"WARM\""]},"description":"<p>transfer mode</p>","optional":null,"defaultvalue":""},{"name":"sid","type":{"names":["string"]},"description":"<p>The sid of this Transfer</p>","optional":null,"defaultvalue":""},{"name":"status","type":{"names":["\"INITIATED\"","\"FAILED\"","\"COMPLETE\"","\"CANCELED\""]},"description":"<p>transfer status</p>","optional":null,"defaultvalue":""},{"name":"to","type":{"names":["string"]},"description":"<p>The sid of the Worker or TaskQueue this Transfer is intended for</p>","optional":null,"defaultvalue":""},{"name":"type","type":{"names":["\"QUEUE\"","\"WORKER\""]},"description":"<p>The transfer type</p>","optional":null,"defaultvalue":""},{"name":"workerSid","type":{"names":["string"]},"description":"<p>The sid of the initiating Worker</p>","optional":null,"defaultvalue":""},{"name":"worker","type":{"names":["IWorker"]},"description":"<p>The instance of the initiating Worker</p>","optional":true,"defaultvalue":""},{"name":"queue","type":{"names":["IQueue"]},"description":"<p>Target queue instance</p>","optional":true,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"TaskReservationStatus","docName":null,"longname":"ITask.TaskReservationStatus","description":"<p>Status of the Reservation</p>","defaultvalue":null,"type":{"names":["\"pending\"","\"accepted\"","\"wrapping\"","\"completed\"","\"canceled\""]},"properties":null,"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"TaskTaskStatus","docName":null,"longname":"ITask.TaskTaskStatus","description":"<p>Status of the Task</p>","defaultvalue":null,"type":{"names":["\"reserved\"","\"assigned\"","\"wrapping\"","\"completed\"","\"canceled\""]},"properties":null,"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null}]},"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":"ITask","docName":null}},
    "staticQueryHashes": ["2573139180","3167116022","426031883"]}