@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,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>AdditionalDataToAgent | 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="AdditionalDataToAgent.html">AdditionalDataToAgent</a></li></ul><h1>Interface AdditionalDataToAgent</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This is a set of additional data that may be included when the user sends a message to an agent.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AdditionalDataToAgent</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="AdditionalDataToAgent.html#filestoupload">filesToUpload</a><span class="tsd-signature-symbol">?:</span> <a href="FileUpload.html" class="tsd-signature-type tsd-kind-interface">FileUpload</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></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">Properties</h3><div class="tsd-index-list"><a href="AdditionalDataToAgent.html#filestoupload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>files<wbr/>To<wbr/>Upload?</span></a>
|
|
3
|
+
</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="filestoupload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>files<wbr/>To<wbr/>Upload</span><a href="#filestoupload" 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-property">filesToUpload</span><span class="tsd-signature-symbol">?:</span> <a href="FileUpload.html" class="tsd-signature-type tsd-kind-interface">FileUpload</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>A set of files that user has selected to upload to an agent. This value may be undefined if there are no files
|
|
4
|
+
to upload.</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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#filestoupload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>files<wbr/>To<wbr/>Upload</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,8 @@
|
|
|
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>AgentAppConfig | 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="AgentAppConfig.html">AgentAppConfig</a></li></ul><h1>Interface AgentAppConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>When web chat is being used as the view for the human agent.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AgentAppConfig</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="AgentAppConfig.html#auth_code">auth_code</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AgentAppConfig.html#is_on">is_on</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></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">Properties</h3><div class="tsd-index-list"><a href="AgentAppConfig.html#auth_code" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auth_<wbr/>code?</span></a>
|
|
3
|
+
<a href="AgentAppConfig.html#is_on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>on</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="auth_code" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>auth_<wbr/>code</span><a href="#auth_code" 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-property">auth_code</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The auth_code passed from the connect_to_agent response type used to authenticate the session. This can be used to
|
|
5
|
+
embed a web chat into an agent application as an iframe and load the conversation history for the agent to see.</p>
|
|
6
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="is_on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is_<wbr/>on</span><a href="#is_on" 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-property">is_on</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Sets chat to be in "agent app" mode. This means no user input is allowed and an "auth_code" will be included in the
|
|
7
|
+
request to fetch the conversation history.</p>
|
|
8
|
+
</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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#auth_code" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>auth_<wbr/>code</span></a><a href="#is_on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is_<wbr/>on</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>AgentAppInfo | 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="AgentAppInfo.html">AgentAppInfo</a></li></ul><h1>Interface AgentAppInfo</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This data is used to configure a read only web chat inside the service desk.</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AgentAppInfo</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="AgentAppInfo.html#sessionhistorykey">sessionHistoryKey</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></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">Properties</h3><div class="tsd-index-list"><a href="AgentAppInfo.html#sessionhistorykey" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>session<wbr/>History<wbr/>Key</span></a>
|
|
3
|
+
</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="sessionhistorykey" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>session<wbr/>History<wbr/>Key</span><a href="#sessionhistorykey" 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-property">sessionHistoryKey</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A string that is separated by AGENT_APP_KEY_SEPARATOR that can be used to create a PublicConfig. It includes base
|
|
4
|
+
connect info like integrationID, etc., and by pass JWT security with a one time auth code.</p>
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" 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></h4><p>ConnectToAgentItemTransferInfo.session_history_key</p>
|
|
6
|
+
</div></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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#sessionhistorykey" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>session<wbr/>History<wbr/>Key</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,12 @@
|
|
|
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>AgentAvailability | 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="AgentAvailability.html">AgentAvailability</a></li></ul><h1>Interface AgentAvailability</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Information about the current availability of an agent while a user is waiting to be connected. If these are not set
|
|
2
|
+
the web chat will provide generic messaging letting the user know that a request for an agent has been sent.</p>
|
|
3
|
+
<p>Note that only one of these fields will be used by web chat if more than one has been assigned a value. Priority
|
|
4
|
+
first goes to estimated_wait_time, then position_in_queue, and then message.</p>
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AgentAvailability</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="AgentAvailability.html#estimated_wait_time">estimated_wait_time</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AgentAvailability.html#message">message</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AgentAvailability.html#position_in_queue">position_in_queue</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></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">Properties</h3><div class="tsd-index-list"><a href="AgentAvailability.html#estimated_wait_time" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>estimated_<wbr/>wait_<wbr/>time?</span></a>
|
|
6
|
+
<a href="AgentAvailability.html#message" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message?</span></a>
|
|
7
|
+
<a href="AgentAvailability.html#position_in_queue" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position_<wbr/>in_<wbr/>queue?</span></a>
|
|
8
|
+
</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="estimated_wait_time" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>estimated_<wbr/>wait_<wbr/>time</span><a href="#estimated_wait_time" 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-property">estimated_wait_time</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The estimated wait time for the user in minutes. E.g. "Current wait time is 2 minutes."</p>
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="message" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>message</span><a href="#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-property">message</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A custom message to display to the user containing the updated status. This may contain markdown.</p>
|
|
10
|
+
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-since"><h4 class="tsd-anchor-link"><a id="since" class="tsd-anchor"></a>Since<a href="#since" 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></h4><p>Web chat 6.7.0. This value will be ignored if used with earlier versions of web chat.</p>
|
|
11
|
+
</div></div></section><section class="tsd-panel tsd-member"><a id="position_in_queue" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>position_<wbr/>in_<wbr/>queue</span><a href="#position_in_queue" 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-property">position_in_queue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The current position of the user in a queue. E.g. "You are number 2 in line."</p>
|
|
12
|
+
</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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#estimated_wait_time" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>estimated_<wbr/>wait_<wbr/>time</span></a><a href="#message" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message</span></a><a href="#position_in_queue" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>position_<wbr/>in_<wbr/>queue</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,12 @@
|
|
|
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>AgentProfile | 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="AgentProfile.html">AgentProfile</a></li></ul><h1>Interface AgentProfile</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Profile information about a specific agent that can be used to display information to the user. This may
|
|
2
|
+
represent a human agent or a virtual/bot agent.</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">AgentProfile</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="AgentProfile.html#hidden">hidden</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AgentProfile.html#id">id</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AgentProfile.html#nickname">nickname</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="AgentProfile.html#profile_picture_url">profile_picture_url</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></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">Properties</h3><div class="tsd-index-list"><a href="AgentProfile.html#hidden" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden?</span></a>
|
|
4
|
+
<a href="AgentProfile.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a>
|
|
5
|
+
<a href="AgentProfile.html#nickname" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>nickname</span></a>
|
|
6
|
+
<a href="AgentProfile.html#profile_picture_url" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>profile_<wbr/>picture_<wbr/>url?</span></a>
|
|
7
|
+
</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="hidden" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>hidden</span><a href="#hidden" 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-property">hidden</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the agent's profile information should be hidden. This will hide the entire avatar line
|
|
8
|
+
including the agent name, avatar and timestamp.</p>
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#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-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A unique identifier for this agent.</p>
|
|
10
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="nickname" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>nickname</span><a href="#nickname" 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-property">nickname</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The visible name for the agent. Can be the full name or just a first name.</p>
|
|
11
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="profile_picture_url" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>profile_<wbr/>picture_<wbr/>url</span><a href="#profile_picture_url" 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-property">profile_picture_url</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An url pointing to an avatar for the agent.</p>
|
|
12
|
+
</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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#hidden" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>hidden</span></a><a href="#id" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>id</span></a><a href="#nickname" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>nickname</span></a><a href="#profile_picture_url" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>profile_<wbr/>picture_<wbr/>url</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,3 @@
|
|
|
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>BaseMessageInput | 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="BaseMessageInput.html">BaseMessageInput</a></li></ul><h1>Interface BaseMessageInput</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BaseMessageInput</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BaseMessageInput.html#message_type">message_type</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/MessageInputType.html" class="tsd-signature-type tsd-kind-enum">MessageInputType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="41"><h4>Hierarchy (<a href="../hierarchy.html#BaseMessageInput">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BaseMessageInput</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="EventInput.html" class="tsd-signature-type tsd-kind-interface">EventInput</a></li><li class="tsd-hierarchy-item"><a href="MessageInput.html" class="tsd-signature-type tsd-kind-interface">MessageInput</a></li></ul></li></ul></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">Properties</h3><div class="tsd-index-list"><a href="BaseMessageInput.html#message_type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message_<wbr/>type?</span></a>
|
|
2
|
+
</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="message_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>message_<wbr/>type</span><a href="#message_type" 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-property">message_type</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/MessageInputType.html" class="tsd-signature-type tsd-kind-enum">MessageInputType</a></div><div class="tsd-comment tsd-typography"><p>The type of user input.</p>
|
|
3
|
+
</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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#message_type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>message_<wbr/>type</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,3 @@
|
|
|
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>BusEvent | 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="BusEvent.html">BusEvent</a></li></ul><h1>Interface BusEvent</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BusEvent</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BusEvent.html#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html" class="tsd-signature-type tsd-kind-enum">BusEventType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="43"><h4>Hierarchy (<a href="../hierarchy.html#BusEvent">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BusEvent</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BusEventAgentAreAnyAgentsOnline.html" class="tsd-signature-type tsd-kind-interface">BusEventAgentAreAnyAgentsOnline</a></li><li class="tsd-hierarchy-item"><a href="BusEventAgentEndChat.html" class="tsd-signature-type tsd-kind-interface">BusEventAgentEndChat</a></li><li class="tsd-hierarchy-item"><a href="BusEventAgentPreEndChat.html" class="tsd-signature-type tsd-kind-interface">BusEventAgentPreEndChat</a></li><li class="tsd-hierarchy-item"><a href="BusEventAgentPreReceive.html" class="tsd-signature-type tsd-kind-interface">BusEventAgentPreReceive</a></li><li class="tsd-hierarchy-item"><a href="BusEventAgentPreSend.html" class="tsd-signature-type tsd-kind-interface">BusEventAgentPreSend</a></li><li class="tsd-hierarchy-item"><a href="BusEventAgentPreSessionHistory.html" class="tsd-signature-type tsd-kind-interface">BusEventAgentPreSessionHistory</a></li><li class="tsd-hierarchy-item"><a href="BusEventAgentPreStartChat.html" class="tsd-signature-type tsd-kind-interface">BusEventAgentPreStartChat</a></li><li class="tsd-hierarchy-item"><a href="BusEventAgentReceive.html" class="tsd-signature-type tsd-kind-interface">BusEventAgentReceive</a></li><li class="tsd-hierarchy-item"><a href="BusEventAgentSend.html" class="tsd-signature-type tsd-kind-interface">BusEventAgentSend</a></li><li class="tsd-hierarchy-item"><a href="BusEventChatReady.html" class="tsd-signature-type tsd-kind-interface">BusEventChatReady</a></li><li class="tsd-hierarchy-item"><a href="BusEventChunkUserDefinedResponse.html" class="tsd-signature-type tsd-kind-interface">BusEventChunkUserDefinedResponse</a></li><li class="tsd-hierarchy-item"><a href="BusEventClosePanelButtonClicked.html" class="tsd-signature-type tsd-kind-interface">BusEventClosePanelButtonClicked</a></li><li class="tsd-hierarchy-item"><a href="BusEventCustomPanelClose.html" class="tsd-signature-type tsd-kind-interface">BusEventCustomPanelClose</a></li><li class="tsd-hierarchy-item"><a href="BusEventCustomPanelOpen.html" class="tsd-signature-type tsd-kind-interface">BusEventCustomPanelOpen</a></li><li class="tsd-hierarchy-item"><a href="BusEventCustomPanelPreClose.html" class="tsd-signature-type tsd-kind-interface">BusEventCustomPanelPreClose</a></li><li class="tsd-hierarchy-item"><a href="BusEventCustomPanelPreOpen.html" class="tsd-signature-type tsd-kind-interface">BusEventCustomPanelPreOpen</a></li><li class="tsd-hierarchy-item"><a href="BusEventFeedback.html" class="tsd-signature-type tsd-kind-interface">BusEventFeedback</a></li><li class="tsd-hierarchy-item"><a href="BusEventGenesysMessengerAuthError.html" class="tsd-signature-type tsd-kind-interface">BusEventGenesysMessengerAuthError</a></li><li class="tsd-hierarchy-item"><a href="BusEventGenesysMessengerAuthProvider.html" class="tsd-signature-type tsd-kind-interface">BusEventGenesysMessengerAuthProvider</a></li><li class="tsd-hierarchy-item"><a href="BusEventGenesysMessengerGetAuthCode.html" class="tsd-signature-type tsd-kind-interface">BusEventGenesysMessengerGetAuthCode</a></li><li class="tsd-hierarchy-item"><a href="BusEventGenesysMessengerLoggedOut.html" class="tsd-signature-type tsd-kind-interface">BusEventGenesysMessengerLoggedOut</a></li><li class="tsd-hierarchy-item"><a href="BusEventGenesysMessengerReauthenticate.html" class="tsd-signature-type tsd-kind-interface">BusEventGenesysMessengerReauthenticate</a></li><li class="tsd-hierarchy-item"><a href="BusEventHistoryBegin.html" class="tsd-signature-type tsd-kind-interface">BusEventHistoryBegin</a></li><li class="tsd-hierarchy-item"><a href="BusEventHistoryEnd.html" class="tsd-signature-type tsd-kind-interface">BusEventHistoryEnd</a></li><li class="tsd-hierarchy-item"><a href="BusEventMessageItemCustom.html" class="tsd-signature-type tsd-kind-interface">BusEventMessageItemCustom</a></li><li class="tsd-hierarchy-item"><a href="BusEventNiceDFOGetAuthCode.html" class="tsd-signature-type tsd-kind-interface">BusEventNiceDFOGetAuthCode</a></li><li class="tsd-hierarchy-item"><a href="BusEventPreReceive.html" class="tsd-signature-type tsd-kind-interface">BusEventPreReceive</a></li><li class="tsd-hierarchy-item"><a href="BusEventPreReset.html" class="tsd-signature-type tsd-kind-interface">BusEventPreReset</a></li><li class="tsd-hierarchy-item"><a href="BusEventPreSend.html" class="tsd-signature-type tsd-kind-interface">BusEventPreSend</a></li><li class="tsd-hierarchy-item"><a href="BusEventReceive.html" class="tsd-signature-type tsd-kind-interface">BusEventReceive</a></li><li class="tsd-hierarchy-item"><a href="BusEventReset.html" class="tsd-signature-type tsd-kind-interface">BusEventReset</a></li><li class="tsd-hierarchy-item"><a href="BusEventSend.html" class="tsd-signature-type tsd-kind-interface">BusEventSend</a></li><li class="tsd-hierarchy-item"><a href="BusEventTourEnd.html" class="tsd-signature-type tsd-kind-interface">BusEventTourEnd</a></li><li class="tsd-hierarchy-item"><a href="BusEventTourStart.html" class="tsd-signature-type tsd-kind-interface">BusEventTourStart</a></li><li class="tsd-hierarchy-item"><a href="BusEventTourStep.html" class="tsd-signature-type tsd-kind-interface">BusEventTourStep</a></li><li class="tsd-hierarchy-item"><a href="BusEventUserDefinedResponse.html" class="tsd-signature-type tsd-kind-interface">BusEventUserDefinedResponse</a></li><li class="tsd-hierarchy-item"><a href="BusEventViewChange.html" class="tsd-signature-type tsd-kind-interface">BusEventViewChange</a></li><li class="tsd-hierarchy-item"><a href="BusEventViewPreChange.html" class="tsd-signature-type tsd-kind-interface">BusEventViewPreChange</a></li></ul></li></ul></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">Properties</h3><div class="tsd-index-list"><a href="BusEvent.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
2
|
+
</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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-property">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html" class="tsd-signature-type tsd-kind-enum">BusEventType</a></div><div class="tsd-comment tsd-typography"><p>The type of this event.</p>
|
|
3
|
+
</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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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,8 @@
|
|
|
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>BusEventAgentAreAnyAgentsOnline | 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="BusEventAgentAreAnyAgentsOnline.html">BusEventAgentAreAnyAgentsOnline</a></li></ul><h1>Interface BusEventAgentAreAnyAgentsOnline</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This event is fired after web chat calls "areAnyAgentsOnline" for a service desk. It will report the value returned
|
|
2
|
+
from that call. This is particularly useful if some custom code wants to take action if no agents are online.</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BusEventAgentAreAnyAgentsOnline</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BusEventAgentAreAnyAgentsOnline.html#areanyagentsonline">areAnyAgentsOnline</a><span class="tsd-signature-symbol">:</span> <a href="../enums/AgentsOnlineStatus.html" class="tsd-signature-type tsd-kind-enum">AgentsOnlineStatus</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BusEventAgentAreAnyAgentsOnline.html#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html#agent_are_any_agents_online" class="tsd-signature-type tsd-kind-enum-member">AGENT_ARE_ANY_AGENTS_ONLINE</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="45"><h4>Hierarchy (<a href="../hierarchy.html#BusEventAgentAreAnyAgentsOnline">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BusEvent.html" class="tsd-signature-type tsd-kind-interface">BusEvent</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BusEventAgentAreAnyAgentsOnline</span></li></ul></li></ul></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">Properties</h3><div class="tsd-index-list"><a href="BusEventAgentAreAnyAgentsOnline.html#areanyagentsonline" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>are<wbr/>Any<wbr/>Agents<wbr/>Online</span></a>
|
|
4
|
+
<a href="BusEventAgentAreAnyAgentsOnline.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="areanyagentsonline" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>are<wbr/>Any<wbr/>Agents<wbr/>Online</span><a href="#areanyagentsonline" 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-property">areAnyAgentsOnline</span><span class="tsd-signature-symbol">:</span> <a href="../enums/AgentsOnlineStatus.html" class="tsd-signature-type tsd-kind-enum">AgentsOnlineStatus</a></div><div class="tsd-comment tsd-typography"><p>The result that was returned from "areAnyAgentsOnline". If an error occurred, this will be
|
|
6
|
+
<a href="../enums/AgentsOnlineStatus.html#offline" class="tsd-kind-enum-member">AgentsOnlineStatus.OFFLINE</a>.</p>
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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-property">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html#agent_are_any_agents_online" class="tsd-signature-type tsd-kind-enum-member">AGENT_ARE_ANY_AGENTS_ONLINE</a></div><div class="tsd-comment tsd-typography"><p>The type of the event.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="BusEvent.html">BusEvent</a>.<a href="BusEvent.html#type">type</a></p></aside></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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#areanyagentsonline" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>are<wbr/>Any<wbr/>Agents<wbr/>Online</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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>BusEventAgentEndChat | 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="BusEventAgentEndChat.html">BusEventAgentEndChat</a></li></ul><h1>Interface BusEventAgentEndChat</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This event is fired after a chat with an agent has ended. This is fired after AGENT_PRE_END_CHAT but
|
|
2
|
+
can be fired both from the user leaving the chat or the agent ending the chat.</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BusEventAgentEndChat</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BusEventAgentEndChat.html#endedbyagent">endedByAgent</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BusEventAgentEndChat.html#requestcancelled">requestCancelled</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BusEventAgentEndChat.html#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html#agent_end_chat" class="tsd-signature-type tsd-kind-enum-member">AGENT_END_CHAT</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="48"><h4>Hierarchy (<a href="../hierarchy.html#BusEventAgentEndChat">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BusEvent.html" class="tsd-signature-type tsd-kind-interface">BusEvent</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BusEventAgentEndChat</span></li></ul></li></ul></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">Properties</h3><div class="tsd-index-list"><a href="BusEventAgentEndChat.html#endedbyagent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ended<wbr/>By<wbr/>Agent</span></a>
|
|
4
|
+
<a href="BusEventAgentEndChat.html#requestcancelled" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request<wbr/>Cancelled</span></a>
|
|
5
|
+
<a href="BusEventAgentEndChat.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="endedbyagent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ended<wbr/>By<wbr/>Agent</span><a href="#endedbyagent" 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-property">endedByAgent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the chat was ended by the agent.</p>
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="requestcancelled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>request<wbr/>Cancelled</span><a href="#requestcancelled" 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-property">requestCancelled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the chat was ended because the request for an agent was cancelled or an error occurred while
|
|
8
|
+
starting the chat. This means the start never fully started.</p>
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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-property">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html#agent_end_chat" class="tsd-signature-type tsd-kind-enum-member">AGENT_END_CHAT</a></div><div class="tsd-comment tsd-typography"><p>The type of the event.</p>
|
|
10
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="BusEvent.html">BusEvent</a>.<a href="BusEvent.html#type">type</a></p></aside></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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#endedbyagent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ended<wbr/>By<wbr/>Agent</span></a><a href="#requestcancelled" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>request<wbr/>Cancelled</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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,12 @@
|
|
|
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>BusEventAgentPreEndChat | 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="BusEventAgentPreEndChat.html">BusEventAgentPreEndChat</a></li></ul><h1>Interface BusEventAgentPreEndChat<TPayloadType></h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This event is fired before a chat with an agent is ended. This occurs after the user has selected "Yes" from the
|
|
2
|
+
confirmation modal but it can also be fired if the chat is ended by the agent.</p>
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BusEventAgentPreEndChat</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="BusEventAgentPreEndChat.html#tpayloadtype">TPayloadType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">></span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BusEventAgentPreEndChat.html#cancelendchat">cancelEndChat</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BusEventAgentPreEndChat.html#endedbyagent">endedByAgent</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BusEventAgentPreEndChat.html#preendchatpayload">preEndChatPayload</a><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="BusEventAgentPreEndChat.html#tpayloadtype">TPayloadType</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BusEventAgentPreEndChat.html#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html#agent_pre_end_chat" class="tsd-signature-type tsd-kind-enum-member">AGENT_PRE_END_CHAT</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tpayloadtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TPayloadType</span> = <span class="tsd-signature-type">unknown</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="52"><h4>Hierarchy (<a href="../hierarchy.html#BusEventAgentPreEndChat">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BusEvent.html" class="tsd-signature-type tsd-kind-interface">BusEvent</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BusEventAgentPreEndChat</span></li></ul></li></ul></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">Properties</h3><div class="tsd-index-list"><a href="BusEventAgentPreEndChat.html#cancelendchat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cancel<wbr/>End<wbr/>Chat</span></a>
|
|
4
|
+
<a href="BusEventAgentPreEndChat.html#endedbyagent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ended<wbr/>By<wbr/>Agent</span></a>
|
|
5
|
+
<a href="BusEventAgentPreEndChat.html#preendchatpayload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pre<wbr/>End<wbr/>Chat<wbr/>Payload</span></a>
|
|
6
|
+
<a href="BusEventAgentPreEndChat.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
7
|
+
</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="cancelendchat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>cancel<wbr/>End<wbr/>Chat</span><a href="#cancelendchat" 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-property">cancelEndChat</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>This value may be set by a listener to indicate that the process of ending the chat should be cancelled.</p>
|
|
8
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="endedbyagent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>ended<wbr/>By<wbr/>Agent</span><a href="#endedbyagent" 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-property">endedByAgent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if the chat was ended by the agent.</p>
|
|
9
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="preendchatpayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pre<wbr/>End<wbr/>Chat<wbr/>Payload</span><a href="#preendchatpayload" 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-property">preEndChatPayload</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="BusEventAgentPreEndChat.html#tpayloadtype">TPayloadType</a></div><div class="tsd-comment tsd-typography"><p>An arbitrary payload object that a listener may set. This payload will be passed to the service desk
|
|
10
|
+
<a href="ServiceDesk.html#endchat" class="tsd-kind-property">ServiceDesk#endChat</a> function.</p>
|
|
11
|
+
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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-property">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html#agent_pre_end_chat" class="tsd-signature-type tsd-kind-enum-member">AGENT_PRE_END_CHAT</a></div><div class="tsd-comment tsd-typography"><p>The type of the event.</p>
|
|
12
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="BusEvent.html">BusEvent</a>.<a href="BusEvent.html#type">type</a></p></aside></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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#cancelendchat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>cancel<wbr/>End<wbr/>Chat</span></a><a href="#endedbyagent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>ended<wbr/>By<wbr/>Agent</span></a><a href="#preendchatpayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pre<wbr/>End<wbr/>Chat<wbr/>Payload</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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>BusEventAgentPreReceive | 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="BusEventAgentPreReceive.html">BusEventAgentPreReceive</a></li></ul><h1>Interface BusEventAgentPreReceive</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BusEventAgentPreReceive</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BusEventAgentPreReceive.html#agentprofile">agentProfile</a><span class="tsd-signature-symbol">?:</span> <a href="AgentProfile.html" class="tsd-signature-type tsd-kind-interface">AgentProfile</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BusEventAgentPreReceive.html#data">data</a><span class="tsd-signature-symbol">:</span> <a href="MessageResponse.html" class="tsd-signature-type tsd-kind-interface">MessageResponse</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BusEventAgentPreReceive.html#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html#agent_pre_receive" class="tsd-signature-type tsd-kind-enum-member">AGENT_PRE_RECEIVE</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="58"><h4>Hierarchy (<a href="../hierarchy.html#BusEventAgentPreReceive">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BusEvent.html" class="tsd-signature-type tsd-kind-interface">BusEvent</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BusEventAgentPreReceive</span></li></ul></li></ul></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">Properties</h3><div class="tsd-index-list"><a href="BusEventAgentPreReceive.html#agentprofile" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent<wbr/>Profile?</span></a>
|
|
2
|
+
<a href="BusEventAgentPreReceive.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a>
|
|
3
|
+
<a href="BusEventAgentPreReceive.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="agentprofile" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>agent<wbr/>Profile</span><a href="#agentprofile" 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-property">agentProfile</span><span class="tsd-signature-symbol">?:</span> <a href="AgentProfile.html" class="tsd-signature-type tsd-kind-interface">AgentProfile</a></div></section><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" 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-property">data</span><span class="tsd-signature-symbol">:</span> <a href="MessageResponse.html" class="tsd-signature-type tsd-kind-interface">MessageResponse</a></div></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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-property">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html#agent_pre_receive" class="tsd-signature-type tsd-kind-enum-member">AGENT_PRE_RECEIVE</a></div><div class="tsd-comment tsd-typography"><p>The type of this event.</p>
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="BusEvent.html">BusEvent</a>.<a href="BusEvent.html#type">type</a></p></aside></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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#agentprofile" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>agent<wbr/>Profile</span></a><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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>BusEventAgentPreSend | 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="BusEventAgentPreSend.html">BusEventAgentPreSend</a></li></ul><h1>Interface BusEventAgentPreSend</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">BusEventAgentPreSend</span> <span class="tsd-signature-symbol">{</span><br/> <a class="tsd-kind-property" href="BusEventAgentPreSend.html#data">data</a><span class="tsd-signature-symbol">:</span> <a href="MessageRequest.html" class="tsd-signature-type tsd-kind-interface">MessageRequest</a><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BusEventAgentPreSend.html#files">files</a><span class="tsd-signature-symbol">:</span> <a href="FileUpload.html" class="tsd-signature-type tsd-kind-interface">FileUpload</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <a class="tsd-kind-property" href="BusEventAgentPreSend.html#type">type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html#agent_pre_send" class="tsd-signature-type tsd-kind-enum-member">AGENT_PRE_SEND</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel tsd-hierarchy" data-refl="62"><h4>Hierarchy (<a href="../hierarchy.html#BusEventAgentPreSend">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="BusEvent.html" class="tsd-signature-type tsd-kind-interface">BusEvent</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">BusEventAgentPreSend</span></li></ul></li></ul></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">Properties</h3><div class="tsd-index-list"><a href="BusEventAgentPreSend.html#data" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a>
|
|
2
|
+
<a href="BusEventAgentPreSend.html#files" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>files</span></a>
|
|
3
|
+
<a href="BusEventAgentPreSend.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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-Properties"><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> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="data" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>data</span><a href="#data" 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-property">data</span><span class="tsd-signature-symbol">:</span> <a href="MessageRequest.html" class="tsd-signature-type tsd-kind-interface">MessageRequest</a></div></section><section class="tsd-panel tsd-member"><a id="files" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>files</span><a href="#files" 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-property">files</span><span class="tsd-signature-symbol">:</span> <a href="FileUpload.html" class="tsd-signature-type tsd-kind-interface">FileUpload</a><span class="tsd-signature-symbol">[]</span></div></section><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" 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-property">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/BusEventType.html#agent_pre_send" class="tsd-signature-type tsd-kind-enum-member">AGENT_PRE_SEND</a></div><div class="tsd-comment tsd-typography"><p>The type of this event.</p>
|
|
5
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides <a href="BusEvent.html">BusEvent</a>.<a href="BusEvent.html#type">type</a></p></aside></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-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#data" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>data</span></a><a href="#files" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>files</span></a><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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>
|