@carbon/ai-chat 0.2.0-1 → 0.2.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.
Files changed (273) hide show
  1. package/dist/docs/carbon-chat-docs.js +2 -0
  2. package/dist/docs/carbon-chat-docs.js.LICENSE.txt +118 -0
  3. package/dist/docs/carbon-chat.html +8 -0
  4. package/dist/docs/carbon-tsdocs/.nojekyll +1 -0
  5. package/dist/docs/carbon-tsdocs/assets/hierarchy.js +1 -0
  6. package/dist/docs/carbon-tsdocs/assets/highlight.css +22 -0
  7. package/dist/docs/carbon-tsdocs/assets/icons.js +18 -0
  8. package/dist/docs/carbon-tsdocs/assets/icons.svg +1 -0
  9. package/dist/docs/carbon-tsdocs/assets/main.js +60 -0
  10. package/dist/docs/carbon-tsdocs/assets/navigation.js +1 -0
  11. package/dist/docs/carbon-tsdocs/assets/search.js +1 -0
  12. package/dist/docs/carbon-tsdocs/assets/style.css +1611 -0
  13. package/dist/docs/carbon-tsdocs/enums/AgentMessageType.html +20 -0
  14. package/dist/docs/carbon-tsdocs/enums/AgentsOnlineStatus.html +9 -0
  15. package/dist/docs/carbon-tsdocs/enums/BusEventType.html +67 -0
  16. package/dist/docs/carbon-tsdocs/enums/ButtonItemKind.html +6 -0
  17. package/dist/docs/carbon-tsdocs/enums/ButtonItemType.html +5 -0
  18. package/dist/docs/carbon-tsdocs/enums/CarbonTheme.html +7 -0
  19. package/dist/docs/carbon-tsdocs/enums/CatastrophicErrorType.html +11 -0
  20. package/dist/docs/carbon-tsdocs/enums/ChainOfThoughtStepStatus.html +5 -0
  21. package/dist/docs/carbon-tsdocs/enums/ChatHeaderObjectType.html +6 -0
  22. package/dist/docs/carbon-tsdocs/enums/CornersType.html +4 -0
  23. package/dist/docs/carbon-tsdocs/enums/CustomEventType.html +3 -0
  24. package/dist/docs/carbon-tsdocs/enums/ErrorType.html +12 -0
  25. package/dist/docs/carbon-tsdocs/enums/FeedbackInteractionType.html +10 -0
  26. package/dist/docs/carbon-tsdocs/enums/FileStatusValue.html +6 -0
  27. package/dist/docs/carbon-tsdocs/enums/HomeScreenBackgroundType.html +6 -0
  28. package/dist/docs/carbon-tsdocs/enums/IFrameItemDisplayOption.html +6 -0
  29. package/dist/docs/carbon-tsdocs/enums/LauncherType.html +6 -0
  30. package/dist/docs/carbon-tsdocs/enums/MessageInputType.html +8 -0
  31. package/dist/docs/carbon-tsdocs/enums/MessageResponseTypes.html +36 -0
  32. package/dist/docs/carbon-tsdocs/enums/MessageSendSource.html +45 -0
  33. package/dist/docs/carbon-tsdocs/enums/MinimizeButtonIconType.html +9 -0
  34. package/dist/docs/carbon-tsdocs/enums/OnErrorType.html +27 -0
  35. package/dist/docs/carbon-tsdocs/enums/OptionItemPreference.html +6 -0
  36. package/dist/docs/carbon-tsdocs/enums/ScreenShareState.html +10 -0
  37. package/dist/docs/carbon-tsdocs/enums/TourEndReason.html +5 -0
  38. package/dist/docs/carbon-tsdocs/enums/TourStartReason.html +9 -0
  39. package/dist/docs/carbon-tsdocs/enums/ViewChangeReason.html +47 -0
  40. package/dist/docs/carbon-tsdocs/enums/ViewType.html +10 -0
  41. package/dist/docs/carbon-tsdocs/enums/WriteableElementName.html +16 -0
  42. package/dist/docs/carbon-tsdocs/functions/ChatContainer.html +10 -0
  43. package/dist/docs/carbon-tsdocs/functions/ChatCustomElement.html +8 -0
  44. package/dist/docs/carbon-tsdocs/hierarchy.html +1 -0
  45. package/dist/docs/carbon-tsdocs/index.html +1 -0
  46. package/dist/docs/carbon-tsdocs/interfaces/AdditionalDataToAgent.html +5 -0
  47. package/dist/docs/carbon-tsdocs/interfaces/AgentAppConfig.html +8 -0
  48. package/dist/docs/carbon-tsdocs/interfaces/AgentAppInfo.html +6 -0
  49. package/dist/docs/carbon-tsdocs/interfaces/AgentAvailability.html +12 -0
  50. package/dist/docs/carbon-tsdocs/interfaces/AgentProfile.html +12 -0
  51. package/dist/docs/carbon-tsdocs/interfaces/BaseMessageInput.html +3 -0
  52. package/dist/docs/carbon-tsdocs/interfaces/BusEvent.html +3 -0
  53. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentAreAnyAgentsOnline.html +8 -0
  54. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentEndChat.html +10 -0
  55. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreEndChat.html +12 -0
  56. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreReceive.html +5 -0
  57. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreSend.html +5 -0
  58. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreSessionHistory.html +8 -0
  59. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentPreStartChat.html +13 -0
  60. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentReceive.html +5 -0
  61. package/dist/docs/carbon-tsdocs/interfaces/BusEventAgentSend.html +5 -0
  62. package/dist/docs/carbon-tsdocs/interfaces/BusEventChatReady.html +3 -0
  63. package/dist/docs/carbon-tsdocs/interfaces/BusEventChunkUserDefinedResponse.html +39 -0
  64. package/dist/docs/carbon-tsdocs/interfaces/BusEventClosePanelButtonClicked.html +4 -0
  65. package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelClose.html +3 -0
  66. package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelOpen.html +3 -0
  67. package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelPreClose.html +3 -0
  68. package/dist/docs/carbon-tsdocs/interfaces/BusEventCustomPanelPreOpen.html +3 -0
  69. package/dist/docs/carbon-tsdocs/interfaces/BusEventFeedback.html +17 -0
  70. package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerAuthError.html +5 -0
  71. package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerAuthProvider.html +5 -0
  72. package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerGetAuthCode.html +5 -0
  73. package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerLoggedOut.html +5 -0
  74. package/dist/docs/carbon-tsdocs/interfaces/BusEventGenesysMessengerReauthenticate.html +5 -0
  75. package/dist/docs/carbon-tsdocs/interfaces/BusEventHistoryBegin.html +15 -0
  76. package/dist/docs/carbon-tsdocs/interfaces/BusEventHistoryEnd.html +11 -0
  77. package/dist/docs/carbon-tsdocs/interfaces/BusEventMessageItemCustom.html +11 -0
  78. package/dist/docs/carbon-tsdocs/interfaces/BusEventNiceDFOGetAuthCode.html +7 -0
  79. package/dist/docs/carbon-tsdocs/interfaces/BusEventPreReceive.html +11 -0
  80. package/dist/docs/carbon-tsdocs/interfaces/BusEventPreReset.html +3 -0
  81. package/dist/docs/carbon-tsdocs/interfaces/BusEventPreSend.html +8 -0
  82. package/dist/docs/carbon-tsdocs/interfaces/BusEventReceive.html +4 -0
  83. package/dist/docs/carbon-tsdocs/interfaces/BusEventReset.html +3 -0
  84. package/dist/docs/carbon-tsdocs/interfaces/BusEventSend.html +8 -0
  85. package/dist/docs/carbon-tsdocs/interfaces/BusEventTourEnd.html +7 -0
  86. package/dist/docs/carbon-tsdocs/interfaces/BusEventTourStart.html +8 -0
  87. package/dist/docs/carbon-tsdocs/interfaces/BusEventTourStep.html +8 -0
  88. package/dist/docs/carbon-tsdocs/interfaces/BusEventUserDefinedResponse.html +10 -0
  89. package/dist/docs/carbon-tsdocs/interfaces/BusEventViewChange.html +13 -0
  90. package/dist/docs/carbon-tsdocs/interfaces/BusEventViewPreChange.html +12 -0
  91. package/dist/docs/carbon-tsdocs/interfaces/ButtonItem.html +34 -0
  92. package/dist/docs/carbon-tsdocs/interfaces/CarouselItem.html +15 -0
  93. package/dist/docs/carbon-tsdocs/interfaces/ChainOfThoughtStep.html +20 -0
  94. package/dist/docs/carbon-tsdocs/interfaces/ChatContainerProps.html +14 -0
  95. package/dist/docs/carbon-tsdocs/interfaces/ChatCustomElementProps.html +31 -0
  96. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderAvatarConfig.html +6 -0
  97. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderButton.html +8 -0
  98. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderConfig.html +9 -0
  99. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderGroupMenu.html +13 -0
  100. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderGroupMenuItem.html +8 -0
  101. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderLink.html +10 -0
  102. package/dist/docs/carbon-tsdocs/interfaces/ChatHeaderMenu.html +9 -0
  103. package/dist/docs/carbon-tsdocs/interfaces/ChatInstance.html +146 -0
  104. package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceMessaging.html +16 -0
  105. package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceNotifications.html +7 -0
  106. package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceServiceDeskActions.html +13 -0
  107. package/dist/docs/carbon-tsdocs/interfaces/ChatInstanceTours.html +13 -0
  108. package/dist/docs/carbon-tsdocs/interfaces/Chunk.html +5 -0
  109. package/dist/docs/carbon-tsdocs/interfaces/CompleteItemChunk.html +9 -0
  110. package/dist/docs/carbon-tsdocs/interfaces/ConnectToAgentItem.html +24 -0
  111. package/dist/docs/carbon-tsdocs/interfaces/ConnectToAgentItemTransferInfo.html +9 -0
  112. package/dist/docs/carbon-tsdocs/interfaces/ConnectingErrorInfo.html +12 -0
  113. package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItem.html +22 -0
  114. package/dist/docs/carbon-tsdocs/interfaces/ConversationalSearchItemCitation.html +18 -0
  115. package/dist/docs/carbon-tsdocs/interfaces/CustomMenuOption.html +6 -0
  116. package/dist/docs/carbon-tsdocs/interfaces/CustomPanelConfigOptions.html +29 -0
  117. package/dist/docs/carbon-tsdocs/interfaces/CustomPanelInstance.html +9 -0
  118. package/dist/docs/carbon-tsdocs/interfaces/CustomPanels.html +4 -0
  119. package/dist/docs/carbon-tsdocs/interfaces/CustomSendMessageOptions.html +3 -0
  120. package/dist/docs/carbon-tsdocs/interfaces/DisclaimerPublicConfig.html +5 -0
  121. package/dist/docs/carbon-tsdocs/interfaces/DisconnectedErrorInfo.html +11 -0
  122. package/dist/docs/carbon-tsdocs/interfaces/EndChatInfo.html +8 -0
  123. package/dist/docs/carbon-tsdocs/interfaces/EventHandlers.html +16 -0
  124. package/dist/docs/carbon-tsdocs/interfaces/EventInput.html +6 -0
  125. package/dist/docs/carbon-tsdocs/interfaces/EventInputData.html +6 -0
  126. package/dist/docs/carbon-tsdocs/interfaces/FileUpload.html +12 -0
  127. package/dist/docs/carbon-tsdocs/interfaces/FinalResponseChunk.html +6 -0
  128. package/dist/docs/carbon-tsdocs/interfaces/GenericItem.html +14 -0
  129. package/dist/docs/carbon-tsdocs/interfaces/GenericItemMessageFeedbackOptions.html +27 -0
  130. package/dist/docs/carbon-tsdocs/interfaces/GenericItemMessageOptions.html +6 -0
  131. package/dist/docs/carbon-tsdocs/interfaces/GenesysMessengerConfig.html +8 -0
  132. package/dist/docs/carbon-tsdocs/interfaces/GridItem.html +23 -0
  133. package/dist/docs/carbon-tsdocs/interfaces/HasAddRemoveClassName.html +6 -0
  134. package/dist/docs/carbon-tsdocs/interfaces/HeaderConfig.html +9 -0
  135. package/dist/docs/carbon-tsdocs/interfaces/HistoryItem.html +6 -0
  136. package/dist/docs/carbon-tsdocs/interfaces/HomeScreenConfig.html +14 -0
  137. package/dist/docs/carbon-tsdocs/interfaces/HomeScreenStarterButton.html +7 -0
  138. package/dist/docs/carbon-tsdocs/interfaces/HomeScreenStarterButtons.html +4 -0
  139. package/dist/docs/carbon-tsdocs/interfaces/IFrameItem.html +27 -0
  140. package/dist/docs/carbon-tsdocs/interfaces/InlineErrorItem.html +22 -0
  141. package/dist/docs/carbon-tsdocs/interfaces/InstanceElements.html +8 -0
  142. package/dist/docs/carbon-tsdocs/interfaces/InstanceInputElement.html +13 -0
  143. package/dist/docs/carbon-tsdocs/interfaces/ItemStreamingMetadata.html +12 -0
  144. package/dist/docs/carbon-tsdocs/interfaces/LayoutConfig.html +7 -0
  145. package/dist/docs/carbon-tsdocs/interfaces/MediaItem.html +27 -0
  146. package/dist/docs/carbon-tsdocs/interfaces/MediaItemDimensions.html +6 -0
  147. package/dist/docs/carbon-tsdocs/interfaces/MessageContext.html +9 -0
  148. package/dist/docs/carbon-tsdocs/interfaces/MessageGlobalContext.html +3 -0
  149. package/dist/docs/carbon-tsdocs/interfaces/MessageHistory.html +18 -0
  150. package/dist/docs/carbon-tsdocs/interfaces/MessageInput.html +11 -0
  151. package/dist/docs/carbon-tsdocs/interfaces/MessageItemPanelInfo.html +11 -0
  152. package/dist/docs/carbon-tsdocs/interfaces/MessageOutput.html +4 -0
  153. package/dist/docs/carbon-tsdocs/interfaces/MessageRequest.html +12 -0
  154. package/dist/docs/carbon-tsdocs/interfaces/MessageResponse.html +12 -0
  155. package/dist/docs/carbon-tsdocs/interfaces/MessageSkillContext.html +3 -0
  156. package/dist/docs/carbon-tsdocs/interfaces/MessageSystemContext.html +5 -0
  157. package/dist/docs/carbon-tsdocs/interfaces/NiceDFOConfig.html +14 -0
  158. package/dist/docs/carbon-tsdocs/interfaces/NotificationMessage.html +15 -0
  159. package/dist/docs/carbon-tsdocs/interfaces/OnErrorData.html +13 -0
  160. package/dist/docs/carbon-tsdocs/interfaces/Option.html +7 -0
  161. package/dist/docs/carbon-tsdocs/interfaces/OptionItem.html +23 -0
  162. package/dist/docs/carbon-tsdocs/interfaces/PageLinkConfig.html +6 -0
  163. package/dist/docs/carbon-tsdocs/interfaces/PageLinkIDConfig.html +5 -0
  164. package/dist/docs/carbon-tsdocs/interfaces/PartialItemChunk.html +38 -0
  165. package/dist/docs/carbon-tsdocs/interfaces/PauseItem.html +18 -0
  166. package/dist/docs/carbon-tsdocs/interfaces/PublicConfig.html +80 -0
  167. package/dist/docs/carbon-tsdocs/interfaces/PublicConfigMessaging.html +24 -0
  168. package/dist/docs/carbon-tsdocs/interfaces/PublicWebChatServiceDeskState.html +8 -0
  169. package/dist/docs/carbon-tsdocs/interfaces/PublicWebChatState.html +21 -0
  170. package/dist/docs/carbon-tsdocs/interfaces/RenderUserDefinedState.html +41 -0
  171. package/dist/docs/carbon-tsdocs/interfaces/SendOptions.html +10 -0
  172. package/dist/docs/carbon-tsdocs/interfaces/ServiceDesk.html +74 -0
  173. package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskCallback.html +81 -0
  174. package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskCapabilities.html +9 -0
  175. package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskFactoryParameters.html +8 -0
  176. package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskPublicConfig.html +25 -0
  177. package/dist/docs/carbon-tsdocs/interfaces/StartChatOptions.html +6 -0
  178. package/dist/docs/carbon-tsdocs/interfaces/TableItem.html +22 -0
  179. package/dist/docs/carbon-tsdocs/interfaces/TableItemRow.html +5 -0
  180. package/dist/docs/carbon-tsdocs/interfaces/TextItem.html +19 -0
  181. package/dist/docs/carbon-tsdocs/interfaces/ThemeConfig.html +6 -0
  182. package/dist/docs/carbon-tsdocs/interfaces/TourStepGenericItem.html +17 -0
  183. package/dist/docs/carbon-tsdocs/interfaces/TypeAndHandler.html +6 -0
  184. package/dist/docs/carbon-tsdocs/interfaces/UpdateHistoryEvent.html +10 -0
  185. package/dist/docs/carbon-tsdocs/interfaces/UserDefinedItem.html +13 -0
  186. package/dist/docs/carbon-tsdocs/interfaces/UserMessageErrorInfo.html +8 -0
  187. package/dist/docs/carbon-tsdocs/interfaces/ViewState.html +8 -0
  188. package/dist/docs/carbon-tsdocs/interfaces/WithBodyAndFooter.html +5 -0
  189. package/dist/docs/carbon-tsdocs/types/AudioItem.html +2 -0
  190. package/dist/docs/carbon-tsdocs/types/CardItem.html +1 -0
  191. package/dist/docs/carbon-tsdocs/types/ChangeFunction.html +1 -0
  192. package/dist/docs/carbon-tsdocs/types/ChatHeaderMenuItemTypes.html +2 -0
  193. package/dist/docs/carbon-tsdocs/types/ChatHeaderObjectTypes.html +2 -0
  194. package/dist/docs/carbon-tsdocs/types/DateItem.html +3 -0
  195. package/dist/docs/carbon-tsdocs/types/EventBusHandler.html +3 -0
  196. package/dist/docs/carbon-tsdocs/types/HorizontalCellAlignment.html +1 -0
  197. package/dist/docs/carbon-tsdocs/types/ImageItem.html +2 -0
  198. package/dist/docs/carbon-tsdocs/types/IncreaseOrDecrease.html +1 -0
  199. package/dist/docs/carbon-tsdocs/types/Message.html +2 -0
  200. package/dist/docs/carbon-tsdocs/types/PartialOrCompleteItemChunk.html +1 -0
  201. package/dist/docs/carbon-tsdocs/types/RenderUserDefinedResponse.html +6 -0
  202. package/dist/docs/carbon-tsdocs/types/RenderWriteableElementResponse.html +2 -0
  203. package/dist/docs/carbon-tsdocs/types/ServiceDeskErrorInfo.html +3 -0
  204. package/dist/docs/carbon-tsdocs/types/StreamChunk.html +1 -0
  205. package/dist/docs/carbon-tsdocs/types/TableItemCell.html +1 -0
  206. package/dist/docs/carbon-tsdocs/types/TableItemRowExpandableSectionItem.html +1 -0
  207. package/dist/docs/carbon-tsdocs/types/VerticalCellAlignment.html +1 -0
  208. package/dist/docs/carbon-tsdocs/types/VideoItem.html +2 -0
  209. package/dist/docs/carbon-tsdocs/types/WriteableElements.html +3 -0
  210. package/dist/es/AppContainer.js +54 -34
  211. package/dist/es/Carousel.js +2 -2
  212. package/dist/es/GenesysMessengerServiceDesk.js +2 -2
  213. package/dist/es/HumanAgentServiceImpl.js +2 -2
  214. package/dist/es/NiceDFOServiceDesk.js +2 -2
  215. package/dist/es/PDFViewerContainer.js +2 -2
  216. package/dist/es/ReactPlayer.js +2 -2
  217. package/dist/es/SFServiceDesk.js +2 -2
  218. package/dist/es/ServiceDeskImpl.js +2 -2
  219. package/dist/es/Table.js +2 -2
  220. package/dist/es/ZendeskServiceDesk.js +2 -2
  221. package/dist/es/_node-resolve_empty.js +2 -2
  222. package/dist/es/aiChatEntry.js +2 -2
  223. package/dist/es/ar-dz.js +2 -2
  224. package/dist/es/ar-kw.js +2 -2
  225. package/dist/es/ar-ly.js +2 -2
  226. package/dist/es/ar-ma.js +2 -2
  227. package/dist/es/ar-sa.js +2 -2
  228. package/dist/es/ar-tn.js +2 -2
  229. package/dist/es/ar.js +2 -2
  230. package/dist/es/ar2.js +2 -2
  231. package/dist/es/cds-aichat-container.js +2 -2
  232. package/dist/es/cds-aichat-custom-element.js +2 -2
  233. package/dist/es/cs.js +2 -2
  234. package/dist/es/cs2.js +2 -2
  235. package/dist/es/de-at.js +2 -2
  236. package/dist/es/de-ch.js +2 -2
  237. package/dist/es/de.js +2 -2
  238. package/dist/es/de2.js +2 -2
  239. package/dist/es/en-au.js +2 -2
  240. package/dist/es/en-ca.js +2 -2
  241. package/dist/es/en-gb.js +2 -2
  242. package/dist/es/en-ie.js +2 -2
  243. package/dist/es/en-il.js +2 -2
  244. package/dist/es/en-nz.js +2 -2
  245. package/dist/es/es-do.js +2 -2
  246. package/dist/es/es-us.js +2 -2
  247. package/dist/es/es.js +2 -2
  248. package/dist/es/es2.js +2 -2
  249. package/dist/es/export.js +2 -2
  250. package/dist/es/export.legacy.js +2 -2
  251. package/dist/es/fr-ca.js +2 -2
  252. package/dist/es/fr-ch.js +2 -2
  253. package/dist/es/fr.js +2 -2
  254. package/dist/es/fr2.js +2 -2
  255. package/dist/es/it-ch.js +2 -2
  256. package/dist/es/it.js +2 -2
  257. package/dist/es/it2.js +2 -2
  258. package/dist/es/ja.js +2 -2
  259. package/dist/es/ja2.js +2 -2
  260. package/dist/es/ko.js +2 -2
  261. package/dist/es/ko2.js +2 -2
  262. package/dist/es/mockServiceDesk.js +2 -2
  263. package/dist/es/nl.js +2 -2
  264. package/dist/es/nl2.js +2 -2
  265. package/dist/es/pt-br.js +2 -2
  266. package/dist/es/pt-br2.js +2 -2
  267. package/dist/es/pt.js +2 -2
  268. package/dist/es/scriptRender.js +2 -2
  269. package/dist/es/zh-cn.js +2 -2
  270. package/dist/es/zh-tw.js +2 -2
  271. package/dist/es/zh-tw2.js +2 -2
  272. package/dist/es/zh.js +2 -2
  273. package/package.json +1 -1
package/dist/docs/carbon-tsdocs/interfaces/PauseItem.html ADDED
@@ -0,0 +1,18 @@
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>PauseItem | 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="PauseItem.html">PauseItem</a></li></ul><h1>Interface PauseItem&lt;TUserDefinedType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A pause item returned in a message response from a back-end. This indicates that the client should pause before
2
+ displaying additional response items.</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">PauseItem</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="PauseItem.html#tuserdefinedtype">TUserDefinedType</a> <span class="tsd-signature-symbol">=</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="PauseItem.html#agent_message_type">agent_message_type</a><span class="tsd-signature-symbol">?:</span> <a href="../enums/AgentMessageType.html" class="tsd-signature-type tsd-kind-enum">AgentMessageType</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PauseItem.html#message_options">message_options</a><span class="tsd-signature-symbol">?:</span> <a href="GenericItemMessageOptions.html" class="tsd-signature-type tsd-kind-interface">GenericItemMessageOptions</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PauseItem.html#response_type">response_type</a><span class="tsd-signature-symbol">:</span> <a href="../enums/MessageResponseTypes.html" class="tsd-signature-type tsd-kind-enum">MessageResponseTypes</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PauseItem.html#streaming_metadata">streaming_metadata</a><span class="tsd-signature-symbol">?:</span> <a href="ItemStreamingMetadata.html" class="tsd-signature-type tsd-kind-interface">ItemStreamingMetadata</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PauseItem.html#time">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="PauseItem.html#typing">typing</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="PauseItem.html#user_defined">user_defined</a><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="PauseItem.html#tuserdefinedtype">TUserDefinedType</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="tuserdefinedtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TUserDefinedType</span> = <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li></ul></section> <section class="tsd-panel tsd-hierarchy" data-refl="1420"><h4>Hierarchy (<a href="../hierarchy.html#PauseItem">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="PauseItem.html#tuserdefinedtype">TUserDefinedType</a><span class="tsd-signature-symbol">&gt;</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">PauseItem</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="PauseItem.html#agent_message_type" class="tsd-index-link tsd-is-inherited"><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/>message_<wbr/>type?</span></a>
4
+ <a href="PauseItem.html#message_options" class="tsd-index-link tsd-is-inherited"><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/>options?</span></a>
5
+ <a href="PauseItem.html#response_type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response_<wbr/>type</span></a>
6
+ <a href="PauseItem.html#streaming_metadata" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>streaming_<wbr/>metadata?</span></a>
7
+ <a href="PauseItem.html#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>time?</span></a>
8
+ <a href="PauseItem.html#typing" 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>typing?</span></a>
9
+ <a href="PauseItem.html#user_defined" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>user_<wbr/>defined?</span></a>
10
+ </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 tsd-is-inherited"><a id="agent_message_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>agent_<wbr/>message_<wbr/>type</span><a href="#agent_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">agent_message_type</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/AgentMessageType.html" class="tsd-signature-type tsd-kind-enum">AgentMessageType</a></div><div class="tsd-comment tsd-typography"><p>For messages that are sent between the user and a human agent, we assign an agent type to the message to distinguish what type it is.</p>
11
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#agent_message_type">agent_message_type</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="message_options" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>message_<wbr/>options</span><a href="#message_options" 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_options</span><span class="tsd-signature-symbol">?:</span> <a href="GenericItemMessageOptions.html" class="tsd-signature-type tsd-kind-interface">GenericItemMessageOptions</a></div><div class="tsd-comment tsd-typography"><p>Options that control additional features available for a message item.</p>
12
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#message_options">message_options</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="response_type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>response_<wbr/>type</span><a href="#response_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">response_type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/MessageResponseTypes.html" class="tsd-signature-type tsd-kind-enum">MessageResponseTypes</a></div><div class="tsd-comment tsd-typography"><p>The response type of this message item.</p>
13
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#response_type">response_type</a></p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="streaming_metadata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>streaming_<wbr/>metadata</span><a href="#streaming_metadata" 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">streaming_metadata</span><span class="tsd-signature-symbol">?:</span> <a href="ItemStreamingMetadata.html" class="tsd-signature-type tsd-kind-interface">ItemStreamingMetadata</a></div><div class="tsd-comment tsd-typography"><p>Metadata used identify a generic item within the context of a stream in order to correlate any updates meant
14
+ for a specific item.</p>
15
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#streaming_metadata">streaming_metadata</a></p></aside></section><section class="tsd-panel tsd-member"><a id="time" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>time</span><a href="#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">time</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>How long to pause, in milliseconds.</p>
16
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="typing" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>typing</span><a href="#typing" 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">typing</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to display an &quot;is typing&quot; indicator during the pause.</p>
17
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="user_defined" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>user_<wbr/>defined</span><a href="#user_defined" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">user_defined</span><span class="tsd-signature-symbol">?:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="PauseItem.html#tuserdefinedtype">TUserDefinedType</a></div><div class="tsd-comment tsd-typography"><p>An optional buckets of additional user defined properties for this item.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from <a href="GenericItem.html">GenericItem</a>.<a href="GenericItem.html#user_defined">user_defined</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="#agent_message_type" class="tsd-is-inherited"><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/>message_<wbr/>type</span></a><a href="#message_options" class="tsd-is-inherited"><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/>options</span></a><a href="#response_type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>response_<wbr/>type</span></a><a href="#streaming_metadata" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>streaming_<wbr/>metadata</span></a><a href="#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>time</span></a><a href="#typing" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>typing</span></a><a href="#user_defined" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>user_<wbr/>defined</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>
package/dist/docs/carbon-tsdocs/interfaces/PublicConfig.html ADDED
@@ -0,0 +1,80 @@
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>PublicConfig | 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="PublicConfig.html">PublicConfig</a></li></ul><h1>Interface PublicConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This file contains the definition for the public application configuration operations that are provided by the
2
+ host page.</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">PublicConfig</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#agentappconfig">agentAppConfig</a><span class="tsd-signature-symbol">?:</span> <a href="AgentAppConfig.html" class="tsd-signature-type tsd-kind-interface">AgentAppConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#cspnonce">cspNonce</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="PublicConfig.html#debug">debug</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="PublicConfig.html#disablecustomelementmobileenhancements">disableCustomElementMobileEnhancements</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="PublicConfig.html#disablepdfviewer">disablePDFViewer</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="PublicConfig.html#disablewindowtitlechanges">disableWindowTitleChanges</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="PublicConfig.html#disclaimer">disclaimer</a><span class="tsd-signature-symbol">?:</span> <a href="DisclaimerPublicConfig.html" class="tsd-signature-type tsd-kind-interface">DisclaimerPublicConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#element">element</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#enablefocustrap">enableFocusTrap</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="PublicConfig.html#headerconfig">headerConfig</a><span class="tsd-signature-symbol">?:</span> <a href="HeaderConfig.html" class="tsd-signature-type tsd-kind-interface">HeaderConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#layout">layout</a><span class="tsd-signature-symbol">?:</span> <a href="LayoutConfig.html" class="tsd-signature-type tsd-kind-interface">LayoutConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#messaging">messaging</a><span class="tsd-signature-symbol">?:</span> <a href="PublicConfigMessaging.html" class="tsd-signature-type tsd-kind-interface">PublicConfigMessaging</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#namespace">namespace</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="PublicConfig.html#onerror">onError</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <a href="OnErrorData.html" class="tsd-signature-type tsd-kind-interface">OnErrorData</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#onload">onLoad</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span><span class="tsd-signature-symbol">:</span> <a href="ChatInstance.html" class="tsd-signature-type tsd-kind-interface">ChatInstance</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#openchatbydefault">openChatByDefault</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="PublicConfig.html#pagelinkconfig">pageLinkConfig</a><span class="tsd-signature-symbol">?:</span> <a href="PageLinkConfig.html" class="tsd-signature-type tsd-kind-interface">PageLinkConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#servicedesk">serviceDesk</a><span class="tsd-signature-symbol">?:</span> <a href="ServiceDeskPublicConfig.html" class="tsd-signature-type tsd-kind-interface">ServiceDeskPublicConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#servicedeskfactory">serviceDeskFactory</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">:</span> <a href="ServiceDeskFactoryParameters.html" class="tsd-signature-type tsd-kind-interface">ServiceDeskFactoryParameters</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="ServiceDesk.html" class="tsd-signature-type tsd-kind-interface">ServiceDesk</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#shouldsanitizehtml">shouldSanitizeHTML</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="PublicConfig.html#shouldtakefocusifopensautomatically">shouldTakeFocusIfOpensAutomatically</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="PublicConfig.html#showlauncher">showLauncher</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="PublicConfig.html#streaming">streaming</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">disabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#themeconfig">themeConfig</a><span class="tsd-signature-symbol">?:</span> <a href="ThemeConfig.html" class="tsd-signature-type tsd-kind-interface">ThemeConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfig.html#tourconfig">tourConfig</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">hideChatButton</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">hideMinimizeButton</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <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="PublicConfig.html#agentappconfig" 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/>App<wbr/>Config?</span></a>
4
+ <a href="PublicConfig.html#cspnonce" 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>csp<wbr/>Nonce?</span></a>
5
+ <a href="PublicConfig.html#debug" 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>debug?</span></a>
6
+ <a href="PublicConfig.html#disablecustomelementmobileenhancements" 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>disable<wbr/>Custom<wbr/>Element<wbr/>Mobile<wbr/>Enhancements?</span></a>
7
+ <a href="PublicConfig.html#disablepdfviewer" 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>disablePDFViewer?</span></a>
8
+ <a href="PublicConfig.html#disablewindowtitlechanges" 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>disable<wbr/>Window<wbr/>Title<wbr/>Changes?</span></a>
9
+ <a href="PublicConfig.html#disclaimer" 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>disclaimer?</span></a>
10
+ <a href="PublicConfig.html#element" 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>element?</span></a>
11
+ <a href="PublicConfig.html#enablefocustrap" 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>enable<wbr/>Focus<wbr/>Trap?</span></a>
12
+ <a href="PublicConfig.html#headerconfig" 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>header<wbr/>Config?</span></a>
13
+ <a href="PublicConfig.html#layout" 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>layout?</span></a>
14
+ <a href="PublicConfig.html#messaging" 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>messaging?</span></a>
15
+ <a href="PublicConfig.html#namespace" 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>namespace?</span></a>
16
+ <a href="PublicConfig.html#onerror" 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>on<wbr/>Error?</span></a>
17
+ <a href="PublicConfig.html#onload" 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>on<wbr/>Load?</span></a>
18
+ <a href="PublicConfig.html#openchatbydefault" 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>open<wbr/>Chat<wbr/>By<wbr/>Default?</span></a>
19
+ <a href="PublicConfig.html#pagelinkconfig" 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>page<wbr/>Link<wbr/>Config?</span></a>
20
+ <a href="PublicConfig.html#servicedesk" 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>service<wbr/>Desk?</span></a>
21
+ <a href="PublicConfig.html#servicedeskfactory" 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>service<wbr/>Desk<wbr/>Factory?</span></a>
22
+ <a href="PublicConfig.html#shouldsanitizehtml" 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>should<wbr/>SanitizeHTML?</span></a>
23
+ <a href="PublicConfig.html#shouldtakefocusifopensautomatically" 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>should<wbr/>Take<wbr/>Focus<wbr/>If<wbr/>Opens<wbr/>Automatically?</span></a>
24
+ <a href="PublicConfig.html#showlauncher" 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>show<wbr/>Launcher?</span></a>
25
+ <a href="PublicConfig.html#streaming" 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>streaming?</span></a>
26
+ <a href="PublicConfig.html#themeconfig" 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>theme<wbr/>Config?</span></a>
27
+ <a href="PublicConfig.html#tourconfig" 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>tour<wbr/>Config?</span></a>
28
+ </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="agentappconfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>agent<wbr/>App<wbr/>Config</span><a href="#agentappconfig" 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">agentAppConfig</span><span class="tsd-signature-symbol">?:</span> <a href="AgentAppConfig.html" class="tsd-signature-type tsd-kind-interface">AgentAppConfig</a></div><div class="tsd-comment tsd-typography"><p>Agent app is a mode of web chat used in service desk UIs to show the chat history to the agent. Setting this flag
29
+ will adjust the way web chat renders and behaves, e.g. with no input field, opens by default, etc</p>
30
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="cspnonce" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>csp<wbr/>Nonce</span><a href="#cspnonce" 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">cspNonce</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>A nonce value to set on restricted elements to allow them to satisfy a Content-Security-Policy. If a website is
31
+ using a Content-Security-Policy along with a nonce to whitelist which style and script elements are allowed,
32
+ the site can provide this nonce value here which will then be added to the dynamic script and style tags
33
+ generated by the widget which will allow them to run.</p>
34
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="debug" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>debug</span><a href="#debug" 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">debug</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Add a bunch of noisy console.log messages!</p>
35
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="disablecustomelementmobileenhancements" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disable<wbr/>Custom<wbr/>Element<wbr/>Mobile<wbr/>Enhancements</span><a href="#disablecustomelementmobileenhancements" 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">disableCustomElementMobileEnhancements</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>This value is only used when a custom element is being used to render the widget. By default, a number of
36
+ enhancements to the widget are activated on mobile devices which can interfere with a custom element. This
37
+ value can be used to disable those enhancements while using a custom element.</p>
38
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="disablepdfviewer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disablePDFViewer</span><a href="#disablepdfviewer" 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">disablePDFViewer</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 internal web chat PDF viewer should be disabled. If true, web chat will present links to PDFs
39
+ as actual links that will open in the user's web browser using the browser's native viewer instead of the web chat
40
+ viewer.</p>
41
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="disablewindowtitlechanges" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disable<wbr/>Window<wbr/>Title<wbr/>Changes</span><a href="#disablewindowtitlechanges" 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">disableWindowTitleChanges</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If true, disables functionality in web chat that changes the window title.</p>
42
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="disclaimer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disclaimer</span><a href="#disclaimer" 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">disclaimer</span><span class="tsd-signature-symbol">?:</span> <a href="DisclaimerPublicConfig.html" class="tsd-signature-type tsd-kind-interface">DisclaimerPublicConfig</a></div><div class="tsd-comment tsd-typography"><p>Beta version of disclaimer screen. No tooling for this.</p>
43
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="element" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>element</span><a href="#element" 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">element</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Element</span></div><div class="tsd-comment tsd-typography"><p>An optional element the page can use as a custom in to which to render the widget.</p>
44
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="enablefocustrap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>enable<wbr/>Focus<wbr/>Trap</span><a href="#enablefocustrap" 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">enableFocusTrap</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if a focus trap should be enabled when the web chat is open.</p>
45
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="headerconfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>header<wbr/>Config</span><a href="#headerconfig" 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">headerConfig</span><span class="tsd-signature-symbol">?:</span> <a href="HeaderConfig.html" class="tsd-signature-type tsd-kind-interface">HeaderConfig</a></div><div class="tsd-comment tsd-typography"><p>Extra config for controlling the behavior of the header.</p>
46
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="layout" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>layout</span><a href="#layout" 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">layout</span><span class="tsd-signature-symbol">?:</span> <a href="LayoutConfig.html" class="tsd-signature-type tsd-kind-interface">LayoutConfig</a></div><div class="tsd-comment tsd-typography"><p>The config object for changing web chat's layout.</p>
47
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="messaging" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>messaging</span><a href="#messaging" 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">messaging</span><span class="tsd-signature-symbol">?:</span> <a href="PublicConfigMessaging.html" class="tsd-signature-type tsd-kind-interface">PublicConfigMessaging</a></div><div class="tsd-comment tsd-typography"><p>Config options for controlling messaging.</p>
48
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="namespace" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>namespace</span><a href="#namespace" 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">namespace</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>An optional namespace that can be added to the web chat that must be 30 characters or under. This value is
49
+ intended to enable multiple instances of the web chat to be used on the same page. The namespace for this web
50
+ chat. This value is used to generate a value to append to anything unique (id, session keys, etc) to allow
51
+ multiple web chats on the same page.</p>
52
+ <p>Note: this value is used in the aria region label for the web chat. This means this value will be read out loud
53
+ by users using a screen reader.</p>
54
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="onerror" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Error</span><a href="#onerror" 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">onError</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <a href="OnErrorData.html" class="tsd-signature-type tsd-kind-interface">OnErrorData</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>This is a one-off listener for errors. This value may be provided in the initial page config as a hook for
55
+ customers to listen for errors. We use this instead of a normal event bus handler because this function can be
56
+ defined and called before the event bus has been created which allows it to be used in loadWatsonAssistantChat.</p>
57
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="onload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>on<wbr/>Load</span><a href="#onload" 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">onLoad</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span><span class="tsd-signature-symbol">:</span> <a href="ChatInstance.html" class="tsd-signature-type tsd-kind-interface">ChatInstance</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>The callback function that is called by the loadWatsonAssistantChat script once it is loaded. This is optional;
58
+ to use web chat without this requires using the &quot;window.loadWatsonAssistantChat&quot; function instead.</p>
59
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="openchatbydefault" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>open<wbr/>Chat<wbr/>By<wbr/>Default</span><a href="#openchatbydefault" 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">openChatByDefault</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>By default, the chat window will be rendered in a &quot;closed&quot; state.</p>
60
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="pagelinkconfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>page<wbr/>Link<wbr/>Config</span><a href="#pagelinkconfig" 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">pageLinkConfig</span><span class="tsd-signature-symbol">?:</span> <a href="PageLinkConfig.html" class="tsd-signature-type tsd-kind-interface">PageLinkConfig</a></div><div class="tsd-comment tsd-typography"><p>The configuration that defines how web chat responds to link page requests (where there's a link reference in the
61
+ URL).</p>
62
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="servicedesk" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>service<wbr/>Desk</span><a href="#servicedesk" 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">serviceDesk</span><span class="tsd-signature-symbol">?:</span> <a href="ServiceDeskPublicConfig.html" class="tsd-signature-type tsd-kind-interface">ServiceDeskPublicConfig</a></div><div class="tsd-comment tsd-typography"><p>Any public config to apply to service desks.</p>
63
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="servicedeskfactory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>service<wbr/>Desk<wbr/>Factory</span><a href="#servicedeskfactory" 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">serviceDeskFactory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">:</span> <a href="ServiceDeskFactoryParameters.html" class="tsd-signature-type tsd-kind-interface">ServiceDeskFactoryParameters</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="ServiceDesk.html" class="tsd-signature-type tsd-kind-interface">ServiceDesk</a><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>This is a factory for producing custom implementations of service desks. If this value is set, then this will
64
+ be used to create an instance of a <a href="ServiceDesk.html" class="tsd-kind-interface">ServiceDesk</a> when the user attempts to connect to an agent.</p>
65
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="shouldsanitizehtml" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>should<wbr/>SanitizeHTML</span><a href="#shouldsanitizehtml" 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">shouldSanitizeHTML</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if web chat should sanitize HTML from a user or from the assistant.</p>
66
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="shouldtakefocusifopensautomatically" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>should<wbr/>Take<wbr/>Focus<wbr/>If<wbr/>Opens<wbr/>Automatically</span><a href="#shouldtakefocusifopensautomatically" 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">shouldTakeFocusIfOpensAutomatically</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If the web chat should grab focus if the web chat is open on page load. This applies to session history open
67
+ states as well as openByChatByDefault. This should be set to false if the web chat is embedded in the tooling, for
68
+ instance.</p>
69
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="showlauncher" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>show<wbr/>Launcher</span><a href="#showlauncher" 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">showLauncher</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Render the chat launcher element used to open and close the chat window. If you elect to not show our built in
70
+ chat launcher, you will be responsible for firing the launcher:toggle, launcher:open or launcher:close events
71
+ from your own chat launcher. Or, you can use options.openChatByDefault to just have the chat interface be open
72
+ at initialization.</p>
73
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="streaming" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>streaming</span><a href="#streaming" 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">streaming</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">disabled</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>Configuration to control how streaming works.</p>
74
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">disabled</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Indicates if streaming is disabled or not. Streaming is disabled by default but can be enabled through this
75
+ configuration or tooling. When streaming is enabled, the assistant may return a text/event-stream response for a
76
+ message request.</p>
77
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="themeconfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>theme<wbr/>Config</span><a href="#themeconfig" 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">themeConfig</span><span class="tsd-signature-symbol">?:</span> <a href="ThemeConfig.html" class="tsd-signature-type tsd-kind-interface">ThemeConfig</a></div></section><section class="tsd-panel tsd-member"><a id="tourconfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>tour<wbr/>Config</span><a href="#tourconfig" 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">tourConfig</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">hideChatButton</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">hideMinimizeButton</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></div><div class="tsd-comment tsd-typography"><p>A config object to modify tours.</p>
78
+ </div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hideChatButton</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Indicates if the chat button should be hidden.</p>
79
+ </div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">hideMinimizeButton</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Indicates if the minimize button should be hidden.</p>
80
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></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="#agentappconfig" 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/>App<wbr/>Config</span></a><a href="#cspnonce" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>csp<wbr/>Nonce</span></a><a href="#debug" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>debug</span></a><a href="#disablecustomelementmobileenhancements" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Custom<wbr/>Element<wbr/>Mobile<wbr/>Enhancements</span></a><a href="#disablepdfviewer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disablePDFViewer</span></a><a href="#disablewindowtitlechanges" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disable<wbr/>Window<wbr/>Title<wbr/>Changes</span></a><a href="#disclaimer" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>disclaimer</span></a><a href="#element" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>element</span></a><a href="#enablefocustrap" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>enable<wbr/>Focus<wbr/>Trap</span></a><a href="#headerconfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>header<wbr/>Config</span></a><a href="#layout" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>layout</span></a><a href="#messaging" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>messaging</span></a><a href="#namespace" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>namespace</span></a><a href="#onerror" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Error</span></a><a href="#onload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>on<wbr/>Load</span></a><a href="#openchatbydefault" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>open<wbr/>Chat<wbr/>By<wbr/>Default</span></a><a href="#pagelinkconfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>page<wbr/>Link<wbr/>Config</span></a><a href="#servicedesk" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>service<wbr/>Desk</span></a><a href="#servicedeskfactory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>service<wbr/>Desk<wbr/>Factory</span></a><a href="#shouldsanitizehtml" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>should<wbr/>SanitizeHTML</span></a><a href="#shouldtakefocusifopensautomatically" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>should<wbr/>Take<wbr/>Focus<wbr/>If<wbr/>Opens<wbr/>Automatically</span></a><a href="#showlauncher" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>show<wbr/>Launcher</span></a><a href="#streaming" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>streaming</span></a><a href="#themeconfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>theme<wbr/>Config</span></a><a href="#tourconfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>tour<wbr/>Config</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>
package/dist/docs/carbon-tsdocs/interfaces/PublicConfigMessaging.html ADDED
@@ -0,0 +1,24 @@
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>PublicConfigMessaging | 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="PublicConfigMessaging.html">PublicConfigMessaging</a></li></ul><h1>Interface PublicConfigMessaging</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Config options for controlling messaging.</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">PublicConfigMessaging</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="PublicConfigMessaging.html#copypreviouscontextonrequest">copyPreviousContextOnRequest</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="PublicConfigMessaging.html#customloadhistory">customLoadHistory</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span><span class="tsd-signature-symbol">:</span> <a href="ChatInstance.html" class="tsd-signature-type tsd-kind-interface">ChatInstance</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="HistoryItem.html" class="tsd-signature-type tsd-kind-interface">HistoryItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfigMessaging.html#customsendmessage">customSendMessage</a><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">request</span><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/>        <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">:</span> <a href="CustomSendMessageOptions.html" class="tsd-signature-type tsd-kind-interface">CustomSendMessageOptions</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">instance</span><span class="tsd-signature-symbol">:</span> <a href="ChatInstance.html" class="tsd-signature-type tsd-kind-interface">ChatInstance</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicConfigMessaging.html#messageloadingindicatortimeoutsecs">messageLoadingIndicatorTimeoutSecs</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="PublicConfigMessaging.html#messagetimeoutsecs">messageTimeoutSecs</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="PublicConfigMessaging.html#skipwelcome">skipWelcome</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="PublicConfigMessaging.html#copypreviouscontextonrequest" 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>copy<wbr/>Previous<wbr/>Context<wbr/>On<wbr/>Request?</span></a>
3
+ <a href="PublicConfigMessaging.html#customloadhistory" 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>custom<wbr/>Load<wbr/>History?</span></a>
4
+ <a href="PublicConfigMessaging.html#customsendmessage" 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>custom<wbr/>Send<wbr/>Message?</span></a>
5
+ <a href="PublicConfigMessaging.html#messageloadingindicatortimeoutsecs" 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/>Loading<wbr/>Indicator<wbr/>Timeout<wbr/>Secs?</span></a>
6
+ <a href="PublicConfigMessaging.html#messagetimeoutsecs" 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/>Timeout<wbr/>Secs?</span></a>
7
+ <a href="PublicConfigMessaging.html#skipwelcome" 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>skip<wbr/>Welcome?</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="copypreviouscontextonrequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>copy<wbr/>Previous<wbr/>Context<wbr/>On<wbr/>Request</span><a href="#copypreviouscontextonrequest" 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">copyPreviousContextOnRequest</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 context from the previous response should be copied on the next request. This is true by default.</p>
9
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="customloadhistory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>custom<wbr/>Load<wbr/>History</span><a href="#customloadhistory" 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">customLoadHistory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">instance</span><span class="tsd-signature-symbol">:</span> <a href="ChatInstance.html" class="tsd-signature-type tsd-kind-interface">ChatInstance</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="HistoryItem.html" class="tsd-signature-type tsd-kind-interface">HistoryItem</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>This is a callback function that is used by web chat to retrieve history data for populating the web chat. If
10
+ this function is defined, it will be used instead of any other mechanism for fetching history.</p>
11
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="customsendmessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>custom<wbr/>Send<wbr/>Message</span><a href="#customsendmessage" 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">customSendMessage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">request</span><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/>    <span class="tsd-kind-parameter">requestOptions</span><span class="tsd-signature-symbol">:</span> <a href="CustomSendMessageOptions.html" class="tsd-signature-type tsd-kind-interface">CustomSendMessageOptions</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">instance</span><span class="tsd-signature-symbol">:</span> <a href="ChatInstance.html" class="tsd-signature-type tsd-kind-interface">ChatInstance</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>A callback for web chat to use to send messages to the assistant. When this is provided, this will be used as
12
+ an alternative for its built-in message service. Note that this is not used for human agent communication
13
+ (except for the event messages to update history).</p>
14
+ <p>Web chat will queue up any additional user messages until the Promise from a previous call to customSendMessage
15
+ has resolved. This does not include event messages. If the Promise rejects, an error indicator will be
16
+ displayed next to the user's message.</p>
17
+ <p>If the request takes longer than PublicConfigMessaging.messageTimeoutSecs than the AbortSignal will be sent.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="messageloadingindicatortimeoutsecs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>message<wbr/>Loading<wbr/>Indicator<wbr/>Timeout<wbr/>Secs</span><a href="#messageloadingindicatortimeoutsecs" 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">messageLoadingIndicatorTimeoutSecs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Controls how long AI chat should wait before showing the loading indicator.</p>
19
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="messagetimeoutsecs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>message<wbr/>Timeout<wbr/>Secs</span><a href="#messagetimeoutsecs" 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">messageTimeoutSecs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>Changes the timeout used by the message service when making message calls. The timeout is in seconds. The
20
+ default is 40 seconds. After this time, an error will be shown in the client and an Abort signal will be sent
21
+ to customSendMessage.</p>
22
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="skipwelcome" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>skip<wbr/>Welcome</span><a href="#skipwelcome" 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">skipWelcome</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if web chat should make a request for the welcome message when a new conversation begins. If this is
23
+ true, then web chat will start with an empty conversation.</p>
24
+ </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="#copypreviouscontextonrequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>copy<wbr/>Previous<wbr/>Context<wbr/>On<wbr/>Request</span></a><a href="#customloadhistory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom<wbr/>Load<wbr/>History</span></a><a href="#customsendmessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>custom<wbr/>Send<wbr/>Message</span></a><a href="#messageloadingindicatortimeoutsecs" 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/>Loading<wbr/>Indicator<wbr/>Timeout<wbr/>Secs</span></a><a href="#messagetimeoutsecs" 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/>Timeout<wbr/>Secs</span></a><a href="#skipwelcome" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>skip<wbr/>Welcome</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>
package/dist/docs/carbon-tsdocs/interfaces/PublicWebChatServiceDeskState.html ADDED
@@ -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>PublicWebChatServiceDeskState | 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="PublicWebChatServiceDeskState.html">PublicWebChatServiceDeskState</a></li></ul><h1>Interface PublicWebChatServiceDeskState</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">PublicWebChatServiceDeskState</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="PublicWebChatServiceDeskState.html#isconnected">isConnected</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="PublicWebChatServiceDeskState.html#isconnecting">isConnecting</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="PublicWebChatServiceDeskState.html#issuspended">isSuspended</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="PublicWebChatServiceDeskState.html#isconnected" 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/>Connected</span></a>
2
+ <a href="PublicWebChatServiceDeskState.html#isconnecting" 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/>Connecting</span></a>
3
+ <a href="PublicWebChatServiceDeskState.html#issuspended" 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/>Suspended</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="isconnected" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Connected</span><a href="#isconnected" 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">isConnected</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Is the web chat currently connected with a human agent.</p>
5
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="isconnecting" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Connecting</span><a href="#isconnecting" 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">isConnecting</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if web chat has requested to be connected to a human agent but an agent has not yet joined the
6
+ conversation.</p>
7
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="issuspended" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Suspended</span><a href="#issuspended" 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">isSuspended</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if a conversation with a human agent has been suspended.</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="#isconnected" 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/>Connected</span></a><a href="#isconnecting" 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/>Connecting</span></a><a href="#issuspended" 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/>Suspended</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>
package/dist/docs/carbon-tsdocs/interfaces/PublicWebChatState.html ADDED
@@ -0,0 +1,21 @@
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>PublicWebChatState | 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="PublicWebChatState.html">PublicWebChatState</a></li></ul><h1>Interface PublicWebChatState</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This is the state made available by calling getState. This is a public method that returns immutable values.</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">PublicWebChatState</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="PublicWebChatState.html#hasusersentmessage">hasUserSentMessage</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="PublicWebChatState.html#isconnectedwithhumanagent">isConnectedWithHumanAgent</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="PublicWebChatState.html#isconnectingwithhumanagent">isConnectingWithHumanAgent</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="PublicWebChatState.html#isdebugenabled">isDebugEnabled</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="PublicWebChatState.html#ishomescreenopen">isHomeScreenOpen</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="PublicWebChatState.html#istouractive">isTourActive</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="PublicWebChatState.html#iswebchatopen">isWebChatOpen</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="PublicWebChatState.html#servicedesk">serviceDesk</a><span class="tsd-signature-symbol">:</span> <a href="PublicWebChatServiceDeskState.html" class="tsd-signature-type tsd-kind-interface">PublicWebChatServiceDeskState</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="PublicWebChatState.html#viewstate">viewState</a><span class="tsd-signature-symbol">:</span> <a href="ViewState.html" class="tsd-signature-type tsd-kind-interface">ViewState</a><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="PublicWebChatState.html#hasusersentmessage" 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>has<wbr/>User<wbr/>Sent<wbr/>Message</span></a>
3
+ <a href="PublicWebChatState.html#isconnectedwithhumanagent" 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/>Connected<wbr/>With<wbr/>Human<wbr/>Agent</span></a>
4
+ <a href="PublicWebChatState.html#isconnectingwithhumanagent" 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/>Connecting<wbr/>With<wbr/>Human<wbr/>Agent</span></a>
5
+ <a href="PublicWebChatState.html#isdebugenabled" 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/>Debug<wbr/>Enabled</span></a>
6
+ <a href="PublicWebChatState.html#ishomescreenopen" 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/>Home<wbr/>Screen<wbr/>Open</span></a>
7
+ <a href="PublicWebChatState.html#istouractive" 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/>Tour<wbr/>Active</span></a>
8
+ <a href="PublicWebChatState.html#iswebchatopen" 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/>Web<wbr/>Chat<wbr/>Open</span></a>
9
+ <a href="PublicWebChatState.html#servicedesk" 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>service<wbr/>Desk</span></a>
10
+ <a href="PublicWebChatState.html#viewstate" 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>view<wbr/>State</span></a>
11
+ </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="hasusersentmessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>has<wbr/>User<wbr/>Sent<wbr/>Message</span><a href="#hasusersentmessage" 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">hasUserSentMessage</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Has the user sent a message that isn't requesting the welcome node.</p>
12
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="isconnectedwithhumanagent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Connected<wbr/>With<wbr/>Human<wbr/>Agent</span><a href="#isconnectedwithhumanagent" 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">isConnectedWithHumanAgent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Is the web chat currently connected with a human agent.</p>
13
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="isconnectingwithhumanagent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Connecting<wbr/>With<wbr/>Human<wbr/>Agent</span><a href="#isconnectingwithhumanagent" 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">isConnectingWithHumanAgent</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if web chat has requested to be connected to a human agent but an agent has not yet joined the
14
+ conversation.</p>
15
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="isdebugenabled" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Debug<wbr/>Enabled</span><a href="#isdebugenabled" 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">isDebugEnabled</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates if debugging is enabled.</p>
16
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="ishomescreenopen" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Home<wbr/>Screen<wbr/>Open</span><a href="#ishomescreenopen" 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">isHomeScreenOpen</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Is the home screen open.</p>
17
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="istouractive" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Tour<wbr/>Active</span><a href="#istouractive" 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">isTourActive</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether there is an active tour currently.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="iswebchatopen" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>is<wbr/>Web<wbr/>Chat<wbr/>Open</span><a href="#iswebchatopen" 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">isWebChatOpen</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Is the web chat currently in an open state.</p>
19
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="servicedesk" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>service<wbr/>Desk</span><a href="#servicedesk" 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">serviceDesk</span><span class="tsd-signature-symbol">:</span> <a href="PublicWebChatServiceDeskState.html" class="tsd-signature-type tsd-kind-interface">PublicWebChatServiceDeskState</a></div><div class="tsd-comment tsd-typography"><p>State regarding service desks.</p>
20
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="viewstate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>view<wbr/>State</span><a href="#viewstate" 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">viewState</span><span class="tsd-signature-symbol">:</span> <a href="ViewState.html" class="tsd-signature-type tsd-kind-interface">ViewState</a></div><div class="tsd-comment tsd-typography"><p>The current viewState of the web chat.</p>
21
+ </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="#hasusersentmessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>has<wbr/>User<wbr/>Sent<wbr/>Message</span></a><a href="#isconnectedwithhumanagent" 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/>Connected<wbr/>With<wbr/>Human<wbr/>Agent</span></a><a href="#isconnectingwithhumanagent" 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/>Connecting<wbr/>With<wbr/>Human<wbr/>Agent</span></a><a href="#isdebugenabled" 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/>Debug<wbr/>Enabled</span></a><a href="#ishomescreenopen" 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/>Home<wbr/>Screen<wbr/>Open</span></a><a href="#istouractive" 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/>Tour<wbr/>Active</span></a><a href="#iswebchatopen" 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/>Web<wbr/>Chat<wbr/>Open</span></a><a href="#servicedesk" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>service<wbr/>Desk</span></a><a href="#viewstate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>view<wbr/>State</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>