@carbon/ai-chat 0.1.7-test-no-cjs → 0.2.0-0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docs/carbon-chat-docs.js +2 -0
- package/dist/docs/carbon-chat-docs.js.LICENSE.txt +118 -0
- package/dist/docs/carbon-chat.html +8 -0
- package/dist/docs/carbon-tsdocs/.nojekyll +1 -0
- package/dist/docs/carbon-tsdocs/assets/hierarchy.js +1 -0
- package/dist/docs/carbon-tsdocs/assets/highlight.css +22 -0
- package/dist/docs/carbon-tsdocs/assets/icons.js +18 -0
- package/dist/docs/carbon-tsdocs/assets/icons.svg +1 -0
- package/dist/docs/carbon-tsdocs/assets/main.js +60 -0
- package/dist/docs/carbon-tsdocs/assets/navigation.js +1 -0
- package/dist/docs/carbon-tsdocs/assets/search.js +1 -0
- package/dist/docs/carbon-tsdocs/assets/style.css +1611 -0
- package/dist/docs/carbon-tsdocs/enums/AgentMessageType.html +20 -0
- package/dist/docs/carbon-tsdocs/enums/AgentsOnlineStatus.html +9 -0
- package/dist/docs/carbon-tsdocs/enums/BusEventType.html +67 -0
- package/dist/docs/carbon-tsdocs/enums/ButtonItemKind.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/ButtonItemType.html +5 -0
- package/dist/docs/carbon-tsdocs/enums/CarbonTheme.html +7 -0
- package/dist/docs/carbon-tsdocs/enums/CatastrophicErrorType.html +11 -0
- package/dist/docs/carbon-tsdocs/enums/ChainOfThoughtStepStatus.html +5 -0
- package/dist/docs/carbon-tsdocs/enums/ChatHeaderObjectType.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/CornersType.html +4 -0
- package/dist/docs/carbon-tsdocs/enums/CustomEventType.html +3 -0
- package/dist/docs/carbon-tsdocs/enums/ErrorType.html +12 -0
- package/dist/docs/carbon-tsdocs/enums/FeedbackInteractionType.html +10 -0
- package/dist/docs/carbon-tsdocs/enums/FileStatusValue.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/HomeScreenBackgroundType.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/IFrameItemDisplayOption.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/LauncherType.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/MessageInputType.html +8 -0
- package/dist/docs/carbon-tsdocs/enums/MessageResponseTypes.html +36 -0
- package/dist/docs/carbon-tsdocs/enums/MessageSendSource.html +45 -0
- package/dist/docs/carbon-tsdocs/enums/MinimizeButtonIconType.html +9 -0
- package/dist/docs/carbon-tsdocs/enums/OnErrorType.html +27 -0
- package/dist/docs/carbon-tsdocs/enums/OptionItemPreference.html +6 -0
- package/dist/docs/carbon-tsdocs/enums/ScreenShareState.html +10 -0
- package/dist/docs/carbon-tsdocs/enums/TourEndReason.html +5 -0
- package/dist/docs/carbon-tsdocs/enums/TourStartReason.html +9 -0
- package/dist/docs/carbon-tsdocs/enums/ViewChangeReason.html +47 -0
- package/dist/docs/carbon-tsdocs/enums/ViewType.html +10 -0
- package/dist/docs/carbon-tsdocs/enums/WriteableElementName.html +16 -0
- package/dist/docs/carbon-tsdocs/functions/ChatContainer.html +10 -0
- package/dist/docs/carbon-tsdocs/functions/ChatCustomElement.html +8 -0
- package/dist/docs/carbon-tsdocs/hierarchy.html +1 -0
- package/dist/docs/carbon-tsdocs/index.html +1 -0
- package/dist/docs/carbon-tsdocs/interfaces/AdditionalDataToAgent.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/AgentAppConfig.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/AgentAppInfo.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/AgentAvailability.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/AgentProfile.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/BaseMessageInput.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEvent.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentAreAnyAgentsOnline.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentEndChat.html +10 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreEndChat.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreReceive.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreSend.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreSessionHistory.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreStartChat.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentReceive.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentSend.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventChatReady.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventChunkUserDefinedResponse.html +39 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventClosePanelButtonClicked.html +4 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelClose.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelOpen.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelPreClose.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelPreOpen.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventFeedback.html +17 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerAuthError.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerAuthProvider.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerGetAuthCode.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerLoggedOut.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerReauthenticate.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventHistoryBegin.html +15 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventHistoryEnd.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventMessageItemCustom.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventNiceDFOGetAuthCode.html +7 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventPreReceive.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventPreReset.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventPreSend.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventReceive.html +4 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventReset.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventSend.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventTourEnd.html +7 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventTourStart.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventTourStep.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventUserDefinedResponse.html +10 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventViewChange.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/BusEventViewPreChange.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/ButtonItem.html +34 -0
- package/dist/docs/carbon-tsdocs/interfaces/CarouselItem.html +15 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChainOfThoughtStep.html +20 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatContainerProps.html +14 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatCustomElementProps.html +31 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderAvatarConfig.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderButton.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderConfig.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderGroupMenu.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderGroupMenuItem.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderLink.html +10 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderMenu.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatInstance.html +146 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceMessaging.html +16 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceNotifications.html +7 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceServiceDeskActions.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceTours.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/Chunk.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/CompleteItemChunk.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/ConnectToAgentItem.html +24 -0
- package/dist/docs/carbon-tsdocs/interfaces/ConnectToAgentItemTransferInfo.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/ConnectingErrorInfo.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItem.html +22 -0
- package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItemCitation.html +18 -0
- package/dist/docs/carbon-tsdocs/interfaces/CustomMenuOption.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/CustomPanelConfigOptions.html +29 -0
- package/dist/docs/carbon-tsdocs/interfaces/CustomPanelInstance.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/CustomPanels.html +4 -0
- package/dist/docs/carbon-tsdocs/interfaces/CustomSendMessageOptions.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/DisclaimerPublicConfig.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/DisconnectedErrorInfo.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/EndChatInfo.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/EventHandlers.html +16 -0
- package/dist/docs/carbon-tsdocs/interfaces/EventInput.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/EventInputData.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/FileUpload.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/FinalResponseChunk.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/GenericItem.html +14 -0
- package/dist/docs/carbon-tsdocs/interfaces/GenericItemMessageFeedbackOptions.html +27 -0
- package/dist/docs/carbon-tsdocs/interfaces/GenericItemMessageOptions.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/GenesysMessengerConfig.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/GridItem.html +23 -0
- package/dist/docs/carbon-tsdocs/interfaces/HasAddRemoveClassName.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/HeaderConfig.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/HistoryItem.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/HomeScreenConfig.html +17 -0
- package/dist/docs/carbon-tsdocs/interfaces/HomeScreenStarterButton.html +7 -0
- package/dist/docs/carbon-tsdocs/interfaces/HomeScreenStarterButtons.html +4 -0
- package/dist/docs/carbon-tsdocs/interfaces/IFrameItem.html +27 -0
- package/dist/docs/carbon-tsdocs/interfaces/InlineErrorItem.html +22 -0
- package/dist/docs/carbon-tsdocs/interfaces/InstanceElements.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/InstanceInputElement.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/ItemStreamingMetadata.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/LayoutConfig.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/MediaItem.html +27 -0
- package/dist/docs/carbon-tsdocs/interfaces/MediaItemDimensions.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageContext.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageGlobalContext.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageHistory.html +18 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageInput.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageItemPanelInfo.html +11 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageOutput.html +4 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageRequest.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageResponse.html +12 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageSkillContext.html +3 -0
- package/dist/docs/carbon-tsdocs/interfaces/MessageSystemContext.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/NiceDFOConfig.html +14 -0
- package/dist/docs/carbon-tsdocs/interfaces/NotificationMessage.html +15 -0
- package/dist/docs/carbon-tsdocs/interfaces/OnErrorData.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/Option.html +7 -0
- package/dist/docs/carbon-tsdocs/interfaces/OptionItem.html +23 -0
- package/dist/docs/carbon-tsdocs/interfaces/PageLinkConfig.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/PageLinkIDConfig.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/PartialItemChunk.html +38 -0
- package/dist/docs/carbon-tsdocs/interfaces/PauseItem.html +18 -0
- package/dist/docs/carbon-tsdocs/interfaces/PublicConfig.html +75 -0
- package/dist/docs/carbon-tsdocs/interfaces/PublicConfigMessaging.html +24 -0
- package/dist/docs/carbon-tsdocs/interfaces/PublicWebChatServiceDeskState.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/PublicWebChatState.html +21 -0
- package/dist/docs/carbon-tsdocs/interfaces/RenderUserDefinedState.html +41 -0
- package/dist/docs/carbon-tsdocs/interfaces/SendOptions.html +10 -0
- package/dist/docs/carbon-tsdocs/interfaces/ServiceDesk.html +74 -0
- package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskCallback.html +81 -0
- package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskCapabilities.html +9 -0
- package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskFactoryParameters.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskPublicConfig.html +25 -0
- package/dist/docs/carbon-tsdocs/interfaces/StartChatOptions.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/TableItem.html +22 -0
- package/dist/docs/carbon-tsdocs/interfaces/TableItemRow.html +5 -0
- package/dist/docs/carbon-tsdocs/interfaces/TextItem.html +19 -0
- package/dist/docs/carbon-tsdocs/interfaces/ThemeConfig.html +16 -0
- package/dist/docs/carbon-tsdocs/interfaces/TourStepGenericItem.html +17 -0
- package/dist/docs/carbon-tsdocs/interfaces/TypeAndHandler.html +6 -0
- package/dist/docs/carbon-tsdocs/interfaces/UpdateHistoryEvent.html +10 -0
- package/dist/docs/carbon-tsdocs/interfaces/UserDefinedItem.html +13 -0
- package/dist/docs/carbon-tsdocs/interfaces/UserMessageErrorInfo.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/ViewState.html +8 -0
- package/dist/docs/carbon-tsdocs/interfaces/WithBodyAndFooter.html +5 -0
- package/dist/docs/carbon-tsdocs/types/AudioItem.html +2 -0
- package/dist/docs/carbon-tsdocs/types/CardItem.html +1 -0
- package/dist/docs/carbon-tsdocs/types/ChangeFunction.html +1 -0
- package/dist/docs/carbon-tsdocs/types/ChatHeaderMenuItemTypes.html +2 -0
- package/dist/docs/carbon-tsdocs/types/ChatHeaderObjectTypes.html +2 -0
- package/dist/docs/carbon-tsdocs/types/DateItem.html +3 -0
- package/dist/docs/carbon-tsdocs/types/EventBusHandler.html +3 -0
- package/dist/docs/carbon-tsdocs/types/HorizontalCellAlignment.html +1 -0
- package/dist/docs/carbon-tsdocs/types/ImageItem.html +2 -0
- package/dist/docs/carbon-tsdocs/types/IncreaseOrDecrease.html +1 -0
- package/dist/docs/carbon-tsdocs/types/Message.html +2 -0
- package/dist/docs/carbon-tsdocs/types/PartialOrCompleteItemChunk.html +1 -0
- package/dist/docs/carbon-tsdocs/types/RenderUserDefinedResponse.html +6 -0
- package/dist/docs/carbon-tsdocs/types/RenderWriteableElementResponse.html +2 -0
- package/dist/docs/carbon-tsdocs/types/ServiceDeskErrorInfo.html +3 -0
- package/dist/docs/carbon-tsdocs/types/StreamChunk.html +1 -0
- package/dist/docs/carbon-tsdocs/types/TableItemCell.html +1 -0
- package/dist/docs/carbon-tsdocs/types/TableItemRowExpandableSectionItem.html +1 -0
- package/dist/docs/carbon-tsdocs/types/VerticalCellAlignment.html +1 -0
- package/dist/docs/carbon-tsdocs/types/VideoItem.html +2 -0
- package/dist/docs/carbon-tsdocs/types/WriteableElements.html +3 -0
- package/dist/es/AppContainer.js +1670 -6105
- package/dist/es/Carousel.js +23 -36
- package/dist/es/GenesysMessengerServiceDesk.js +23 -36
- package/dist/es/HumanAgentServiceImpl.js +45 -70
- package/dist/es/NiceDFOServiceDesk.js +23 -50
- package/dist/es/PDFViewerContainer.js +23 -64
- package/dist/es/ReactPlayer.js +21 -35
- package/dist/es/SFServiceDesk.js +23 -37
- package/dist/es/ServiceDeskImpl.js +21 -35
- package/dist/es/Table.js +26 -97
- package/dist/es/ZendeskServiceDesk.js +23 -53
- package/dist/es/_node-resolve_empty.js +21 -21
- package/dist/es/aiChatEntry.js +24 -75
- package/dist/es/ar-dz.js +22 -22
- package/dist/es/ar-kw.js +22 -22
- package/dist/es/ar-ly.js +22 -22
- package/dist/es/ar-ma.js +22 -22
- package/dist/es/ar-sa.js +22 -22
- package/dist/es/ar-tn.js +22 -22
- package/dist/es/ar.js +22 -22
- package/dist/es/ar2.js +46 -24
- package/dist/es/cds-aichat-container.js +23 -50
- package/dist/es/cds-aichat-custom-element.js +22 -35
- package/dist/es/cs.js +22 -22
- package/dist/es/cs2.js +45 -23
- package/dist/es/de-at.js +22 -22
- package/dist/es/de-ch.js +22 -22
- package/dist/es/de.js +22 -22
- package/dist/es/de2.js +45 -23
- package/dist/es/en-au.js +22 -22
- package/dist/es/en-ca.js +22 -22
- package/dist/es/en-gb.js +22 -22
- package/dist/es/en-ie.js +22 -22
- package/dist/es/en-il.js +22 -22
- package/dist/es/en-nz.js +22 -22
- package/dist/es/es-do.js +22 -22
- package/dist/es/es-us.js +22 -22
- package/dist/es/es.js +22 -22
- package/dist/es/es2.js +45 -23
- package/dist/es/export.js +58 -23
- package/dist/es/export.legacy.js +58 -23
- package/dist/es/fr-ca.js +22 -22
- package/dist/es/fr-ch.js +22 -22
- package/dist/es/fr.js +22 -22
- package/dist/es/fr2.js +45 -23
- package/dist/es/it-ch.js +22 -22
- package/dist/es/it.js +22 -22
- package/dist/es/it2.js +45 -23
- package/dist/es/ja.js +22 -22
- package/dist/es/ja2.js +45 -23
- package/dist/es/ko.js +22 -22
- package/dist/es/ko2.js +45 -23
- package/dist/es/mockServiceDesk.js +23 -36
- package/dist/es/nl.js +22 -22
- package/dist/es/nl2.js +45 -23
- package/dist/es/pt-br.js +22 -22
- package/dist/es/pt-br2.js +45 -23
- package/dist/es/pt.js +22 -22
- package/dist/es/{fontUtils.js → scriptRender.js} +87 -35
- package/dist/es/zh-cn.js +22 -22
- package/dist/es/zh-tw.js +22 -22
- package/dist/es/zh-tw2.js +45 -23
- package/dist/es/zh.js +45 -23
- package/dist/types/aiChatEntry.d.ts +39 -10
- package/package.json +24 -7
- package/dist/es/render.js +0 -105
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MessageResponseTypes | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="MessageResponseTypes.html">MessageResponseTypes</a></li></ul><h1>Enumeration MessageResponseTypes</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The set of possible message types in a response from IBM watsonx Assistant.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="MessageResponseTypes.html#audio" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>AUDIO</span></a>
|
|
3
|
+
<a href="MessageResponseTypes.html#button" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>BUTTON</span></a>
|
|
4
|
+
<a href="MessageResponseTypes.html#card" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>CARD</span></a>
|
|
5
|
+
<a href="MessageResponseTypes.html#carousel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>CAROUSEL</span></a>
|
|
6
|
+
<a href="MessageResponseTypes.html#connect_to_agent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>CONNECT_<wbr/>TO_<wbr/>AGENT</span></a>
|
|
7
|
+
<a href="MessageResponseTypes.html#date" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DATE</span></a>
|
|
8
|
+
<a href="MessageResponseTypes.html#grid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>GRID</span></a>
|
|
9
|
+
<a href="MessageResponseTypes.html#iframe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>IFRAME</span></a>
|
|
10
|
+
<a href="MessageResponseTypes.html#image" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>IMAGE</span></a>
|
|
11
|
+
<a href="MessageResponseTypes.html#inline_error" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>INLINE_<wbr/>ERROR</span></a>
|
|
12
|
+
<a href="MessageResponseTypes.html#option" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>OPTION</span></a>
|
|
13
|
+
<a href="MessageResponseTypes.html#pause" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>PAUSE</span></a>
|
|
14
|
+
<a href="MessageResponseTypes.html#table" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>TABLE</span></a>
|
|
15
|
+
<a href="MessageResponseTypes.html#text" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>TEXT</span></a>
|
|
16
|
+
<a href="MessageResponseTypes.html#user_defined" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>USER_<wbr/>DEFINED</span></a>
|
|
17
|
+
<a href="MessageResponseTypes.html#video" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>VIDEO</span></a>
|
|
18
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumeration Members</h2></summary><section><section class="tsd-panel tsd-member"><a id="audio" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>AUDIO</span><a href="#audio" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">AUDIO</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"audio"</span></div><div class="tsd-comment tsd-typography"><p>Displays an audio clip to the user using an audio player.</p>
|
|
19
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="button" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>BUTTON</span><a href="#button" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">BUTTON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"button"</span></div><div class="tsd-comment tsd-typography"><p>Displays a button that can either send a message back to the backend, open a url, or throw a client side event.</p>
|
|
20
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="card" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>CARD</span><a href="#card" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">CARD</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"card"</span></div><div class="tsd-comment tsd-typography"><p>Displays a card that can contain other response types.</p>
|
|
21
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="carousel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>CAROUSEL</span><a href="#carousel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">CAROUSEL</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"carousel"</span></div><div class="tsd-comment tsd-typography"><p>Displays a carousel of cards that can contain other response types.</p>
|
|
22
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="connect_to_agent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>CONNECT_<wbr/>TO_<wbr/>AGENT</span><a href="#connect_to_agent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">CONNECT_TO_AGENT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"connect_to_agent"</span></div><div class="tsd-comment tsd-typography"><p>Indicates that the conversation should be escalated to a human agent and offers that opportunity to the user.</p>
|
|
23
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="date" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DATE</span><a href="#date" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DATE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"date"</span></div><div class="tsd-comment tsd-typography"><p>Asks the user to provide a date. This may result in a date picker being presented to the user.</p>
|
|
24
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="grid" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>GRID</span><a href="#grid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">GRID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"grid"</span></div><div class="tsd-comment tsd-typography"><p>Ability to layout response types inside a grid.</p>
|
|
25
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="iframe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>IFRAME</span><a href="#iframe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">IFRAME</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"iframe"</span></div><div class="tsd-comment tsd-typography"><p>Displays the contents of an iframe to the user.</p>
|
|
26
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="image" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>IMAGE</span><a href="#image" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">IMAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"image"</span></div><div class="tsd-comment tsd-typography"><p>Displays an image to the user.</p>
|
|
27
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="inline_error" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>INLINE_<wbr/>ERROR</span><a href="#inline_error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">INLINE_ERROR</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"inline_error"</span></div><div class="tsd-comment tsd-typography"><p>Displays a general error message to the user and include developer info to be logged and to debug.</p>
|
|
28
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="option" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>OPTION</span><a href="#option" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">OPTION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"option"</span></div><div class="tsd-comment tsd-typography"><p>A response that requests the user choose an option from a list. The list of options may be presented as a list
|
|
29
|
+
of buttons or it may be from a drop-down.</p>
|
|
30
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="pause" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PAUSE</span><a href="#pause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">PAUSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"pause"</span></div><div class="tsd-comment tsd-typography"><p>Indicates that the chat should display a pause at this point in the conversation before displaying additional
|
|
31
|
+
items.</p>
|
|
32
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="table" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>TABLE</span><a href="#table" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">TABLE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"table"</span></div><div class="tsd-comment tsd-typography"><p>Displays a table of data to the user.</p>
|
|
33
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="text" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>TEXT</span><a href="#text" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">TEXT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"text"</span></div><div class="tsd-comment tsd-typography"><p>Represents a basic text response. The given text may contain rich content such as markdown.</p>
|
|
34
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="user_defined" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>USER_<wbr/>DEFINED</span><a href="#user_defined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">USER_DEFINED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"user_defined"</span></div><div class="tsd-comment tsd-typography"><p>A user defined response will be displayed according to custom logic in the client.</p>
|
|
35
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="video" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>VIDEO</span><a href="#video" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">VIDEO</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"video"</span></div><div class="tsd-comment tsd-typography"><p>Displays a video to the user using a video player.</p>
|
|
36
|
+
</div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumeration Members</summary><div><a href="#audio" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>AUDIO</span></a><a href="#button" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>BUTTON</span></a><a href="#card" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>CARD</span></a><a href="#carousel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>CAROUSEL</span></a><a href="#connect_to_agent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>CONNECT_<wbr/>TO_<wbr/>AGENT</span></a><a href="#date" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DATE</span></a><a href="#grid" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>GRID</span></a><a href="#iframe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>IFRAME</span></a><a href="#image" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>IMAGE</span></a><a href="#inline_error" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>INLINE_<wbr/>ERROR</span></a><a href="#option" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>OPTION</span></a><a href="#pause" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>PAUSE</span></a><a href="#table" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>TABLE</span></a><a href="#text" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>TEXT</span></a><a href="#user_defined" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>USER_<wbr/>DEFINED</span></a><a href="#video" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>VIDEO</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MessageSendSource | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="MessageSendSource.html">MessageSendSource</a></li></ul><h1>Enumeration MessageSendSource</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The different sources that can cause a send event to occur.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="MessageSendSource.html#date_picker" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DATE_<wbr/>PICKER</span></a>
|
|
3
|
+
<a href="MessageSendSource.html#disambiguation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DISAMBIGUATION</span></a>
|
|
4
|
+
<a href="MessageSendSource.html#event" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVENT</span></a>
|
|
5
|
+
<a href="MessageSendSource.html#history_update" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>HISTORY_<wbr/>UPDATE</span></a>
|
|
6
|
+
<a href="MessageSendSource.html#home_screen_input" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>HOME_<wbr/>SCREEN_<wbr/>INPUT</span></a>
|
|
7
|
+
<a href="MessageSendSource.html#home_screen_starter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>HOME_<wbr/>SCREEN_<wbr/>STARTER</span></a>
|
|
8
|
+
<a href="MessageSendSource.html#hydrate_resend" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>HYDRATE_<wbr/>RESEND</span></a>
|
|
9
|
+
<a href="MessageSendSource.html#instance_send" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>INSTANCE_<wbr/>SEND</span></a>
|
|
10
|
+
<a href="MessageSendSource.html#link_id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>LINK_<wbr/>ID</span></a>
|
|
11
|
+
<a href="MessageSendSource.html#message_input" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>MESSAGE_<wbr/>INPUT</span></a>
|
|
12
|
+
<a href="MessageSendSource.html#option_button" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>OPTION_<wbr/>BUTTON</span></a>
|
|
13
|
+
<a href="MessageSendSource.html#option_drop_down" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>OPTION_<wbr/>DROP_<wbr/>DOWN</span></a>
|
|
14
|
+
<a href="MessageSendSource.html#other" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>OTHER</span></a>
|
|
15
|
+
<a href="MessageSendSource.html#post_back_button" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>POST_<wbr/>BACK_<wbr/>BUTTON</span></a>
|
|
16
|
+
<a href="MessageSendSource.html#skip_user_input" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SKIP_<wbr/>USER_<wbr/>INPUT</span></a>
|
|
17
|
+
<a href="MessageSendSource.html#start_tour_method" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>START_<wbr/>TOUR_<wbr/>METHOD</span></a>
|
|
18
|
+
<a href="MessageSendSource.html#suggestions_3rd_strike" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SUGGESTIONS_<wbr/>3RD_<wbr/>STRIKE</span></a>
|
|
19
|
+
<a href="MessageSendSource.html#suggestions_contact" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SUGGESTIONS_<wbr/>CONTACT</span></a>
|
|
20
|
+
<a href="MessageSendSource.html#suggestions_message" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SUGGESTIONS_<wbr/>MESSAGE</span></a>
|
|
21
|
+
<a href="MessageSendSource.html#suggestions_starter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SUGGESTIONS_<wbr/>STARTER</span></a>
|
|
22
|
+
<a href="MessageSendSource.html#welcome_request" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>WELCOME_<wbr/>REQUEST</span></a>
|
|
23
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumeration Members</h2></summary><section><section class="tsd-panel tsd-member"><a id="date_picker" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DATE_<wbr/>PICKER</span><a href="#date_picker" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DATE_PICKER</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"datePicker"</span></div><div class="tsd-comment tsd-typography"><p>The user chose a value from the date picker.</p>
|
|
24
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="disambiguation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DISAMBIGUATION</span><a href="#disambiguation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DISAMBIGUATION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"disambiguation"</span></div><div class="tsd-comment tsd-typography"><p>The user made a choice from a disambiguation response.</p>
|
|
25
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="event" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>EVENT</span><a href="#event" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">EVENT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"event"</span></div><div class="tsd-comment tsd-typography"><p>This is used for message events.</p>
|
|
26
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="history_update" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>HISTORY_<wbr/>UPDATE</span><a href="#history_update" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">HISTORY_UPDATE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"historyUpdate"</span></div><div class="tsd-comment tsd-typography"><p>The message was sent as an event history update.</p>
|
|
27
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="home_screen_input" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>HOME_<wbr/>SCREEN_<wbr/>INPUT</span><a href="#home_screen_input" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">HOME_SCREEN_INPUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"homeScreenInput"</span></div><div class="tsd-comment tsd-typography"><p>The user has entered a value from the input on the home screen.</p>
|
|
28
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="home_screen_starter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>HOME_<wbr/>SCREEN_<wbr/>STARTER</span><a href="#home_screen_starter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">HOME_SCREEN_STARTER</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"homeScreenStarter"</span></div><div class="tsd-comment tsd-typography"><p>The user clicked a starter from the home screen.</p>
|
|
29
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="hydrate_resend" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>HYDRATE_<wbr/>RESEND</span><a href="#hydrate_resend" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">HYDRATE_RESEND</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"hydrateResend"</span></div><div class="tsd-comment tsd-typography"><p>The message was sent as an automatic re-send when web chat is loaded. This occurs when web chat sees that the
|
|
30
|
+
last message request did not receive a response.</p>
|
|
31
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="instance_send" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>INSTANCE_<wbr/>SEND</span><a href="#instance_send" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">INSTANCE_SEND</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"instanceSend"</span></div><div class="tsd-comment tsd-typography"><p>An external call to the public "instance.send" method was made.</p>
|
|
32
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="link_id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>LINK_<wbr/>ID</span><a href="#link_id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">LINK_ID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"linkID"</span></div><div class="tsd-comment tsd-typography"><p>A link ID was detected on the page and an automatic "welcome request" was sent.</p>
|
|
33
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="message_input" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>MESSAGE_<wbr/>INPUT</span><a href="#message_input" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">MESSAGE_INPUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"messageInput"</span></div><div class="tsd-comment tsd-typography"><p>The user has entered a value from the main input on the message list.</p>
|
|
34
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="option_button" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>OPTION_<wbr/>BUTTON</span><a href="#option_button" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">OPTION_BUTTON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"optionButton"</span></div><div class="tsd-comment tsd-typography"><p>The user clicked a button from an option response.</p>
|
|
35
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="option_drop_down" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>OPTION_<wbr/>DROP_<wbr/>DOWN</span><a href="#option_drop_down" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">OPTION_DROP_DOWN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"optionDropDown"</span></div><div class="tsd-comment tsd-typography"><p>The user selected a value from a dropdown for an option response.</p>
|
|
36
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="other" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>OTHER</span><a href="#other" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">OTHER</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"other"</span></div><div class="tsd-comment tsd-typography"><p>Some other source.</p>
|
|
37
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="post_back_button" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>POST_<wbr/>BACK_<wbr/>BUTTON</span><a href="#post_back_button" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">POST_BACK_BUTTON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"postBackButton"</span></div><div class="tsd-comment tsd-typography"><p>The user clicked a post back button from a button response.</p>
|
|
38
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="skip_user_input" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>SKIP_<wbr/>USER_<wbr/>INPUT</span><a href="#skip_user_input" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">SKIP_USER_INPUT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"skipUserInput"</span></div><div class="tsd-comment tsd-typography"><p>The automatic follow-up message that occurs after a skip-user-input response.</p>
|
|
39
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="start_tour_method" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>START_<wbr/>TOUR_<wbr/>METHOD</span><a href="#start_tour_method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">START_TOUR_METHOD</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"startTourMethod"</span></div><div class="tsd-comment tsd-typography"><p>The startTour method has called.</p>
|
|
40
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="suggestions_3rd_strike" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>SUGGESTIONS_<wbr/>3RD_<wbr/>STRIKE</span><a href="#suggestions_3rd_strike" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">SUGGESTIONS_3RD_STRIKE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"suggestions3rdStrike"</span></div><div class="tsd-comment tsd-typography"><p>A 3rd strike occurred and an automatic suggestions contact message was sent.</p>
|
|
41
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="suggestions_contact" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>SUGGESTIONS_<wbr/>CONTACT</span><a href="#suggestions_contact" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">SUGGESTIONS_CONTACT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"suggestionsContact"</span></div><div class="tsd-comment tsd-typography"><p>The user chose the contact option from the suggestions menu.</p>
|
|
42
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="suggestions_message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>SUGGESTIONS_<wbr/>MESSAGE</span><a href="#suggestions_message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">SUGGESTIONS_MESSAGE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"suggestionsMessage"</span></div><div class="tsd-comment tsd-typography"><p>The user chose an alternate response message from the suggestions menu.</p>
|
|
43
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="suggestions_starter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>SUGGESTIONS_<wbr/>STARTER</span><a href="#suggestions_starter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">SUGGESTIONS_STARTER</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"suggestionsStarter"</span></div><div class="tsd-comment tsd-typography"><p>The user chose a home screen starter from the suggestions menu.</p>
|
|
44
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="welcome_request" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>WELCOME_<wbr/>REQUEST</span><a href="#welcome_request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">WELCOME_REQUEST</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"welcomeRequest"</span></div><div class="tsd-comment tsd-typography"><p>A default request for the welcome message was made.</p>
|
|
45
|
+
</div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumeration Members</summary><div><a href="#date_picker" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DATE_<wbr/>PICKER</span></a><a href="#disambiguation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DISAMBIGUATION</span></a><a href="#event" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>EVENT</span></a><a href="#history_update" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>HISTORY_<wbr/>UPDATE</span></a><a href="#home_screen_input" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>HOME_<wbr/>SCREEN_<wbr/>INPUT</span></a><a href="#home_screen_starter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>HOME_<wbr/>SCREEN_<wbr/>STARTER</span></a><a href="#hydrate_resend" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>HYDRATE_<wbr/>RESEND</span></a><a href="#instance_send" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>INSTANCE_<wbr/>SEND</span></a><a href="#link_id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>LINK_<wbr/>ID</span></a><a href="#message_input" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>MESSAGE_<wbr/>INPUT</span></a><a href="#option_button" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>OPTION_<wbr/>BUTTON</span></a><a href="#option_drop_down" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>OPTION_<wbr/>DROP_<wbr/>DOWN</span></a><a href="#other" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>OTHER</span></a><a href="#post_back_button" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>POST_<wbr/>BACK_<wbr/>BUTTON</span></a><a href="#skip_user_input" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SKIP_<wbr/>USER_<wbr/>INPUT</span></a><a href="#start_tour_method" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>START_<wbr/>TOUR_<wbr/>METHOD</span></a><a href="#suggestions_3rd_strike" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SUGGESTIONS_<wbr/>3RD_<wbr/>STRIKE</span></a><a href="#suggestions_contact" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SUGGESTIONS_<wbr/>CONTACT</span></a><a href="#suggestions_message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SUGGESTIONS_<wbr/>MESSAGE</span></a><a href="#suggestions_starter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SUGGESTIONS_<wbr/>STARTER</span></a><a href="#welcome_request" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>WELCOME_<wbr/>REQUEST</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MinimizeButtonIconType | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="MinimizeButtonIconType.html">MinimizeButtonIconType</a></li></ul><h1>Enumeration MinimizeButtonIconType</h1></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="MinimizeButtonIconType.html#close" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>CLOSE</span></a>
|
|
2
|
+
<a href="MinimizeButtonIconType.html#minimize" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>MINIMIZE</span></a>
|
|
3
|
+
<a href="MinimizeButtonIconType.html#side_panel_left" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SIDE_<wbr/>PANEL_<wbr/>LEFT</span></a>
|
|
4
|
+
<a href="MinimizeButtonIconType.html#side_panel_right" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SIDE_<wbr/>PANEL_<wbr/>RIGHT</span></a>
|
|
5
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumeration Members</h2></summary><section><section class="tsd-panel tsd-member"><a id="close" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>CLOSE</span><a href="#close" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">CLOSE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"close"</span></div><div class="tsd-comment tsd-typography"><p>This shows an "X" icon.</p>
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="minimize" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>MINIMIZE</span><a href="#minimize" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">MINIMIZE</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"minimize"</span></div><div class="tsd-comment tsd-typography"><p>This shows a "-" icon.</p>
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="side_panel_left" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>SIDE_<wbr/>PANEL_<wbr/>LEFT</span><a href="#side_panel_left" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">SIDE_PANEL_LEFT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"side-panel-left"</span></div><div class="tsd-comment tsd-typography"><p>This shows an icon that indicates that the web chat can be collapsed into a side panel.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="side_panel_right" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>SIDE_<wbr/>PANEL_<wbr/>RIGHT</span><a href="#side_panel_right" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">SIDE_PANEL_RIGHT</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"side-panel-right"</span></div><div class="tsd-comment tsd-typography"><p>This shows an icon that indicates that the web chat can be collapsed into a side panel.</p>
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumeration Members</summary><div><a href="#close" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>CLOSE</span></a><a href="#minimize" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>MINIMIZE</span></a><a href="#side_panel_left" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SIDE_<wbr/>PANEL_<wbr/>LEFT</span></a><a href="#side_panel_right" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SIDE_<wbr/>PANEL_<wbr/>RIGHT</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OnErrorType | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="OnErrorType.html">OnErrorType</a></li></ul><h1>Enumeration OnErrorType</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The different categories of errors that the system can record. These values are published for end user consumption.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="OnErrorType.html#agent_app_expired_session" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>AGENT_<wbr/>APP_<wbr/>EXPIRED_<wbr/>SESSION</span></a>
|
|
3
|
+
<a href="OnErrorType.html#hydration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>HYDRATION</span></a>
|
|
4
|
+
<a href="OnErrorType.html#identity_token" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>IDENTITY_<wbr/>TOKEN</span></a>
|
|
5
|
+
<a href="OnErrorType.html#initial_config" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>INITIAL_<wbr/>CONFIG</span></a>
|
|
6
|
+
<a href="OnErrorType.html#integration_error" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>INTEGRATION_<wbr/>ERROR</span></a>
|
|
7
|
+
<a href="OnErrorType.html#mcsp_identity_token" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>MCSP_<wbr/>IDENTITY_<wbr/>TOKEN</span></a>
|
|
8
|
+
<a href="OnErrorType.html#message_communication" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>MESSAGE_<wbr/>COMMUNICATION</span></a>
|
|
9
|
+
<a href="OnErrorType.html#open_config" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>OPEN_<wbr/>CONFIG</span></a>
|
|
10
|
+
<a href="OnErrorType.html#preview_link_security" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>PREVIEW_<wbr/>LINK_<wbr/>SECURITY</span></a>
|
|
11
|
+
<a href="OnErrorType.html#render" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>RENDER</span></a>
|
|
12
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumeration Members</h2></summary><section><section class="tsd-panel tsd-member"><a id="agent_app_expired_session" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>AGENT_<wbr/>APP_<wbr/>EXPIRED_<wbr/>SESSION</span><a href="#agent_app_expired_session" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">AGENT_APP_EXPIRED_SESSION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"AGENT_APP_EXPIRED_SESSION"</span></div><div class="tsd-comment tsd-typography"><p>The agent in the service desk waited too long to pick up the request and the session has expired so history cannot
|
|
13
|
+
be fetched.</p>
|
|
14
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="hydration" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>HYDRATION</span><a href="#hydration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">HYDRATION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"HYDRATION"</span></div><div class="tsd-comment tsd-typography"><p>This indicates that some error occurred while trying to hydrate web chat. This will prevent web chat from
|
|
15
|
+
functioning.</p>
|
|
16
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="identity_token" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>IDENTITY_<wbr/>TOKEN</span><a href="#identity_token" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">IDENTITY_TOKEN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"IDENTITY_TOKEN"</span></div><div class="tsd-comment tsd-typography"><p>This indicates an error with the identity token.</p>
|
|
17
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="initial_config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>INITIAL_<wbr/>CONFIG</span><a href="#initial_config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">INITIAL_CONFIG</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"INITIAL_CONFIG"</span></div><div class="tsd-comment tsd-typography"><p>Indicates an error loading the remote init config.</p>
|
|
18
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="integration_error" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>INTEGRATION_<wbr/>ERROR</span><a href="#integration_error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">INTEGRATION_ERROR</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"INTEGRATION_ERROR"</span></div><div class="tsd-comment tsd-typography"><p>This indicates a known error with the configuration for the integration or assistant. The only current case
|
|
19
|
+
is when the web chat receives a connect_to_agent response and no service desk has been configured. These are
|
|
20
|
+
generally user errors.</p>
|
|
21
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="mcsp_identity_token" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>MCSP_<wbr/>IDENTITY_<wbr/>TOKEN</span><a href="#mcsp_identity_token" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">MCSP_IDENTITY_TOKEN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"MCSP_IDENTITY_TOKEN"</span></div><div class="tsd-comment tsd-typography"><p>This indicates an error with the MCSP identity token.</p>
|
|
22
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="message_communication" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>MESSAGE_<wbr/>COMMUNICATION</span><a href="#message_communication" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">MESSAGE_COMMUNICATION</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"MESSAGE_COMMUNICATION"</span></div><div class="tsd-comment tsd-typography"><p>Indicates an error sending a message to the assistant. This error is only generated after all retries have
|
|
23
|
+
failed and the system has given up.</p>
|
|
24
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="open_config" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>OPEN_<wbr/>CONFIG</span><a href="#open_config" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">OPEN_CONFIG</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"OPEN_CONFIG"</span></div><div class="tsd-comment tsd-typography"><p>Indicates an error loading the main config.</p>
|
|
25
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="preview_link_security" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>PREVIEW_<wbr/>LINK_<wbr/>SECURITY</span><a href="#preview_link_security" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">PREVIEW_LINK_SECURITY</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"PREVIEW_LINK_SECURITY"</span></div><div class="tsd-comment tsd-typography"><p>Indicates that an attempt to load the preview link was made but security was enabled.</p>
|
|
26
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="render" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>RENDER</span><a href="#render" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">RENDER</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"RENDER"</span></div><div class="tsd-comment tsd-typography"><p>This indicates an error in one of the React components that occurs as part of rendering the UI.</p>
|
|
27
|
+
</div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumeration Members</summary><div><a href="#agent_app_expired_session" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>AGENT_<wbr/>APP_<wbr/>EXPIRED_<wbr/>SESSION</span></a><a href="#hydration" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>HYDRATION</span></a><a href="#identity_token" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>IDENTITY_<wbr/>TOKEN</span></a><a href="#initial_config" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>INITIAL_<wbr/>CONFIG</span></a><a href="#integration_error" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>INTEGRATION_<wbr/>ERROR</span></a><a href="#mcsp_identity_token" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>MCSP_<wbr/>IDENTITY_<wbr/>TOKEN</span></a><a href="#message_communication" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>MESSAGE_<wbr/>COMMUNICATION</span></a><a href="#open_config" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>OPEN_<wbr/>CONFIG</span></a><a href="#preview_link_security" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>PREVIEW_<wbr/>LINK_<wbr/>SECURITY</span></a><a href="#render" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>RENDER</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>OptionItemPreference | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="OptionItemPreference.html">OptionItemPreference</a></li></ul><h1>Enumeration OptionItemPreference</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The set of possible response preferences for an options response.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="OptionItemPreference.html#button" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>BUTTON</span></a>
|
|
3
|
+
<a href="OptionItemPreference.html#dropdown" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DROPDOWN</span></a>
|
|
4
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumeration Members</h2></summary><section><section class="tsd-panel tsd-member"><a id="button" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>BUTTON</span><a href="#button" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">BUTTON</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"button"</span></div><div class="tsd-comment tsd-typography"><p>Indicates the options should be displayed as buttons.</p>
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="dropdown" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DROPDOWN</span><a href="#dropdown" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DROPDOWN</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"dropdown"</span></div><div class="tsd-comment tsd-typography"><p>Indicates the options should be displayed as a drop-down.</p>
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumeration Members</summary><div><a href="#button" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>BUTTON</span></a><a href="#dropdown" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DROPDOWN</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ScreenShareState | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="ScreenShareState.html">ScreenShareState</a></li></ul><h1>Enumeration ScreenShareState</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The possible state changes for a screen sharing request.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="ScreenShareState.html#accepted" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>ACCEPTED</span></a>
|
|
3
|
+
<a href="ScreenShareState.html#cancelled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>CANCELLED</span></a>
|
|
4
|
+
<a href="ScreenShareState.html#declined" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DECLINED</span></a>
|
|
5
|
+
<a href="ScreenShareState.html#ended" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>ENDED</span></a>
|
|
6
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumeration Members</h2></summary><section><section class="tsd-panel tsd-member"><a id="accepted" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ACCEPTED</span><a href="#accepted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">ACCEPTED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"accepted"</span></div><div class="tsd-comment tsd-typography"><p>Indicates the screen sharing was accepted by the user.</p>
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="cancelled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>CANCELLED</span><a href="#cancelled" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">CANCELLED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"cancelled"</span></div><div class="tsd-comment tsd-typography"><p>Indicates the screen sharing request was cancelled.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="declined" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DECLINED</span><a href="#declined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DECLINED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"declined"</span></div><div class="tsd-comment tsd-typography"><p>Indicates the screen sharing was declined by the user.</p>
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="ended" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ENDED</span><a href="#ended" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">ENDED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"ended"</span></div><div class="tsd-comment tsd-typography"><p>Indicates that screen sharing has ended.</p>
|
|
10
|
+
</div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumeration Members</summary><div><a href="#accepted" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>ACCEPTED</span></a><a href="#cancelled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>CANCELLED</span></a><a href="#declined" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DECLINED</span></a><a href="#ended" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>ENDED</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TourEndReason | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="TourEndReason.html">TourEndReason</a></li></ul><h1>Enumeration TourEndReason</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The possible reasons why a tour could have ended. Purposefully not firing this event when the close button is clicked
|
|
2
|
+
or the endTour instance method is used.</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="TourEndReason.html#done_clicked" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DONE_<wbr/>CLICKED</span></a>
|
|
4
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumeration Members</h2></summary><section><section class="tsd-panel tsd-member"><a id="done_clicked" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>DONE_<wbr/>CLICKED</span><a href="#done_clicked" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">DONE_CLICKED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"done_clicked"</span></div><div class="tsd-comment tsd-typography"><p>If the user clicked the done button.</p>
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumeration Members</summary><div><a href="#done_clicked" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>DONE_<wbr/>CLICKED</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TourStartReason | Carbon AI chat</title><meta name="description" content="Documentation for Carbon AI chat"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Carbon AI chat</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">Carbon AI chat</a></li><li><a href="TourStartReason.html">TourStartReason</a></li></ul><h1>Enumeration TourStartReason</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The possible reasons why a tour could be started. Purposefully not firing this event when the restart button is
|
|
2
|
+
clicked.</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Enumeration Members</h3><div class="tsd-index-list"><a href="TourStartReason.html#skip_card" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SKIP_<wbr/>CARD</span></a>
|
|
4
|
+
<a href="TourStartReason.html#start_tour_clicked" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>START_<wbr/>TOUR_<wbr/>CLICKED</span></a>
|
|
5
|
+
<a href="TourStartReason.html#start_tour_method" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>START_<wbr/>TOUR_<wbr/>METHOD</span></a>
|
|
6
|
+
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Enumeration Members</h2></summary><section><section class="tsd-panel tsd-member"><a id="skip_card" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>SKIP_<wbr/>CARD</span><a href="#skip_card" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">SKIP_CARD</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"skip_card"</span></div><div class="tsd-comment tsd-typography"><p>If the skip_card property was true within the tour json.</p>
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="start_tour_clicked" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>START_<wbr/>TOUR_<wbr/>CLICKED</span><a href="#start_tour_clicked" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">START_TOUR_CLICKED</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"start_tour_clicked"</span></div><div class="tsd-comment tsd-typography"><p>If the user clicked the tour card's start button.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="start_tour_method" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>START_<wbr/>TOUR_<wbr/>METHOD</span><a href="#start_tour_method" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-enum-member">START_TOUR_METHOD</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"start_tour_method"</span></div><div class="tsd-comment tsd-typography"><p>If the startTour instance method was used to start the tour.</p>
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Enumeration Members"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Enumeration Members</summary><div><a href="#skip_card" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>SKIP_<wbr/>CARD</span></a><a href="#start_tour_clicked" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>START_<wbr/>TOUR_<wbr/>CLICKED</span></a><a href="#start_tour_method" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Enumeration Member"><use href="../assets/icons.svg#icon-16"></use></svg><span>START_<wbr/>TOUR_<wbr/>METHOD</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html">Carbon AI chat</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|