@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/ServiceDeskCallback.html ADDED
@@ -0,0 +1,81 @@
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>ServiceDeskCallback | 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="ServiceDeskCallback.html">ServiceDeskCallback</a></li></ul><h1>Interface ServiceDeskCallback&lt;TPersistedStateType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>This interface represents the operations that a service desk integration can call on web chat when it wants web
2
+ chat to do something. When a service desk integration instance is created, web chat will provide an
3
+ implementation of this interface to the integration for it to use.</p>
4
+ </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">ServiceDeskCallback</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ServiceDeskCallback.html#tpersistedstatetype">TPersistedStateType</a> <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">{</span><br/>    <a class="tsd-kind-call-signature" href="ServiceDeskCallback.html#agentendedchat-1">agentEndedChat</a><span class="tsd-signature-symbol">()</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-call-signature" href="ServiceDeskCallback.html#agentjoined-1">agentJoined</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">profile</span><span class="tsd-signature-symbol">:</span> <a href="AgentProfile.html" class="tsd-signature-type tsd-kind-interface">AgentProfile</a><span class="tsd-signature-symbol">)</span><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-call-signature" href="ServiceDeskCallback.html#agentleftchat-1">agentLeftChat</a><span class="tsd-signature-symbol">()</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-call-signature" href="ServiceDeskCallback.html#agentreadmessages-1">agentReadMessages</a><span class="tsd-signature-symbol">()</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-call-signature" href="ServiceDeskCallback.html#agenttyping-1">agentTyping</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">isTyping</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> <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-call-signature" href="ServiceDeskCallback.html#begintransfertoanotheragent-1">beginTransferToAnotherAgent</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">profile</span><span class="tsd-signature-symbol">?:</span> <a href="AgentProfile.html" class="tsd-signature-type tsd-kind-interface">AgentProfile</a><span class="tsd-signature-symbol">)</span><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-call-signature" href="ServiceDeskCallback.html#persistedstate-1">persistedState</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="ServiceDeskCallback.html#tpersistedstatetype">TPersistedStateType</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="ServiceDeskCallback.html#screenshareended-1">screenShareEnded</a><span class="tsd-signature-symbol">()</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-call-signature" href="ServiceDeskCallback.html#screensharerequest-1">screenShareRequest</a><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/ScreenShareState.html" class="tsd-signature-type tsd-kind-enum">ScreenShareState</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="ServiceDeskCallback.html#sendmessagetouser-1">sendMessageToUser</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span><br/>            <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><br/>            <span class="tsd-signature-symbol">|</span> <a href="MessageResponse.html" class="tsd-signature-type tsd-kind-interface">MessageResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</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><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">agentID</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><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-call-signature" href="ServiceDeskCallback.html#seterrorstatus-1">setErrorStatus</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">errorInfo</span><span class="tsd-signature-symbol">:</span> <a href="../types/ServiceDeskErrorInfo.html" class="tsd-signature-type tsd-kind-type-alias">ServiceDeskErrorInfo</a><span class="tsd-signature-symbol">)</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-call-signature" href="ServiceDeskCallback.html#setfileuploadstatus-1">setFileUploadStatus</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">fileID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">isError</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">errorMessage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">)</span><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-call-signature" href="ServiceDeskCallback.html#updateagentavailability-1">updateAgentAvailability</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">availability</span><span class="tsd-signature-symbol">:</span> <a href="AgentAvailability.html" class="tsd-signature-type tsd-kind-interface">AgentAvailability</a><span class="tsd-signature-symbol">)</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-call-signature" href="ServiceDeskCallback.html#updatecapabilities-1">updateCapabilities</a><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">capabilities</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="ServiceDeskCapabilities.html" class="tsd-signature-type tsd-kind-interface">ServiceDeskCapabilities</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-call-signature" href="ServiceDeskCallback.html#updatepersistedstate-1">updatePersistedState</a><span class="tsd-signature-symbol">(</span><br/>        <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DeepPartial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ServiceDeskCallback.html#tpersistedstatetype">TPersistedStateType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-kind-parameter">mergeWithCurrent</span><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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><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="tpersistedstatetype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TPersistedStateType</span> = <span class="tsd-signature-type">unknown</span></span></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">Methods</h3><div class="tsd-index-list"><a href="ServiceDeskCallback.html#agentendedchat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>agent<wbr/>Ended<wbr/>Chat</span></a>
5
+ <a href="ServiceDeskCallback.html#agentjoined" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>agent<wbr/>Joined</span></a>
6
+ <a href="ServiceDeskCallback.html#agentleftchat" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>agent<wbr/>Left<wbr/>Chat</span></a>
7
+ <a href="ServiceDeskCallback.html#agentreadmessages" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>agent<wbr/>Read<wbr/>Messages</span></a>
8
+ <a href="ServiceDeskCallback.html#agenttyping" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>agent<wbr/>Typing</span></a>
9
+ <a href="ServiceDeskCallback.html#begintransfertoanotheragent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>begin<wbr/>Transfer<wbr/>To<wbr/>Another<wbr/>Agent</span></a>
10
+ <a href="ServiceDeskCallback.html#persistedstate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>persisted<wbr/>State</span></a>
11
+ <a href="ServiceDeskCallback.html#screenshareended" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>screen<wbr/>Share<wbr/>Ended</span></a>
12
+ <a href="ServiceDeskCallback.html#screensharerequest" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>screen<wbr/>Share<wbr/>Request</span></a>
13
+ <a href="ServiceDeskCallback.html#sendmessagetouser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>To<wbr/>User</span></a>
14
+ <a href="ServiceDeskCallback.html#seterrorstatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Error<wbr/>Status</span></a>
15
+ <a href="ServiceDeskCallback.html#setfileuploadstatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>File<wbr/>Upload<wbr/>Status</span></a>
16
+ <a href="ServiceDeskCallback.html#updateagentavailability" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Agent<wbr/>Availability</span></a>
17
+ <a href="ServiceDeskCallback.html#updatecapabilities" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Capabilities</span></a>
18
+ <a href="ServiceDeskCallback.html#updatepersistedstate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Persisted<wbr/>State</span></a>
19
+ </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-Methods"><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> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="agentendedchat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>agent<wbr/>Ended<wbr/>Chat</span><a href="#agentendedchat" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="agentendedchat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">agentEndedChat</span><span class="tsd-signature-symbol">()</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><a href="#agentendedchat-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Informs the chat widget that the agent has ended the conversation.</p>
20
+ </div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="agentjoined" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>agent<wbr/>Joined</span><a href="#agentjoined" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="agentjoined-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">agentJoined</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">profile</span><span class="tsd-signature-symbol">:</span> <a href="AgentProfile.html" class="tsd-signature-type tsd-kind-interface">AgentProfile</a><span class="tsd-signature-symbol">)</span><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><a href="#agentjoined-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Informs the chat widget that an agent has joined the chat.</p>
21
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">profile</span>: <a href="AgentProfile.html" class="tsd-signature-type tsd-kind-interface">AgentProfile</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="agentleftchat" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>agent<wbr/>Left<wbr/>Chat</span><a href="#agentleftchat" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="agentleftchat-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">agentLeftChat</span><span class="tsd-signature-symbol">()</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><a href="#agentleftchat-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Informs the chat widget that the agent has left the conversation. This does not end the conversation itself,
22
+ rather the only action that occurs is the visitor receives the agent left status message. If the user sends
23
+ another message, it is up to the service desk to decide what to do with it.</p>
24
+ </div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="agentreadmessages" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>agent<wbr/>Read<wbr/>Messages</span><a href="#agentreadmessages" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="agentreadmessages-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">agentReadMessages</span><span class="tsd-signature-symbol">()</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><a href="#agentreadmessages-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Informs the chat widget that the agent has read all the messages that have been sent to the service desk.</p>
25
+ </div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="agenttyping" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>agent<wbr/>Typing</span><a href="#agenttyping" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="agenttyping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">agentTyping</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">isTyping</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> <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><a href="#agenttyping-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Tells the chat widget if an agent has started or stopped typing.</p>
26
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">isTyping</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>If true, indicates that the agent is typing. False indicates the agent has stopped typing.</p>
27
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="begintransfertoanotheragent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>begin<wbr/>Transfer<wbr/>To<wbr/>Another<wbr/>Agent</span><a href="#begintransfertoanotheragent" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="begintransfertoanotheragent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">beginTransferToAnotherAgent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">profile</span><span class="tsd-signature-symbol">?:</span> <a href="AgentProfile.html" class="tsd-signature-type tsd-kind-interface">AgentProfile</a><span class="tsd-signature-symbol">)</span><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><a href="#begintransfertoanotheragent-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Informs the chat widget that a transfer to another agent is in progress. The agent profile information is
28
+ optional if the service desk doesn't have the information available. This message simply tells the chat widget
29
+ that the transfer has started. The service desk should inform the widget when the transfer is complete by
30
+ sending a <a href="ServiceDeskCallback.html#agentjoined" class="tsd-kind-method">agentJoined</a> message later.</p>
31
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">profile</span>: <a href="AgentProfile.html" class="tsd-signature-type tsd-kind-interface">AgentProfile</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="persistedstate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>persisted<wbr/>State</span><a href="#persistedstate" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="persistedstate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">persistedState</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="ServiceDeskCallback.html#tpersistedstatetype">TPersistedStateType</a><a href="#persistedstate-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the persisted agent state from the store. This is the current state as updated by
32
+ <a href="ServiceDeskCallback.html#updatepersistedstate" class="tsd-kind-method">updatePersistedState</a>. The object returned here is frozen and may not be modified.</p>
33
+ </div><h4 class="tsd-returns-title">Returns <a class="tsd-signature-type tsd-kind-type-parameter" href="ServiceDeskCallback.html#tpersistedstatetype">TPersistedStateType</a></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="screenshareended" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>screen<wbr/>Share<wbr/>Ended</span><a href="#screenshareended" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="screenshareended-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">screenShareEnded</span><span class="tsd-signature-symbol">()</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><a href="#screenshareended-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Informs web chat that a screen sharing session has ended or been cancelled. This may occur while waiting for a
34
+ screen sharing request to be accepted or while screen sharing is in progress.</p>
35
+ </div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="screensharerequest" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>screen<wbr/>Share<wbr/>Request</span><a href="#screensharerequest" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="screensharerequest-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">screenShareRequest</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/ScreenShareState.html" class="tsd-signature-type tsd-kind-enum">ScreenShareState</a><span class="tsd-signature-symbol">&gt;</span><a href="#screensharerequest-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Requests that the user share their screen with the agent. This will present a modal dialog to the user who must
36
+ respond before continuing the conversation. This method returns a Promise that resolves when the user has
37
+ responded to the request or the request times out.</p>
38
+ </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../enums/ScreenShareState.html" class="tsd-signature-type tsd-kind-enum">ScreenShareState</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Returns a Promise that will resolve with the state the of the request. This Promise will reject if no
39
+ chat with an agent is currently running.</p>
40
+ <div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="sendmessagetouser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>To<wbr/>User</span><a href="#sendmessagetouser" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="sendmessagetouser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sendMessageToUser</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span><br/>        <span class="tsd-signature-symbol">|</span> <a href="MessageResponse.html" class="tsd-signature-type tsd-kind-interface">MessageResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</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><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">agentID</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><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><a href="#sendmessagetouser-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a message to the chat widget from an agent.</p>
41
+ <p>Note: The text response type from the standard Watson API is supported in addition to the web chat specific
42
+ MessageResponseTypes.INLINE_ERROR response type.</p>
43
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="MessageResponse.html" class="tsd-signature-type tsd-kind-interface">MessageResponse</a><span class="tsd-signature-symbol">&lt;</span><a href="GenericItem.html" class="tsd-signature-type tsd-kind-interface">GenericItem</a><span class="tsd-signature-symbol">&lt;</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><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The message to display to the user. Note, the ability to pass a string for the message was added in
44
+ web chat 6.7.0. Earlier versions of web chat will not work if you pass just a string.</p>
45
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">agentID</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the agent who is sending the message. If this is not provided, then the ID of the last
46
+ agent who joined the conversation will be used.</p>
47
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="seterrorstatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Error<wbr/>Status</span><a href="#seterrorstatus" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="seterrorstatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setErrorStatus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">errorInfo</span><span class="tsd-signature-symbol">:</span> <a href="../types/ServiceDeskErrorInfo.html" class="tsd-signature-type tsd-kind-type-alias">ServiceDeskErrorInfo</a><span class="tsd-signature-symbol">)</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><a href="#seterrorstatus-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the state of the given error type.</p>
48
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">errorInfo</span>: <a href="../types/ServiceDeskErrorInfo.html" class="tsd-signature-type tsd-kind-type-alias">ServiceDeskErrorInfo</a></span><div class="tsd-comment tsd-typography"><p>Details for the error whose state is being set.</p>
49
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setfileuploadstatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>File<wbr/>Upload<wbr/>Status</span><a href="#setfileuploadstatus" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setfileuploadstatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setFileUploadStatus</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">fileID</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">isError</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">errorMessage</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><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><a href="#setfileuploadstatus-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the status of a file upload. The upload may either be successful or an error may have occurred. The
50
+ location of a file upload may be in one of two places. The first occurs when the user has selected a file to be
51
+ uploaded but has not yet sent the file. In this case, the file appears inside the web chat input area. If an
52
+ error is indicated on the file, the error message will be displayed along with the file and the user must
53
+ remove the file from the input area before a message can be sent.</p>
54
+ <p>The second occurs after the user has sent the file and the service desk has begun to upload the file. In this
55
+ case, the file no longer appears in the input area but appears as a sent message in the message list. If an
56
+ error occurs during this time, an icon will appear next to the message to indicate an error occurred and an
57
+ error message will be added to the message list.</p>
58
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">fileID</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the file upload to update.</p>
59
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">isError</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Indicates that the upload has an error or failed to upload.</p>
60
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">errorMessage</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>An error message to display along with a file in error.</p>
61
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="updateagentavailability" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Agent<wbr/>Availability</span><a href="#updateagentavailability" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="updateagentavailability-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">updateAgentAvailability</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">availability</span><span class="tsd-signature-symbol">:</span> <a href="AgentAvailability.html" class="tsd-signature-type tsd-kind-interface">AgentAvailability</a><span class="tsd-signature-symbol">)</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><a href="#updateagentavailability-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends updated availability information to the chat widget for a user who is waiting to be connected to an
62
+ agent (e.g. the user is number 2 in line). This may be called at any point while waiting for the connection to
63
+ provide newer information.</p>
64
+ <p>Note: Of the fields in the AgentAvailability object, only one of position_in_queue and estimated_wait_time can be
65
+ rendered in the widget. If both fields are provided, estimated_wait_time will take priority and the
66
+ position_in_queue field will be ignored.</p>
67
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">availability</span>: <a href="AgentAvailability.html" class="tsd-signature-type tsd-kind-interface">AgentAvailability</a></span><div class="tsd-comment tsd-typography"><p>The availability information to display to the user.</p>
68
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <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></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="updatecapabilities" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Capabilities</span><a href="#updatecapabilities" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="updatecapabilities-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">updateCapabilities</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">capabilities</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="ServiceDeskCapabilities.html" class="tsd-signature-type tsd-kind-interface">ServiceDeskCapabilities</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updatecapabilities-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates web chat with the capabilities supported by the service desk. Some of these capabilities may support
69
+ being changed dynamically and can be updated at any time.</p>
70
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">capabilities</span>: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><a href="ServiceDeskCapabilities.html" class="tsd-signature-type tsd-kind-interface">ServiceDeskCapabilities</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The set of capabilities to update. Only properties that need to be changed need to be included.</p>
71
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></section><section class="tsd-panel tsd-member"><a id="updatepersistedstate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Persisted<wbr/>State</span><a href="#updatepersistedstate" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="updatepersistedstate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">updatePersistedState</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">state</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DeepPartial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ServiceDeskCallback.html#tpersistedstatetype">TPersistedStateType</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">mergeWithCurrent</span><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><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#updatepersistedstate-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Allows the service desk to store state that may be retrieved when web chat is reloaded on a page. This information
72
+ is stored in browser session storage which has a total limit of 5MB per origin so the storage should be used
73
+ sparingly. Also, the value provided here must be JSON serializable.</p>
74
+ <p>When web chat is reloaded, the data provided here will be returned to the service desk via the
75
+ ServiceDeskFactoryParameters.persistedState property. This data may also be retrieved by using the
76
+ <a href="ServiceDeskCallback.html#persistedstate" class="tsd-kind-method">persistedState</a> method.</p>
77
+ </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">state</span>: <span class="tsd-signature-type">DeepPartial</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="ServiceDeskCallback.html#tpersistedstatetype">TPersistedStateType</a><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>The state to update.</p>
78
+ </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">mergeWithCurrent</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>Indicates if the new state should be merged into the existing state. If false, then the
79
+ existing state will be fully replaced with the new state. Merging with existing state expects the state to be
80
+ an object. This argument is true by default.</p>
81
+ </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></div></li></ul></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-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#agentendedchat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>agent<wbr/>Ended<wbr/>Chat</span></a><a href="#agentjoined" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>agent<wbr/>Joined</span></a><a href="#agentleftchat" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>agent<wbr/>Left<wbr/>Chat</span></a><a href="#agentreadmessages" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>agent<wbr/>Read<wbr/>Messages</span></a><a href="#agenttyping" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>agent<wbr/>Typing</span></a><a href="#begintransfertoanotheragent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>begin<wbr/>Transfer<wbr/>To<wbr/>Another<wbr/>Agent</span></a><a href="#persistedstate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>persisted<wbr/>State</span></a><a href="#screenshareended" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>screen<wbr/>Share<wbr/>Ended</span></a><a href="#screensharerequest" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>screen<wbr/>Share<wbr/>Request</span></a><a href="#sendmessagetouser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>To<wbr/>User</span></a><a href="#seterrorstatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Error<wbr/>Status</span></a><a href="#setfileuploadstatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>File<wbr/>Upload<wbr/>Status</span></a><a href="#updateagentavailability" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Agent<wbr/>Availability</span></a><a href="#updatecapabilities" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Capabilities</span></a><a href="#updatepersistedstate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Persisted<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>
package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskCapabilities.html ADDED
@@ -0,0 +1,9 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ServiceDeskCapabilities | 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="ServiceDeskCapabilities.html">ServiceDeskCapabilities</a></li></ul><h1>Interface ServiceDeskCapabilities</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The set of capabilities and parameters that are supported by the service desk.</p>
2
+ </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface</span> <span class="tsd-kind-interface">ServiceDeskCapabilities</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="ServiceDeskCapabilities.html#allowedfileuploadtypes">allowedFileUploadTypes</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="ServiceDeskCapabilities.html#allowfileuploads">allowFileUploads</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="ServiceDeskCapabilities.html#allowmultiplefileuploads">allowMultipleFileUploads</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 tsd-hierarchy" data-refl="1647"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">FileUploadCapabilities</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ServiceDeskCapabilities</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="ServiceDeskCapabilities.html#allowedfileuploadtypes" 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>allowed<wbr/>File<wbr/>Upload<wbr/>Types</span></a>
3
+ <a href="ServiceDeskCapabilities.html#allowfileuploads" 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>allow<wbr/>File<wbr/>Uploads</span></a>
4
+ <a href="ServiceDeskCapabilities.html#allowmultiplefileuploads" 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>allow<wbr/>Multiple<wbr/>File<wbr/>Uploads</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="allowedfileuploadtypes" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>allowed<wbr/>File<wbr/>Upload<wbr/>Types</span><a href="#allowedfileuploadtypes" 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">allowedFileUploadTypes</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>If file uploads are allowed, this is the set a file types that are allowed. This is filled into the &quot;accept&quot;
6
+ field for the file input element.</p>
7
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from FileUploadCapabilities.allowedFileUploadTypes</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="allowfileuploads" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>allow<wbr/>File<wbr/>Uploads</span><a href="#allowfileuploads" 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">allowFileUploads</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates that file uploads may be performed by the user.</p>
8
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from FileUploadCapabilities.allowFileUploads</p></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="allowmultiplefileuploads" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>allow<wbr/>Multiple<wbr/>File<wbr/>Uploads</span><a href="#allowmultiplefileuploads" 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">allowMultipleFileUploads</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>If file uploads are allowed, this indicates if more than one file may be selected at a time. The default is false.</p>
9
+ </div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from FileUploadCapabilities.allowMultipleFileUploads</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="#allowedfileuploadtypes" 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>allowed<wbr/>File<wbr/>Upload<wbr/>Types</span></a><a href="#allowfileuploads" 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>allow<wbr/>File<wbr/>Uploads</span></a><a href="#allowmultiplefileuploads" 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>allow<wbr/>Multiple<wbr/>File<wbr/>Uploads</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/ServiceDeskFactoryParameters.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>ServiceDeskFactoryParameters | 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="ServiceDeskFactoryParameters.html">ServiceDeskFactoryParameters</a></li></ul><h1>Interface ServiceDeskFactoryParameters</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The parameters that are passed to a service desk factory.</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">ServiceDeskFactoryParameters</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="ServiceDeskFactoryParameters.html#callback">callback</a><span class="tsd-signature-symbol">:</span> <a href="ServiceDeskCallback.html" class="tsd-signature-type tsd-kind-interface">ServiceDeskCallback</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ServiceDeskFactoryParameters.html#instance">instance</a><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/>    <a class="tsd-kind-property" href="ServiceDeskFactoryParameters.html#persistedstate">persistedState</a><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</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="ServiceDeskFactoryParameters.html#callback" 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>callback</span></a>
3
+ <a href="ServiceDeskFactoryParameters.html#instance" 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>instance</span></a>
4
+ <a href="ServiceDeskFactoryParameters.html#persistedstate" 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>persisted<wbr/>State</span></a>
5
+ </div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="callback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>callback</span><a href="#callback" 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">callback</span><span class="tsd-signature-symbol">:</span> <a href="ServiceDeskCallback.html" class="tsd-signature-type tsd-kind-interface">ServiceDeskCallback</a></div><div class="tsd-comment tsd-typography"><p>The callback used by the service desk to communicate with the widget.</p>
6
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="instance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>instance</span><a href="#instance" 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">instance</span><span class="tsd-signature-symbol">:</span> <a href="ChatInstance.html" class="tsd-signature-type tsd-kind-interface">ChatInstance</a></div><div class="tsd-comment tsd-typography"><p>The instance of web chat.</p>
7
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="persistedstate" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>persisted<wbr/>State</span><a href="#persistedstate" 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">persistedState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div><div class="tsd-comment tsd-typography"><p>Any state that was stored for the service desk. This value may be undefined if no state has been stored.</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="#callback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>callback</span></a><a href="#instance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>instance</span></a><a href="#persistedstate" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>persisted<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>
package/dist/docs/carbon-tsdocs/interfaces/ServiceDeskPublicConfig.html ADDED
@@ -0,0 +1,25 @@
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>ServiceDeskPublicConfig | 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="ServiceDeskPublicConfig.html">ServiceDeskPublicConfig</a></li></ul><h1>Interface ServiceDeskPublicConfig</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The section of the public config that contains configuration options for service desk integrations.</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">ServiceDeskPublicConfig</span> <span class="tsd-signature-symbol">{</span><br/>    <a class="tsd-kind-property" href="ServiceDeskPublicConfig.html#agentjointimeoutseconds">agentJoinTimeoutSeconds</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="ServiceDeskPublicConfig.html#allowreconnect">allowReconnect</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="ServiceDeskPublicConfig.html#availabilitytimeoutseconds">availabilityTimeoutSeconds</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="ServiceDeskPublicConfig.html#disableagentsessionhistory">disableAgentSessionHistory</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="ServiceDeskPublicConfig.html#genesysmessenger">genesysMessenger</a><span class="tsd-signature-symbol">?:</span> <a href="GenesysMessengerConfig.html" class="tsd-signature-type tsd-kind-interface">GenesysMessengerConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ServiceDeskPublicConfig.html#integrationtype">integrationType</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="ServiceDeskPublicConfig.html#nicedfo">niceDFO</a><span class="tsd-signature-symbol">?:</span> <a href="NiceDFOConfig.html" class="tsd-signature-type tsd-kind-interface">NiceDFOConfig</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="ServiceDeskPublicConfig.html#skipconnectagentcard">skipConnectAgentCard</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="ServiceDeskPublicConfig.html#agentjointimeoutseconds" 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/>Join<wbr/>Timeout<wbr/>Seconds?</span></a>
3
+ <a href="ServiceDeskPublicConfig.html#allowreconnect" 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>allow<wbr/>Reconnect?</span></a>
4
+ <a href="ServiceDeskPublicConfig.html#availabilitytimeoutseconds" 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>availability<wbr/>Timeout<wbr/>Seconds?</span></a>
5
+ <a href="ServiceDeskPublicConfig.html#disableagentsessionhistory" 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/>Agent<wbr/>Session<wbr/>History?</span></a>
6
+ <a href="ServiceDeskPublicConfig.html#genesysmessenger" 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>genesys<wbr/>Messenger?</span></a>
7
+ <a href="ServiceDeskPublicConfig.html#integrationtype" 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>integration<wbr/>Type?</span></a>
8
+ <a href="ServiceDeskPublicConfig.html#nicedfo" 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>niceDFO?</span></a>
9
+ <a href="ServiceDeskPublicConfig.html#skipconnectagentcard" 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/>Connect<wbr/>Agent<wbr/>Card?</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"><a id="agentjointimeoutseconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>agent<wbr/>Join<wbr/>Timeout<wbr/>Seconds</span><a href="#agentjointimeoutseconds" 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">agentJoinTimeoutSeconds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The timeout value is seconds to use when waiting for an agent to join the chat after an agent has been
11
+ requested. If no agent joins after this time, the chat will be ended and an error message will be displayed to
12
+ the user. By default, there is no timeout.</p>
13
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="allowreconnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>allow<wbr/>Reconnect</span><a href="#allowreconnect" 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">allowReconnect</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 automatically attempt to reconnect the user to a human agent when it is loaded. This
14
+ only works if the service desk integration being used supports reconnecting. This value defaults to true.</p>
15
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="availabilitytimeoutseconds" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>availability<wbr/>Timeout<wbr/>Seconds</span><a href="#availabilitytimeoutseconds" 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">availabilityTimeoutSeconds</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The timeout value in seconds to use when determining agent availability. When a connect_to_agent response is
16
+ received, the system will ask the service desk if any agents are available. If no response is received within
17
+ the timeout window, the system will return &quot;false&quot; to indicate no agents are available.</p>
18
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="disableagentsessionhistory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>disable<wbr/>Agent<wbr/>Session<wbr/>History</span><a href="#disableagentsessionhistory" 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">disableAgentSessionHistory</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Indicates whether the conversation between a user and a service desk should be stored in session history.</p>
19
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="genesysmessenger" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>genesys<wbr/>Messenger</span><a href="#genesysmessenger" 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">genesysMessenger</span><span class="tsd-signature-symbol">?:</span> <a href="GenesysMessengerConfig.html" class="tsd-signature-type tsd-kind-interface">GenesysMessengerConfig</a></div><div class="tsd-comment tsd-typography"><p>Configuration data for the Genesys Web Messenger integration</p>
20
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="integrationtype" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>integration<wbr/>Type</span><a href="#integrationtype" 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">integrationType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>This indicates which of the client-only service desk integrations to use.</p>
21
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="nicedfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>niceDFO</span><a href="#nicedfo" 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">niceDFO</span><span class="tsd-signature-symbol">?:</span> <a href="NiceDFOConfig.html" class="tsd-signature-type tsd-kind-interface">NiceDFOConfig</a></div><div class="tsd-comment tsd-typography"><p>Configuration data for the Nice DFO integration</p>
22
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="skipconnectagentcard" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>skip<wbr/>Connect<wbr/>Agent<wbr/>Card</span><a href="#skipconnectagentcard" 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">skipConnectAgentCard</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 auto-connect to an agent whenever it receives a connect_to_agent response and
23
+ agents are available. This essentially mimics the user clicking the &quot;Request agent&quot; button on the card. The
24
+ card is still displayed to the user.</p>
25
+ </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="#agentjointimeoutseconds" 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/>Join<wbr/>Timeout<wbr/>Seconds</span></a><a href="#allowreconnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Reconnect</span></a><a href="#availabilitytimeoutseconds" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>availability<wbr/>Timeout<wbr/>Seconds</span></a><a href="#disableagentsessionhistory" 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/>Agent<wbr/>Session<wbr/>History</span></a><a href="#genesysmessenger" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>genesys<wbr/>Messenger</span></a><a href="#integrationtype" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>integration<wbr/>Type</span></a><a href="#nicedfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>niceDFO</span></a><a href="#skipconnectagentcard" 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/>Connect<wbr/>Agent<wbr/>Card</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/StartChatOptions.html ADDED
@@ -0,0 +1,6 @@
1
+ <!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>StartChatOptions | 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="StartChatOptions.html">StartChatOptions</a></li></ul><h1>Interface StartChatOptions&lt;TPayloadType&gt;</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Additional options that may be passed to the service desk when a chat is started.</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">StartChatOptions</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="StartChatOptions.html#tpayloadtype">TPayloadType</a> <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">{</span><br/>    <a class="tsd-kind-property" href="StartChatOptions.html#agentappinfo">agentAppInfo</a><span class="tsd-signature-symbol">?:</span> <a href="AgentAppInfo.html" class="tsd-signature-type tsd-kind-interface">AgentAppInfo</a><span class="tsd-signature-symbol">;</span><br/>    <a class="tsd-kind-property" href="StartChatOptions.html#prestartchatpayload">preStartChatPayload</a><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="StartChatOptions.html#tpayloadtype">TPayloadType</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div> <section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="tpayloadtype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TPayloadType</span> = <span class="tsd-signature-type">unknown</span></span></li></ul></section> <section class="tsd-panel-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="StartChatOptions.html#agentappinfo" 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/>Info?</span></a>
3
+ <a href="StartChatOptions.html#prestartchatpayload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pre<wbr/>Start<wbr/>Chat<wbr/>Payload</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="agentappinfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Optional</code><span>agent<wbr/>App<wbr/>Info</span><a href="#agentappinfo" 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">agentAppInfo</span><span class="tsd-signature-symbol">?:</span> <a href="AgentAppInfo.html" class="tsd-signature-type tsd-kind-interface">AgentAppInfo</a></div><div class="tsd-comment tsd-typography"><p>Information necessary for loading an agent app version of web chat.</p>
5
+ </div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><a id="prestartchatpayload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>pre<wbr/>Start<wbr/>Chat<wbr/>Payload</span><a href="#prestartchatpayload" 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">preStartChatPayload</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="StartChatOptions.html#tpayloadtype">TPayloadType</a></div><div class="tsd-comment tsd-typography"><p>Some arbitrary payload of data that was provided as part of the &quot;agent:pre:startChat&quot; event.</p>
6
+ </div><div class="tsd-comment tsd-typography"></div></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-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="#agentappinfo" 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/>Info</span></a><a href="#prestartchatpayload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>pre<wbr/>Start<wbr/>Chat<wbr/>Payload</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>