{
    "componentChunkName": "component---src-templates-api-template-tsx",
    "path": "/overview/Manager/",
    "result": {"data":{"entityQuery":{"nodes":[{"name":"Manager","docName":null,"properties":null,"description":null,"classdesc":"<p>The Flex Manager is the access point for controlling your Flex instance and all of the underlying Twilio products used for communications and assigning tasks. This means that within your Flex project, you can access the TaskRouter or Chat client directly through the Flex manager.\nAside from Flex itself, Manager also gives you access to the\n<a href=\"https://www.twilio.com/docs/conversations/javascript/exploring-conversations-javascript-quickstart\">Conversations</a>,\n<a href=\"https://twilio.com/docs/sync\">Sync</a>, <a href=\"https://www.twilio.com/docs/voice/client/javascript\">Voice</a>,\nand <a href=\"https://www.twilio.com/docs/taskrouter\">TaskRouter</a> SDKs.</p>","examples":null}]},"membersQuery":{"nodes":[{"name":"UserInfo","docName":null,"longname":"Manager.UserInfo","description":"<p>User Info</p>","defaultvalue":null,"type":{"names":["object"]},"properties":[{"name":"identity","type":{"names":["string"]},"description":"<p>identity</p>","optional":null,"defaultvalue":""},{"name":"roles","type":{"names":["Array<string>"]},"description":"<p>roles</p>","optional":null,"defaultvalue":""},{"name":"token","type":{"names":["string"]},"description":"<p>access token</p>","optional":null,"defaultvalue":""},{"name":"tokenExpirationDate","type":{"names":["Date"]},"description":"<p>token expiration date</p>","optional":null,"defaultvalue":""},{"name":"permissions","type":{"names":["Permissions"]},"description":"<p>all permissions user have</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"typedef","examples":null},{"name":"getInstance","docName":null,"longname":"Manager.getInstance","description":"<p>Gets the instance of Manager</p>","defaultvalue":null,"type":null,"properties":null,"params":[],"returns":[{"description":"<p>instance</p>","type":{"names":["Manager"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import { Manager } from \"@twilio/flex-ui\";\nManager.getInstance()"]},{"name":"create","docName":null,"longname":"Manager.create","description":"<p>Creates an instance of Flex Manager</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"config","optional":null,"description":"<p>Configuration</p>","type":{"names":["Config"]}},{"name":"store","optional":true,"description":"<p>Custom Redux store</p>","type":{"names":["Store<FlexState>"]}}],"returns":[{"description":"<p>New instance of manager</p>","type":{"names":["Promise<Manager>"]}}],"scope":"static","readonly":null,"kind":"function","examples":["import * as React from \"react\";\nimport * as ReactDOM from \"react-dom\";\nimport { Manager, ContextProvider, RootContainer } from \"@twilio/flex-ui\";\nManager.create(configuration)\n .then((manager) => {\n     ReactDOM.render(\n         <ContextProvider manager={manager}>\n             <RootContainer />\n         </ContextProvider>,\n         document.getElementById(\"container\")\n     );\n })\n .catch((e) => {\n     console.log(\"Failed to run Flex\", e);\n });"]},{"name":"updateConfig","docName":null,"longname":"Manager#updateConfig","description":"<p>Updates current configuration by merging provided configuration objects deeply with the current configuration.</p>","defaultvalue":null,"type":null,"properties":null,"params":[{"name":"configs","optional":null,"description":"<p>configuration objects to merge in</p>","type":{"names":["Config"]}}],"returns":[{"description":null,"type":{"names":["void"]}}],"scope":"instance","readonly":null,"kind":"function","examples":["import { Manager } from \"@twilio/flex-ui\";\nManager.getInstance().updateConfig({\n logLevel: \"debug\"\n});"]},{"name":"configuration","docName":null,"longname":"Manager#configuration","description":"<p>Current configuration</p>","defaultvalue":null,"type":{"names":["Config"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":["import { Manager } from \"@twilio/flex-ui\";\nManager.getInstance().configuration;"]},{"name":"serviceConfiguration","docName":null,"longname":"Manager#serviceConfiguration","description":"<p>Service configuration</p>","defaultvalue":null,"type":{"names":["ServiceConfiguration"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":["import { Manager } from \"@twilio/flex-ui\";\nconst accountSid = Manager.getInstance().serviceConfiguration.account_sid;"]},{"name":"store","docName":null,"longname":"Manager#store","description":"<p>Instance of Flex <a href=\"https://redux.js.org/api/store\">Redux store</a>.</p>","defaultvalue":null,"type":{"names":["EnhancedStore<FlexState>"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":["import { Manager } from \"@twilio/flex-ui\";\nManager.getInstance().store"]},{"name":"events","docName":null,"longname":"Manager.events","description":"<p>Flex event emitter. Use to subscribe to Flex events.</p>","defaultvalue":null,"type":{"names":["FlexEventEmitter"]},"properties":[],"params":[],"returns":null,"scope":"static","readonly":true,"kind":"member","examples":null},{"name":"events","docName":null,"longname":"Manager#events","description":"<p>Flex event emitter. Use to subscribe to Flex events.</p>","defaultvalue":null,"type":{"names":["FlexEventEmitter"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":["import { Manager } from \"@twilio/flex-ui\";\nManager.events.removeAllListeners();"]},{"name":"strings","docName":null,"longname":"Manager#strings","description":"<p>Get or set strings / templates for Flex. Add or updates existing ones.</p>","defaultvalue":null,"type":{"names":["Strings"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":null,"kind":"member","examples":null},{"name":"user","docName":null,"longname":"Manager#user","description":"<p>Current user information</p>","defaultvalue":null,"type":{"names":["UserInfo"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":null},{"name":"conversationsClient","docName":null,"longname":"Manager#conversationsClient","description":"<p>Instance of <a href=\"https://media.twiliocdn.com/sdk/js/conversations/releases/1.1.0/docs/Client.html\">Twilio Conversation Client</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":null},{"name":"voiceClient","docName":null,"longname":"Manager#voiceClient","description":"<p>Returns an instance of <a href=\"https://www.twilio.com/docs/voice/sdks/javascript/twiliodevice\"><code>Twilio.Device</code></a> which is used to handle calls.</p>","defaultvalue":null,"type":{"names":["twilio-client:Device"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":null},{"name":"workerClient","docName":null,"longname":"Manager#workerClient","description":"<p>Returns an instance of <a href=\"https://twilio.github.io/twilio-taskrouter.js\">Twilio TaskRouter</a> Worker Client.</p>","defaultvalue":null,"type":{"names":["twilio-taskrouter:Worker"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":null},{"name":"workspaceClient","docName":null,"longname":"Manager#workspaceClient","description":"<p>Returns an instance of <a href=\"https://twilio.github.io/twilio-taskrouter.js\">Twilio TaskRouter</a> Workspace Client.</p>","defaultvalue":null,"type":{"names":["twilio-taskrouter:Workspace"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":null},{"name":"insightsClient","docName":null,"longname":"Manager#insightsClient","description":"<p>Returns an instance of <a href=\"https://media.twiliocdn.com/sdk/js/sync/v0.9/docs\">Twilio Sync</a> Client.</p>","defaultvalue":null,"type":{"names":["twilio-sync:Client"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":true,"kind":"member","examples":null},{"name":"fetchConfiguration","docName":null,"longname":"Manager#fetchConfiguration","description":"<p>Fetches Flex configuration from the service.</p>","defaultvalue":null,"type":null,"properties":null,"params":[],"returns":[{"description":"<p>Flex configuration</p>","type":{"names":["Promise<Config>"]}}],"scope":"instance","readonly":null,"kind":"function","examples":["import { Manager } from \"@twilio/flex-ui\";\nconst config = await Manager.getInstance().fetchConfiguration();"]},{"name":"localization","docName":null,"longname":"Manager#localization","description":"<p>A function which fetches and returns the LocalizationType object.</p>","defaultvalue":null,"type":{"names":["LocalizationType"]},"properties":[],"params":[],"returns":null,"scope":"instance","readonly":null,"kind":"member","examples":["import { Manager } from \"@twilio/flex-ui\";\nconst localization = Manager.getInstance().localization;"]}]},"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":"Manager","docName":null}},
    "staticQueryHashes": ["2573139180","3167116022","426031883"]}