{
    "componentChunkName": "component---src-templates-api-template-tsx",
    "path": "/nsa/Notifications/",
    "result": {"data":{"entityQuery":{"nodes":[{"name":"Notifications","docName":null,"properties":[],"description":null,"classdesc":"<p>Predefined Flex UI notifications</p>","examples":null},{"name":"Notifications","docName":null,"properties":null,"description":null,"classdesc":null,"examples":null}]},"membersQuery":{"nodes":[{"name":"OutboundCallCanceledGeneric","docName":null,"longname":"Notifications.OutboundCallCanceledGeneric","description":"<p>Warning notification shown when outbound call fails.\nIt renders with an action to redial the outbound call.\nIt uses <a href=\"Strings#OutboundCallFailedNotificationTitle\">Strings.OutboundCallFailedNotificationTitle</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.OutboundCallCanceledGeneric);"]},{"name":"OutboundCallCanceledBusy","docName":null,"longname":"Notifications.OutboundCallCanceledBusy","description":"<p>Warning notification shown when outbound call fails due to other party being busy.\nIt renders with an action to redial the outbound call.\nIt uses <a href=\"Strings#OutboundCallFailedNotificationTitleBus\">Strings.OutboundCallFailedNotificationTitleBus</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.OutboundCallCanceledBusy);"]},{"name":"OutboundCallCanceledNoAnswer","docName":null,"longname":"Notifications.OutboundCallCanceledNoAnswer","description":"<p>Warning notification shown when outbound call fails due to other party not answering.\nIt renders with an action to redial the outbound call.\nIt uses <a href=\"Strings#OutboundCallFailedNotificationTitleNoAnswer\">Strings.OutboundCallFailedNotificationTitleNoAnswer</a></p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.OutboundCallCanceledNoAnswer);"]},{"name":"OutboundCallCanceledInvalidNumber","docName":null,"longname":"Notifications.OutboundCallCanceledInvalidNumber","description":"<p>Warning notification shown when outbound call fails due to invalid number being called.\nIt uses <a href=\"Strings#OutboundCallFailedNotificationTitleInvalidNumber\">Strings.OutboundCallFailedNotificationTitleInvalidNumber</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.OutboundCallCanceledInvalidNumber);"]},{"name":"OutboundCallCanceledDisabledCountry","docName":null,"longname":"Notifications.OutboundCallCanceledDisabledCountry","description":"<p>Warning notification shown when outbound call fails due to calls to that country not being enabled.\nIt uses <a href=\"Strings#OutboundCallFailedNotificationTitleDisabledCountry\">Strings.OutboundCallFailedNotificationTitleDisabledCountry</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.OutboundCallCanceledDisabledCountry);"]},{"name":"OutboundCallCanceledFromNumberUnverified","docName":null,"longname":"Notifications.OutboundCallCanceledFromNumberUnverified","description":"<p>Warning notification shown when outbound call fails due to the 'from' number not being verfied for the account.\nIt uses <a href=\"Strings#OutboundCallFailedNotificationTitleFromNumberUnverified\">Strings.OutboundCallFailedNotificationTitleFromNumberUnverified</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.OutboundCallCanceledFromNumberUnverified);"]},{"name":"OutboundCallCanceledToNumberUnverified","docName":null,"longname":"Notifications.OutboundCallCanceledToNumberUnverified","description":"<p>Warning notification shown when outbound call fails due to the 'to' number not being verfied for the account.\nIt uses <a href=\"Strings#OutboundCallFailedNotificationTitleToNumberUnverified\">Strings.OutboundCallFailedNotificationTitleToNumberUnverified</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.OutboundCallCanceledToNumberUnverified);"]},{"name":"OutboundCallCanceledToNumberBlocked","docName":null,"longname":"Notifications.OutboundCallCanceledToNumberBlocked","description":"<p>Warning notification shown when outbound call fails due to the 'to' number blocked by twilio.\nIt uses <a href=\"Strings#OutboundCallFailedNotificationTitleToNumberBlocked\">Strings.OutboundCallFailedNotificationTitleToNumberBlocked</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.OutboundCallCanceledToNumberBlocked);"]},{"name":"noInputDevice","docName":null,"longname":"Notifications.noInputDevice","description":"<p>Error Notification shown when there are no audio input devices\nIt renders <a href=\"Strings#InputDeviceErrorNotification\">Strings.InputDeviceErrorNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.NoInputDevice);"]},{"name":"BrowserVoiceDisabled","docName":null,"longname":"Notifications.BrowserVoiceDisabled","description":"<p>Error notification shown when an agent receives a phone call but Twilio Voice SDK has been disabled.\nIt renders <a href=\"Strings#BrowserVoiceDisabledNotification\">Strings.BrowserVoiceDisabledNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.browserVoiceDisabled);"]},{"name":"MicTaken","docName":null,"longname":"Notifications.MicTaken","description":"<p>Error notification shown when the microphone is not available in a call.\nIt renders <a href=\"Strings#MicNotAvailableNotification\">Strings.MicNotAvailableNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.MicTaken);"]},{"name":"AudioPlayerDeniedErrorNotificationId","docName":null,"longname":"Notifications.AudioPlayerDeniedErrorNotificationId","description":"<p>Error Notification shown when an audio cannot be played because of missing permissions.\nIt renders <a href=\"Strings#AudioPlayerDeniedError\">Strings.AudioPlayerDeniedError</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.AudioPlayerDeniedErrorNotificationId);"]},{"name":"AudioPlayerInvalidMediaErrorNotificationId","docName":null,"longname":"Notifications.AudioPlayerInvalidMediaErrorNotificationId","description":"<p>Error notification shown when an audio cannot be played because of an invalid media is provided.\nIt renders <a href=\"Strings#AudioPlayerInvalidMediaError\">Strings.AudioPlayerInvalidMediaError</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.AudioPlayerInvalidMediaErrorNotificationId);"]},{"name":"AudioPlayerGenericErrorNotificationId","docName":null,"longname":"Notifications.AudioPlayerGenericErrorNotificationId","description":"<p>Error notification shown when an audio cannot played for non specified reasons.\nIt renders <a href=\"Strings#AudioPlayerGenericError\">Strings.AudioPlayerGenericError</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.AudioPlayerGenericErrorNotificationId);"]},{"name":"DeviceManagerSelectionSuccess","docName":null,"longname":"Notifications.DeviceManagerSelectionSuccess","description":"<p>Success notification shown when a user selects an audio device as the default device for voice calls.\nIt renders <a href=\"Strings#DeviceManagerSetDeviceSuccess\">Strings.DeviceManagerSetDeviceSuccess</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.DeviceManagerSelectionSuccess);"]},{"name":"DeviceManagerSelectionFailed","docName":null,"longname":"Notifications.DeviceManagerSelectionFailed","description":"<p>Error notification shown when an audio device cannot be made the default voice call device for non specified reasons.\nIt renders <a href=\"Strings#DeviceManagerSetDeviceError\">Strings.DeviceManagerSetDeviceError</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.DeviceManagerSelectionFailed);"]},{"name":"MessageSizeExceeded","docName":null,"longname":"Notifications.MessageSizeExceeded","description":"<p>Error notification shown when trying to submit a chat message that exceeds its characters limit.\nIt renders <a href=\"Strings#MessageSizeExceeded\">Strings.MessageSizeExceeded</a>.</p>","defaultvalue":null,"type":null,"properties":[{"name":"payload","type":{"names":["object"]},"description":"<p>Payload object.</p>","optional":null,"defaultvalue":""},{"name":"payload.currentCharCount","type":{"names":["number"]},"description":"<p>Number of characters currently in MessageInput.</p>","optional":null,"defaultvalue":""},{"name":"payload.maxCharCount","type":{"names":["number"]},"description":"<p>Max number of characters allowed in the MessageInput for this specific channel.</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.messageSizeExceeded, {\n currentCharCount: bodyTextLength,\n maxCharCount: charLimit\n});"]},{"name":"ChatOrchestrationAddToConversationFailed","docName":null,"longname":"Notifications.ChatOrchestrationAddToConversationFailed","description":"<p>Error notification shown when worker fails to join a new conversation (chat orchestration)\nIt renders <a href=\"Strings#ChatOrchestrationAddToConversationFailed\">Strings.ChatOrchestrationAddToConversationFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.ChatOrchestrationAddToConversationFailed);"]},{"name":"ChatOrchestrationDeactivateConversationFailed","docName":null,"longname":"Notifications.ChatOrchestrationDeactivateConversationFailed","description":"<p>Error notification shown when an error occurs while deactivating a conversation (chat orchestration)\nIt renders <a href=\"Strings#ChatOrchestrationDeactivateConversationFailed\">Strings.ChatOrchestrationDeactivateConversationFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.ChatOrchestrationDeactivateConversationFailed);"]},{"name":"ChatOrchestrationLeaveConversationFailed","docName":null,"longname":"Notifications.ChatOrchestrationLeaveConversationFailed","description":"<p>Error notification shown when an error occurs while leaving a conversation (chat orchestration)\nIt renders <a href=\"Strings#ChatOrchestrationLeaveConversationFailed\">Strings.ChatOrchestrationLeaveConversationFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.ChatOrchestrationLeaveConversationFailed);"]},{"name":"FlexUnifyCdpDegradationMessage","docName":null,"longname":"Notifications.FlexUnifyCdpDegradationMessage","description":"<p>Warning notification shown when the CDP is degraded and not responding.\nIt renders <a href=\"Strings#FlexUnifyCdpDegradationMessage\">Strings.FlexUnifyCdpDegradationMessage</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.FlexUnifyCdpDegradationMessage);"]},{"name":"FlexUiVersionDeprecated","docName":null,"longname":"Notifications.FlexUiVersionDeprecated","description":"<p>Warning notification shown when the current version of Flex is deprecated.\nIt renders <a href=\"Strings#UiVersionDeprecated\">Strings.UiVersionDeprecated</a>.</p>","defaultvalue":null,"type":null,"properties":[{"name":"payload","type":{"names":["object"]},"description":"<p>Payload object.</p>","optional":null,"defaultvalue":""},{"name":"payload.message","type":{"names":["string"]},"description":"<p>Actual error message.</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.AudioPlayerGenericErrorNotificationId, {\n message: \"error message\"\n});"]},{"name":"FlexSessionExpired","docName":null,"longname":"Notifications.FlexSessionExpired","description":"<p>Warning notification shown when a worker's token expires.\nIt renders <a href=\"Strings#SessionExpired\">Strings.SessionExpired</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.FlexSessionExpired);"]},{"name":"FlexSessionExpirationWarning","docName":null,"longname":"Notifications.FlexSessionExpirationWarning","description":"<p>Warning notification shown when a worker's token is about to expire.\nIt renders <a href=\"Strings#SessionExpirationWarning\">Strings.SessionExpirationWarning</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.FlexSessionExpirationWarning);"]},{"name":"RequestBrowserNotificationPermissions","docName":null,"longname":"Notifications.RequestBrowserNotificationPermissions","description":"<p>Warning Notification for asking for browser notification rights.\nIt renders <a href=\"Strings#RequestBrowserNotificationPermissions\">Strings.RequestBrowserNotificationPermissions</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.RequestBrowserNotificationPermissions);"]},{"name":"NoNetworkConnection","docName":null,"longname":"Notifications.NoNetworkConnection","description":"<p>Warning Notification shown when there is no network connection.\nIt renders <a href=\"Strings#ReconnectingConnection\">Strings.ReconnectingConnection</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.NoNetworkConnection);"]},{"name":"DegradedModeActive","docName":null,"longname":"Notifications.DegradedModeActive","description":"<p>Warning Notification shown when flex is degraded.\nIt renders <a href=\"Strings#DegradedWarning\">Strings.DegradedWarning</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.DegradedModeActive);"]},{"name":"BackupServiceActive","docName":null,"longname":"Notifications.BackupServiceActive","description":"<p>Warning Notification shown when Flex is running on a backup server.\nIt renders <a href=\"Strings#BackupServiceText\">Strings.BackupServiceText</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.BackupServiceActive);"]},{"name":"ShortcutUsedTooRecentlyNotificationTitle","docName":null,"longname":"Notifications.ShortcutUsedTooRecentlyNotificationTitle","description":"<p>Warning notification shown when a shortcut is fired too quickly in succession.\nIt renders <a href=\"Strings#ShortcutUsedTooRecentlyNotificationTitle\">Strings.ShortcutUsedTooRecentlyNotificationTitle</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.ShortcutUsedTooRecentlyNotificationTitle);"]},{"name":"TooManyParticipantsForShortcutNotificationTitle","docName":null,"longname":"Notifications.TooManyParticipantsForShortcutNotificationTitle","description":"<p>Warning notification shown when a user tries to use the hold shortcut if there are more than two participants in a call.\nIt renders <a href=\"Strings#TooManyParticipantsForShortcutNotificationTitle\">Strings.TooManyParticipantsForShortcutNotificationTitle</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.TooManyParticipantsForShortcutNotificationTitle);"]},{"name":"SelectATaskNotificationTitle","docName":null,"longname":"Notifications.SelectATaskNotificationTitle","description":"<p>Warning notification shown when End Selected Task shortcut is used with no task selected.\nIt renders <a href=\"Strings#SelectATaskNotificationTitle\">Strings.SelectATaskNotificationTitle</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.SelectATaskNotificationTitle);"]},{"name":"LocaleSelectorSuccess","docName":null,"longname":"Notifications.LocaleSelectorSuccess","description":"<p>Success notification shown when a user selects a locale.\nIt renders <a href=\"Strings#LocaleSelectorSetLocaleSuccess\">Strings.LocaleSelectorSetLocaleSuccess</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.LocaleSelectorSuccess);"]},{"name":"LocaleSelectorFailure","docName":null,"longname":"Notifications.LocaleSelectorFailure","description":"<p>Failure notification shown when changing locale fails\nIt renders <a href=\"Strings#LocaleSelectorSetLocaleFailure\">Strings.LocaleSelectorSetLocaleFailure</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.LocaleSelectorFailure);"]},{"name":"AddingCommentFailed","docName":null,"longname":"Notifications.AddingCommentFailed","description":"<p>Error notification shown when adding a comment in the conversation screen fails.\nIt renders <a href=\"Strings#AddingCommentFailed\">Strings.AddingCommentFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.AddingCommentFailed);"]},{"name":"AddingAssessmentFailed","docName":null,"longname":"Notifications.AddingAssessmentFailed","description":"<p>Error notification shown when adding an assessment in the conversation screen fails.\nIt renders <a href=\"Strings#AddingAssessmentFailed\">Strings.AddingAssessmentFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.AddingAssessmentFailed);"]},{"name":"GlobalSLSaveSuccess","docName":null,"longname":"Notifications.GlobalSLSaveSuccess","description":"<p>Notification shown when SL global metrics have been saved successfully.\nIt renders <a href=\"Strings#GlobalSLSuccessNotification\">Strings.GlobalSLSuccessNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.GlobalSLSaveSuccess);"]},{"name":"SLAPreferencesCustomLevelsSuccess","docName":null,"longname":"Notifications.SLAPreferencesCustomLevelsSuccess","description":"<p>Notification shown when custom service levels for a queue have been saved successfully.\nIt renders <a href=\"Strings#SLAPreferencesCustomLevelsSuccessNotification\">Strings.SLAPreferencesCustomLevelsSuccessNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.SLAPreferencesCustomLevelsSuccess);"]},{"name":"SLAPreferencesCustomLevelsError","docName":null,"longname":"Notifications.SLAPreferencesCustomLevelsError","description":"<p>Notification shown when SL global metrics have failed to be saved successfully\nIt renders <a href=\"Strings#SLAPreferencesCustomLevelsError\">Strings.SLAPreferencesCustomLevelsError</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.SLAPreferencesCustomLevelsError);"]},{"name":"FailedToSubscribeToQueueError","docName":null,"longname":"Notifications.FailedToSubscribeToQueueError","description":"<p>Notification shown when failed to subscribe to a selected queue\nIt renders <a href=\"Strings#FailedToSubscribeToQueueError\">Strings.FailedToSubscribeToQueueError</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.SLAPreferencesCustomLevelsError);"]},{"name":"MonitoringFailed","docName":null,"longname":"Notifications.MonitoringFailed","description":"<p>Error notification shown when an error occurs while starting monitoring a task.\nIt renders <a href=\"Strings#MonitoringFailedNotification\">Strings.MonitoringFailedNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.MonitoringFailed);"]},{"name":"ExternalWarmTransferFailed","docName":null,"longname":"Notifications.ExternalWarmTransferFailed","description":"<p>Notification shown when External Warm Transfer fails.\nIt renders <a href=\"Strings#ExternalWarmTransferFailed\">Strings.ExternalWarmTransferFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.ExternalWarmTransferFailed);"]},{"name":"FailedToFetchParticipants","docName":null,"longname":"Notifications.FailedToFetchParticipants","description":"<p>Notification shown when failing to fetch interaction participants.\nIt renders <a href=\"Strings#FailedToFetchParticipants\">Strings.FailedToFetchParticipants</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.FailedToFetchParticipants);"]},{"name":"PendingReservationsOnLogout","docName":null,"longname":"Notifications.PendingReservationsOnLogout","description":"<p>Error Notification shown when agents try to logout while having a pending reservation.\nIt renders <a href=\"Strings#PendingReservationsOnLogoutNotification\">Strings.PendingReservationsOnLogoutNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.PendingReservationsOnLogout);"]},{"name":"PendingReservationsOnActivityStateChange","docName":null,"longname":"Notifications.PendingReservationsOnActivityStateChange","description":"<p>Error notification shown when agents try to change activity state while having a pending reservation.\nIt renders <a href=\"Strings#PendingReservationsOnActivityStateChangeNotification\">Strings.PendingReservationsOnActivityStateChangeNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.activityCannotBeChangedWhenPendingTasks);"]},{"name":"WorkerActivityUpdateFailed","docName":null,"longname":"Notifications.WorkerActivityUpdateFailed","description":"<p>Error notification shown when agents fails to change activity state due to a service error.\nIt renders <a href=\"Strings#WorkerActivityUpdateFailedNotification\">Strings.WorkerActivityUpdateFailedNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.WorkerActivityUpdateFailed);"]},{"name":"SupervisorNotAuthorizedFailure","docName":null,"longname":"Notifications.SupervisorNotAuthorizedFailure","description":"<p>Error notification shown when supervisor fails to change agent activity state because supervisor is not authorized to do so.\nIt renders <a href=\"Strings#SupervisorNotAuthorizedFailedNotification\">Strings.SupervisorNotAuthorizedFailedNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.SupervisorNotAuthorizedFailure);"]},{"name":"TransferFailed","docName":null,"longname":"Notifications.TransferFailed","description":"<p>Error notification shown when a call transfer fails.\nIt renders <a href=\"Strings#TransferFailedNotification\">Strings.TransferFailedNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.TransferFailed, { reason: \"failed reason\"});"]},{"name":"taskCannotBeTransferred","docName":null,"longname":"Notifications.taskCannotBeTransferred","description":"<p>Error notification shown when a task cannot be transferred.\nIt renders <a href=\"Strings#TaskCannotBeTransferredNotification\">Strings.TaskCannotBeTransferredNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.TaskCannotBeTransferred);"]},{"name":"IncomingTask","docName":null,"longname":"Notifications.IncomingTask","description":"<p>Notification for incoming task, with most properties dependent on task channel in question.</p>","defaultvalue":null,"type":null,"properties":[{"name":"payload","type":{"names":["object"]},"description":"<p>Payload object.</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.IncomingTask, { task: taskObject });"]},{"name":"CannotChangeOtherWorkerActivity","docName":null,"longname":"Notifications.CannotChangeOtherWorkerActivity","description":"<p>Error notification shown when supervisor tries to change activity state of an agent with a pending reservation.\nIt renders <a href=\"Strings#CannotChangeOtherWorkerActivity\">Strings.CannotChangeOtherWorkerActivity</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.CannotChangeOtherWorkerActivity);"]},{"name":"StartOutboundEmailTaskFailed","docName":null,"longname":"Notifications.StartOutboundEmailTaskFailed","description":"<p>Error notification shown when an outbound email task fails.\nIt renders <a href=\"Strings#StartOutboundEmailTaskFailedNotification\">Strings.StartOutboundEmailTaskFailedNotification</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.StartOutboundEmailTaskFailed, { reason: \"failed reason\"});"]},{"name":"LeaveEmailConversationFailed","docName":null,"longname":"Notifications.LeaveEmailConversationFailed","description":"<p>Error notification shown when there is an error while leaving email conversation.\nIt renders <a href=\"Strings#LeaveEmailConversationFailed\">Strings.LeaveEmailConversationFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.LeaveEmailConversationFailed);"]},{"name":"PauseEmailConversationFailed","docName":null,"longname":"Notifications.PauseEmailConversationFailed","description":"<p>Error notification shown when there is an error while pausing an email conversation.\nIt renders <a href=\"Strings#PauseEmailConversationFailed\">Strings.PauseEmailConversationFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.PauseEmailConversationFailed);"]},{"name":"ResumeEmailConversationFailed","docName":null,"longname":"Notifications.ResumeEmailConversationFailed","description":"<p>Error notification shown when there is an error while resuming a paused email conversation.\nIt renders <a href=\"Strings#ResumeEmailConversationFailed\">Strings.ResumeEmailConversationFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.ResumeEmailConversationFailed);"]},{"name":"LeaveChannelFailed","docName":null,"longname":"Notifications.LeaveChannelFailed","description":"<p>Error notification shown when there is an error while leaving CBM conversation.\nIt renders <a href=\"Strings#LeaveChannelFailed\">Strings.LeaveChannelFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.LeaveChannelFailed);"]},{"name":"PauseChannelFailed","docName":null,"longname":"Notifications.PauseChannelFailed","description":"<p>Error notification shown when there is an error while pausing an CBM conversation.\nIt renders <a href=\"Strings#PauseChannelFailed\">Strings.PauseChannelFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.PauseChannelFailed);"]},{"name":"ResumeChannelFailed","docName":null,"longname":"Notifications.ResumeChannelFailed","description":"<p>Error notification shown when there is an error while resuming a paused CBM conversation.\nIt renders <a href=\"Strings#ResumeChannelFailed\">Strings.ResumeChannelFailed</a>.</p>","defaultvalue":null,"type":null,"properties":[],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds } from \"@twilio/flex-ui\";\nNotifications.showNotification(NotificationIds.ResumeChannelFailed);"]},{"name":"NewChatMessage","docName":null,"longname":"Notifications.NewChatMessage","description":"<p>Notification shown when new chat message is received\nIt renders title as <a href=\"Strings#NewChatMessageNotificationTitle\">Strings.NewChatMessageNotificationTitle</a>\nand body as <a href=\"Strings#NewChatMessageNotificationBody\">Strings.NewChatMessageNotificationBody</a>.</p>","defaultvalue":null,"type":null,"properties":[{"name":"payload","type":{"names":["object"]},"description":"<p>payload object</p>","optional":null,"defaultvalue":""},{"name":"payload.lastMessage","type":{"names":["ChatChannelState.MessageState"]},"description":"<p>last message object</p>","optional":null,"defaultvalue":""}],"params":null,"returns":null,"scope":"static","readonly":null,"kind":"member","examples":["import { Notifications, NotificationIds, StateHelper, ChatChannelHelper } from \"@twilio/flex-ui\";\nconst channelState = StateHelper.getChatChannelStateForTask(task);\nconst chatChannelHelper = new ChatChannelHelper(channelState);\n\nNotifications.showNotification(NotificationIds.NewChatMessage, {\n lastMessage: chatChannelHelper.lastMessage\n});"]}]},"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":"Notifications","docName":null}},
    "staticQueryHashes": ["2573139180","3167116022","426031883"]}