@vonage/client-sdk 1.2.1-beta.7 → 1.2.1-snapshot.100.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -8
- package/api_docs/ts/.nojekyll +1 -0
- package/api_docs/ts/assets/highlight.css +127 -0
- package/api_docs/ts/assets/main.js +59 -0
- package/api_docs/ts/assets/navigation.js +1 -0
- package/api_docs/ts/assets/search.js +1 -0
- package/api_docs/ts/assets/style.css +1394 -0
- package/api_docs/ts/classes/ClientConfig.html +13 -0
- package/api_docs/ts/classes/ClientInitConfig.html +12 -0
- package/api_docs/ts/classes/VonageClient.html +308 -0
- package/api_docs/ts/functions/none.html +2 -0
- package/api_docs/ts/functions/setDefaultLoggingLevel.html +3 -0
- package/api_docs/ts/functions/setVonageClientLoggingLevel.html +3 -0
- package/api_docs/ts/functions/some.html +3 -0
- package/api_docs/ts/index.html +33 -0
- package/api_docs/ts/interfaces/CallSayParams.html +8 -0
- package/api_docs/ts/interfaces/Channel.html +8 -0
- package/api_docs/ts/interfaces/ClientConfigObject.html +18 -0
- package/api_docs/ts/interfaces/ClientInitConfigObject.html +24 -0
- package/api_docs/ts/interfaces/Conversation.html +20 -0
- package/api_docs/ts/interfaces/ConversationProperties.html +8 -0
- package/api_docs/ts/interfaces/ConversationTimestamp.html +5 -0
- package/api_docs/ts/interfaces/ConversationsPage.html +8 -0
- package/api_docs/ts/interfaces/CreateConversationParameters.html +15 -0
- package/api_docs/ts/interfaces/CustomConversationEvent.html +17 -0
- package/api_docs/ts/interfaces/EmbeddedInfo.html +9 -0
- package/api_docs/ts/interfaces/EphemeralConversationEvent.html +13 -0
- package/api_docs/ts/interfaces/EventDeleteConversationEvent.html +15 -0
- package/api_docs/ts/interfaces/EventsPage.html +8 -0
- package/api_docs/ts/interfaces/GetConversationEventsParameters.html +14 -0
- package/api_docs/ts/interfaces/GetConversationMembersParameters.html +8 -0
- package/api_docs/ts/interfaces/GetConversationsParameters.html +12 -0
- package/api_docs/ts/interfaces/Leg.html +20 -0
- package/api_docs/ts/interfaces/LegChannel.html +8 -0
- package/api_docs/ts/interfaces/Location.html +6 -0
- package/api_docs/ts/interfaces/Member.html +12 -0
- package/api_docs/ts/interfaces/MemberChannel.html +8 -0
- package/api_docs/ts/interfaces/MemberEventBody.html +6 -0
- package/api_docs/ts/interfaces/MemberInvitedEvent.html +15 -0
- package/api_docs/ts/interfaces/MemberJoinedEvent.html +15 -0
- package/api_docs/ts/interfaces/MemberLeftEvent.html +15 -0
- package/api_docs/ts/interfaces/MemberTimestamp.html +5 -0
- package/api_docs/ts/interfaces/MembersPage.html +8 -0
- package/api_docs/ts/interfaces/MessageAudioEvent.html +15 -0
- package/api_docs/ts/interfaces/MessageAudioEventBody.html +6 -0
- package/api_docs/ts/interfaces/MessageCustomEvent.html +15 -0
- package/api_docs/ts/interfaces/MessageCustomEventBody.html +6 -0
- package/api_docs/ts/interfaces/MessageFileEvent.html +15 -0
- package/api_docs/ts/interfaces/MessageFileEventBody.html +7 -0
- package/api_docs/ts/interfaces/MessageImageEvent.html +15 -0
- package/api_docs/ts/interfaces/MessageImageEventBody.html +7 -0
- package/api_docs/ts/interfaces/MessageLocationEvent.html +15 -0
- package/api_docs/ts/interfaces/MessageLocationEventBody.html +7 -0
- package/api_docs/ts/interfaces/MessageTemplateEvent.html +15 -0
- package/api_docs/ts/interfaces/MessageTemplateEventBody.html +10 -0
- package/api_docs/ts/interfaces/MessageTextEvent.html +15 -0
- package/api_docs/ts/interfaces/MessageTextEventBody.html +7 -0
- package/api_docs/ts/interfaces/MessageVCardEvent.html +15 -0
- package/api_docs/ts/interfaces/MessageVCardEventBody.html +7 -0
- package/api_docs/ts/interfaces/MessageVideoEvent.html +15 -0
- package/api_docs/ts/interfaces/MessageVideoEventBody.html +7 -0
- package/api_docs/ts/interfaces/RTCQuality.html +11 -0
- package/api_docs/ts/interfaces/RtcStats.html +11 -0
- package/api_docs/ts/interfaces/System.html +7 -0
- package/api_docs/ts/interfaces/Template.html +4 -0
- package/api_docs/ts/interfaces/UpdateConversationParameters.html +17 -0
- package/api_docs/ts/interfaces/User.html +16 -0
- package/api_docs/ts/interfaces/UserChannels.html +14 -0
- package/api_docs/ts/interfaces/UserTimestamp.html +5 -0
- package/api_docs/ts/interfaces/VonageEvent.html +2 -0
- package/api_docs/ts/interfaces/VonageLogger.html +10 -0
- package/api_docs/ts/interfaces/Whatsapp.html +4 -0
- package/api_docs/ts/modules.html +82 -0
- package/api_docs/ts/types/ChannelType.html +2 -0
- package/api_docs/ts/types/ConfigRegion.html +3 -0
- package/api_docs/ts/types/ConversationEvent.html +2 -0
- package/api_docs/ts/types/ConversationState.html +2 -0
- package/api_docs/ts/types/CustomData.html +3 -0
- package/api_docs/ts/types/From.html +2 -0
- package/api_docs/ts/types/Json.html +2 -0
- package/api_docs/ts/types/JsonValue.html +2 -0
- package/api_docs/ts/types/LoggingLevel.html +4 -0
- package/api_docs/ts/types/MemberState.html +2 -0
- package/api_docs/ts/types/NonPersistentConversationEvent.html +2 -0
- package/api_docs/ts/types/Option.html +3 -0
- package/api_docs/ts/types/OrderBy.html +2 -0
- package/api_docs/ts/types/PersistentConversationEvent.html +2 -0
- package/api_docs/ts/types/PresentingOrder.html +2 -0
- package/api_docs/ts/types/Topics.html +2 -0
- package/api_docs/ts/variables/Topics-1.html +2 -0
- package/dist/client/VonageClient.d.ts +250 -30
- package/dist/client/index.cjs +27917 -23291
- package/dist/client/index.mjs +27911 -23292
- package/dist/coreExtend.d.ts +9 -3
- package/dist/kotlin/JsUnions.d.ts +137 -96
- package/dist/kotlin/clientsdk-clientcore_js.d.ts +239 -138
- package/dist/lib/MediaClient.d.ts +1 -1
- package/dist/lib/SocketClient.d.ts +7 -2
- package/dist/utils/ClientConfig.d.ts +69 -23
- package/dist/utils/ConversationEventBodies.d.ts +134 -0
- package/dist/utils/ConversationModels.d.ts +137 -5
- package/dist/utils/ErrorModels.d.ts +1 -0
- package/dist/utils/JsonUtils.d.ts +15 -0
- package/dist/utils/Option.d.ts +20 -0
- package/dist/utils/RequestParameterModels.d.ts +108 -0
- package/dist/utils/index.d.ts +6 -2
- package/dist/utils/logging.d.ts +53 -1
- package/dist/vonageClientSDK.js +27431 -22683
- package/dist/vonageClientSDK.min.js +1 -1
- package/dist/vonageClientSDK.min.mjs +1 -1
- package/dist/vonageClientSDK.mjs +27425 -22684
- package/package.json +7 -3
- package/scripts/replaceAllDoNotUseOrImplement.js +25 -0
- package/typedoc.json +43 -0
- package/dist/global.d.ts +0 -7
- package/dist/lib/ConnectivityManager.d.ts +0 -11
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Topics | @vonage/client-sdk - v0.0.0</title><meta name="description" content="Documentation for @vonage/client-sdk"/><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/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><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"><use href="#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">@vonage/client-sdk - v0.0.0</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"><use href="#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="../modules.html">@vonage/client-sdk</a></li><li><a href="Topics.html">Topics</a></li></ul><h1>Type alias Topics</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Topics</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">vonage.Topics</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-keyword">typeof </span><span class="tsd-signature-type ">Topics.prototype.name</span></div><div class="tsd-comment tsd-typography"><p>A group of Topics that a <a href="../interfaces/VonageLogger.html" class="tsd-kind-interface">VonageLogger</a> can subscribe to</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><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-private" name="private"/><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>Private</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" 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>External</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-alpha" name="alpha" 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>Alpha</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-beta" name="beta" 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>Beta</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>@vonage/client-sdk - v0.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><details class="tsd-index-accordion" data-key="Classes"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Classes</span></summary><div class="tsd-accordion-details"><ul class="tsd-nested-navigation"><li><a href="../classes/ClientConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClientConfig</a></li><li><a href="../classes/ClientInitConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClientInitConfig</a></li><li><a href="../classes/VonageClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>VonageClient</a></li></ul></div></details><details class="tsd-index-accordion" data-key="Interfaces"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Interfaces</span></summary><div class="tsd-accordion-details"><ul class="tsd-nested-navigation"><li><a href="../interfaces/Channel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Channel</a></li><li><a href="../interfaces/ClientConfigObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ClientConfigObject</a></li><li><a href="../interfaces/ClientInitConfigObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ClientInitConfigObject</a></li><li><a href="../interfaces/Conversation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Conversation</a></li><li><a href="../interfaces/ConversationProperties.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversationProperties</a></li><li><a href="../interfaces/ConversationTimestamp.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversationTimestamp</a></li><li><a href="../interfaces/EmbeddedInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EmbeddedInfo</a></li><li><a href="../interfaces/Member.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Member</a></li><li><a href="../interfaces/MemberChannel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberChannel</a></li><li><a href="../interfaces/MemberTimestamp.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberTimestamp</a></li><li><a href="../interfaces/System.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>System</a></li><li><a href="../interfaces/User.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>User</a></li><li><a href="../interfaces/UserChannels.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>UserChannels</a></li><li><a href="../interfaces/UserTimestamp.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>UserTimestamp</a></li><li><a href="../interfaces/VonageEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>VonageEvent</a></li><li><a href="../interfaces/VonageLogger.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>VonageLogger</a></li></ul></div></details><li>Loading...</li></ul></nav></div></div></div><div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4096"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-8192"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-16384"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-32768"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-65536"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-131072"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-524288"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-1048576"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)"></path></g><g id="icon-chevronDown"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></g><g id="icon-chevronSmall"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></g><g id="icon-menu"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></g><g id="icon-search"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></g><g id="icon-anchor"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g></svg></body></html>
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Topics | @vonage/client-sdk - v0.0.0</title><meta name="description" content="Documentation for @vonage/client-sdk"/><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/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><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"><use href="#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">@vonage/client-sdk - v0.0.0</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"><use href="#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="../modules.html">@vonage/client-sdk</a></li><li><a href="Topics-1.html">Topics</a></li></ul><h1>Variable Topics</h1></div><div class="tsd-signature"><span class="tsd-kind-variable">Topics</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-keyword">typeof </span><span class="tsd-signature-type ">Topics</span></div><div class="tsd-comment tsd-typography"><p>A group of Topics that a <a href="../interfaces/VonageLogger.html" class="tsd-kind-interface">VonageLogger</a> can subscribe to</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><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-private" name="private"/><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>Private</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" 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>External</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-alpha" name="alpha" 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>Alpha</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-beta" name="beta" 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>Beta</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>@vonage/client-sdk - v0.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><details class="tsd-index-accordion" data-key="Classes"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Classes</span></summary><div class="tsd-accordion-details"><ul class="tsd-nested-navigation"><li><a href="../classes/ClientConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClientConfig</a></li><li><a href="../classes/ClientInitConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClientInitConfig</a></li><li><a href="../classes/VonageClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>VonageClient</a></li></ul></div></details><details class="tsd-index-accordion" data-key="Interfaces"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg><span>Interfaces</span></summary><div class="tsd-accordion-details"><ul class="tsd-nested-navigation"><li><a href="../interfaces/Channel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Channel</a></li><li><a href="../interfaces/ClientConfigObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ClientConfigObject</a></li><li><a href="../interfaces/ClientInitConfigObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ClientInitConfigObject</a></li><li><a href="../interfaces/Conversation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Conversation</a></li><li><a href="../interfaces/ConversationProperties.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversationProperties</a></li><li><a href="../interfaces/ConversationTimestamp.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversationTimestamp</a></li><li><a href="../interfaces/EmbeddedInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EmbeddedInfo</a></li><li><a href="../interfaces/Member.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Member</a></li><li><a href="../interfaces/MemberChannel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberChannel</a></li><li><a href="../interfaces/MemberTimestamp.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberTimestamp</a></li><li><a href="../interfaces/System.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>System</a></li><li><a href="../interfaces/User.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>User</a></li><li><a href="../interfaces/UserChannels.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>UserChannels</a></li><li><a href="../interfaces/UserTimestamp.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>UserTimestamp</a></li><li><a href="../interfaces/VonageEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>VonageEvent</a></li><li><a href="../interfaces/VonageLogger.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>VonageLogger</a></li></ul></div></details><li>Loading...</li></ul></nav></div></div></div><div class="overlay"></div><svg style="display: none"><g id="icon-1"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-2"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g><g id="icon-8"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-enum)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.45 16V7.24H14.49V8.224H10.518V10.936H14.07V11.908H10.518V15.016H14.49V16H9.45Z" fill="var(--color-text)"></path></g><g id="icon-16"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-32"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-variable)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.106 16L8.85 7.24H9.966L11.454 13.192C11.558 13.608 11.646 13.996 11.718 14.356C11.79 14.708 11.842 14.976 11.874 15.16C11.906 14.976 11.954 14.708 12.018 14.356C12.09 13.996 12.178 13.608 12.282 13.192L13.758 7.24H14.85L12.582 16H11.106Z" fill="var(--color-text)"></path></g><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g><g id="icon-512"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-1024"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g><g id="icon-4096"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g><g id="icon-8192"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-16384"><rect fill="var(--color-icon-background)" stroke="#4D7FFF" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g><g id="icon-32768"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)"></path></g><g id="icon-65536"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-131072"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-262144"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-524288"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-1048576"><rect fill="var(--color-icon-background)" stroke="#FF4D4D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M8.85 16L11.13 7.24H12.582L14.85 16H13.758L13.182 13.672H10.53L9.954 16H8.85ZM10.746 12.76H12.954L12.282 10.06C12.154 9.548 12.054 9.12 11.982 8.776C11.91 8.432 11.866 8.208 11.85 8.104C11.834 8.208 11.79 8.432 11.718 8.776C11.646 9.12 11.546 9.544 11.418 10.048L10.746 12.76Z" fill="var(--color-text)"></path></g><g id="icon-2097152"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)"></path></g><g id="icon-chevronDown"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></g><g id="icon-chevronSmall"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></g><g id="icon-menu"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></g><g id="icon-search"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></g><g id="icon-anchor"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></g></svg></body></html>
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import vonage from '../utils/vonage';
|
|
2
|
-
import { Conversation, ConversationsPage, Member, MembersPage, PresentingOrder, OrderBy,
|
|
3
|
-
import {
|
|
2
|
+
import { Conversation, ConversationsPage, EventsPage, Member, MembersPage, PresentingOrder, ClientInitConfigObject, ClientConfigObject, Json, CustomData, Location, Template, Whatsapp, CreateConversationParameters, GetConversationsParameters, OrderBy, GetConversationEventsParameters, GetConversationMembersParameters, UpdateConversationParameters } from '../utils';
|
|
3
|
+
import { Nullable } from '../kotlin/clientsdk-clientcore_js';
|
|
4
|
+
import { ConversationEvent } from '../kotlin/JsUnions';
|
|
4
5
|
/**
|
|
5
6
|
* The Vonage Client SDK for JS/TS provides a simple interface
|
|
6
7
|
* For the Vonage Voice and Messaging APIs.
|
|
@@ -13,15 +14,24 @@ import { ConversationEvent, PersistentConversationEvent } from '../kotlin/JsUnio
|
|
|
13
14
|
* @packageDocumentation
|
|
14
15
|
*/
|
|
15
16
|
export * from '../utils';
|
|
16
|
-
export interface
|
|
17
|
-
events: PersistentConversationEvent[];
|
|
18
|
-
}
|
|
19
|
-
interface VonageEvent extends vonage.CombinedEvents {
|
|
17
|
+
export interface VonageEvent extends vonage.CombinedEvents {
|
|
20
18
|
conversationEvent: (event: ConversationEvent) => void;
|
|
21
19
|
}
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
20
|
+
/**
|
|
21
|
+
* Information about the quality of a Voice Call
|
|
22
|
+
*
|
|
23
|
+
* @property mos_score
|
|
24
|
+
* @property quality_percentage
|
|
25
|
+
* @property jitter_min_var
|
|
26
|
+
* @property jitter_max_var
|
|
27
|
+
* @property jitter_loss_rate
|
|
28
|
+
* @property jitter_burst_rate
|
|
29
|
+
* @property flaw_total
|
|
30
|
+
* @property packet_cnt
|
|
31
|
+
* @property packet_loss_perc
|
|
32
|
+
* @interface
|
|
33
|
+
* @group Voice
|
|
34
|
+
*/
|
|
25
35
|
export type RTCQuality = vonage.RTCQualityJS;
|
|
26
36
|
export type CancelReason = vonage.CancelReasonJS;
|
|
27
37
|
export declare const CancelReason: typeof vonage.CancelReasonJS;
|
|
@@ -29,22 +39,67 @@ export type HangupReason = vonage.HangupReasonJS;
|
|
|
29
39
|
export declare const HangupReason: typeof vonage.HangupReasonJS;
|
|
30
40
|
export type SessionErrorReason = vonage.SessionErrorReasonJS;
|
|
31
41
|
export declare const SessionErrorReason: typeof vonage.SessionErrorReasonJS;
|
|
42
|
+
/**
|
|
43
|
+
* Represents the Leg of a Voice Call
|
|
44
|
+
*
|
|
45
|
+
* @property id The Leg id
|
|
46
|
+
* @property type The type of Leg
|
|
47
|
+
* @property direction The direction of the Leg (inbound or outbound)
|
|
48
|
+
* @property conversationId The id of the Conversation the Leg belongs to
|
|
49
|
+
* @property status The status of the Leg
|
|
50
|
+
* @property startTime The timestamp when the Leg started
|
|
51
|
+
* @property endTime The timestamp when the Leg ended
|
|
52
|
+
* @property from The from {@link LegChannel}
|
|
53
|
+
* @property to The to {@link LegChannel}
|
|
54
|
+
* @interface
|
|
55
|
+
* @group Voice
|
|
56
|
+
*/
|
|
32
57
|
export type Leg = vonage.LegJS;
|
|
33
58
|
export type LegStatus = vonage.LegStatusJS;
|
|
34
59
|
export declare const LegStatus: typeof vonage.LegStatusJS;
|
|
60
|
+
/**
|
|
61
|
+
* Represents a Leg Channel
|
|
62
|
+
*
|
|
63
|
+
* @property type The type of Channel
|
|
64
|
+
* @property user The user id of the Channel
|
|
65
|
+
* @property number The number id of the Channel
|
|
66
|
+
* @interface
|
|
67
|
+
* @group Voice
|
|
68
|
+
*/
|
|
69
|
+
export type LegChannel = vonage.LegChannelJS;
|
|
70
|
+
/**
|
|
71
|
+
* Parameters for {@link VonageClient.say}
|
|
72
|
+
*
|
|
73
|
+
* @property text
|
|
74
|
+
* @property level
|
|
75
|
+
* @property loop
|
|
76
|
+
* @property queue
|
|
77
|
+
* @property voiceName
|
|
78
|
+
* @property ssml
|
|
79
|
+
* @interface
|
|
80
|
+
* @group Voice
|
|
81
|
+
*/
|
|
35
82
|
export type CallSayParams = Partial<vonage.CallSayParams> & {
|
|
36
83
|
text: string;
|
|
37
84
|
};
|
|
38
85
|
export type CallDisconnectReason = vonage.CallDisconnectReasonJS;
|
|
39
86
|
export declare const CallDisconnectReason: typeof vonage.CallDisconnectReasonJS;
|
|
40
|
-
type JSONValue = string | number | boolean | {
|
|
41
|
-
[x: string]: JSONValue;
|
|
42
|
-
} | JSONValue[];
|
|
43
87
|
/**
|
|
44
|
-
*
|
|
45
|
-
*
|
|
88
|
+
* WebRTC Stats of a Voice Call
|
|
89
|
+
*
|
|
90
|
+
* @property audioRecvPackets
|
|
91
|
+
* @property audioRecvPacketsLost
|
|
92
|
+
* @property audioRecvBytes
|
|
93
|
+
* @property audioRecvJitter
|
|
94
|
+
* @property audioSentPackets
|
|
95
|
+
* @property audioSentPacketsLost
|
|
96
|
+
* @property audioSentBytes
|
|
97
|
+
* @property audioSentJitter
|
|
98
|
+
* @property audioRtt
|
|
99
|
+
* @interface
|
|
100
|
+
* @group Voice
|
|
46
101
|
*/
|
|
47
|
-
export
|
|
102
|
+
export type RtcStats = vonage.RTCStatsJS;
|
|
48
103
|
/**
|
|
49
104
|
* VonageClient is the main entry point for the Vonage Client SDK.
|
|
50
105
|
*
|
|
@@ -72,16 +127,16 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
72
127
|
* Register a callback for an event.
|
|
73
128
|
*
|
|
74
129
|
* @example
|
|
75
|
-
* [[include:
|
|
130
|
+
* [[include: snippet_OnConversationEventListener.txt]]
|
|
76
131
|
*
|
|
77
132
|
* @param event - the event to register for (e.g. 'legStatusUpdate')
|
|
78
133
|
* @param callback - the callback to register for the event
|
|
79
134
|
* @returns a symbol that can be used to unregister the callback
|
|
80
135
|
* @remarks
|
|
81
|
-
*
|
|
82
|
-
* We recommend
|
|
136
|
+
* Be sure to store the symbol returned by this method so you can unregister the callback later.
|
|
137
|
+
* We recommend unregistering callbacks when you no longer need them. See {@link off}.
|
|
83
138
|
*/
|
|
84
|
-
on<T extends keyof VonageEvent
|
|
139
|
+
on<T extends keyof VonageEvent>(event: T, callback: VonageEvent[T]): symbol;
|
|
85
140
|
/**
|
|
86
141
|
* Unregister a callback for an event.
|
|
87
142
|
*
|
|
@@ -99,7 +154,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
99
154
|
* Clear all callbacks for an event.
|
|
100
155
|
*
|
|
101
156
|
* @example
|
|
102
|
-
* [[include:
|
|
157
|
+
* [[include: snippet_ClearCallbacks.txt]]
|
|
103
158
|
*
|
|
104
159
|
* @param event - the event to unregister from (e.g. 'legStatusUpdate')
|
|
105
160
|
* @returns void
|
|
@@ -176,7 +231,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
176
231
|
* Sends a TTS message to the Call
|
|
177
232
|
*
|
|
178
233
|
* @example
|
|
179
|
-
* [[include:
|
|
234
|
+
* [[include: snippet_Say.txt]]
|
|
180
235
|
*
|
|
181
236
|
* @group Voice
|
|
182
237
|
* @param callId - the `callId` of the call to send the message to
|
|
@@ -192,9 +247,21 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
192
247
|
*
|
|
193
248
|
* @group Chat
|
|
194
249
|
* @beta
|
|
250
|
+
* @param parameters - A {@link GetConversationsParameters} object containing the parameters for the request.
|
|
251
|
+
* @returns a `ConversationsPage` containing the conversations
|
|
252
|
+
*/
|
|
253
|
+
getConversations(parameters?: Nullable<GetConversationsParameters>): Promise<ConversationsPage>;
|
|
254
|
+
/**
|
|
255
|
+
* Get a list of Conversations for the user.
|
|
256
|
+
*
|
|
257
|
+
* @deprecated Use {@link getConversations(parameters)} instead.
|
|
258
|
+
* @group Chat
|
|
259
|
+
* @beta
|
|
195
260
|
* @param order - the order to return the conversations in (default: 'asc')
|
|
196
261
|
* @param pageSize - the number of conversations to return per page (default: 100)
|
|
197
262
|
* @param cursor - the cursor to use for pagination (default: null)
|
|
263
|
+
* @param includeCustomData - include custom data (default: false)
|
|
264
|
+
* @param orderBy - order by strategy (default: null)
|
|
198
265
|
* @returns a `ConversationsPage` containing the conversations
|
|
199
266
|
*/
|
|
200
267
|
getConversations(order?: PresentingOrder, pageSize?: number, cursor?: string | null, includeCustomData?: boolean, orderBy?: OrderBy | null): Promise<ConversationsPage>;
|
|
@@ -207,18 +274,30 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
207
274
|
* @group Chat
|
|
208
275
|
* @beta
|
|
209
276
|
* @param id - the Conversation's id
|
|
277
|
+
* @param parameters - A {@link GetConversationEventsParameters} object containing the parameters for the request.
|
|
278
|
+
* @returns a {@link EventsPage} containing the events
|
|
279
|
+
*/
|
|
280
|
+
getConversationEvents(id: string, parameters?: Nullable<GetConversationEventsParameters>): Promise<EventsPage>;
|
|
281
|
+
/**
|
|
282
|
+
* Get a Conversation's Events
|
|
283
|
+
*
|
|
284
|
+
* @deprecated Use {@link getConversationEvents(id, parameters)} instead.
|
|
285
|
+
* @group Chat
|
|
286
|
+
* @beta
|
|
287
|
+
* @param id - the Conversation's id
|
|
210
288
|
* @param order - the order to return the events in (default: 'asc')
|
|
211
289
|
* @param pageSize - the number of events to return per page (default: 100)
|
|
212
290
|
* @param cursor - the cursor to use for pagination (default: null)
|
|
213
291
|
* @param eventFilter - the event types to filter by (default: null)
|
|
214
292
|
* @param includeDeletedEvents - A boolean, which when sent as true, will include `deletedEvents` in the list, default is false
|
|
215
|
-
* @
|
|
293
|
+
* @param startId - A number, the starting id of the events to be returned (default: null)
|
|
294
|
+
* @returns a {@link EventsPage} containing the events
|
|
216
295
|
*
|
|
217
296
|
* @privateRemarks
|
|
218
297
|
* * This is a workaround for the to ensure exhaustiveness of the `ConversationEvent` type
|
|
219
298
|
* * the kotlin core does not support union types
|
|
220
299
|
*/
|
|
221
|
-
getConversationEvents(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null, eventFilter?: string[] | null, includeDeletedEvents?: boolean): Promise<
|
|
300
|
+
getConversationEvents(id: string, order?: PresentingOrder, pageSize?: number, cursor?: string | null, eventFilter?: string[] | null, includeDeletedEvents?: boolean, startId?: number): Promise<EventsPage>;
|
|
222
301
|
/**
|
|
223
302
|
* Get a Conversation's Members
|
|
224
303
|
*
|
|
@@ -228,6 +307,17 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
228
307
|
* @group Chat
|
|
229
308
|
* @beta
|
|
230
309
|
* @param id - the Conversation's id
|
|
310
|
+
* @param parameters - A {@link GetConversationMembersParameters} object containing the parameters for the request.
|
|
311
|
+
* @returns a `MembersPage` containing the members
|
|
312
|
+
*/
|
|
313
|
+
getConversationMembers(id: string, parameters?: Nullable<GetConversationMembersParameters>): Promise<MembersPage>;
|
|
314
|
+
/**
|
|
315
|
+
* Get a Conversation's Members
|
|
316
|
+
*
|
|
317
|
+
* @deprecated Use {@link getConversationMembers(id, parameters)} instead.
|
|
318
|
+
* @group Chat
|
|
319
|
+
* @beta
|
|
320
|
+
* @param id - the Conversation's id
|
|
231
321
|
* @param order - the order to return the members in (default: 'asc')
|
|
232
322
|
* @param pageSize - the number of members to return per page (default: 100)
|
|
233
323
|
* @param cursor - the cursor to use for pagination (default: null)
|
|
@@ -242,6 +332,17 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
242
332
|
*
|
|
243
333
|
* @group Chat
|
|
244
334
|
* @beta
|
|
335
|
+
* @param parameters - A {@link CreateConversationParameters} object containing the parameters for the creation request.
|
|
336
|
+
*
|
|
337
|
+
* @returns the `cid` of the conversation
|
|
338
|
+
*/
|
|
339
|
+
createConversation(parameters?: Nullable<CreateConversationParameters>): Promise<string>;
|
|
340
|
+
/**
|
|
341
|
+
* Create a conversation
|
|
342
|
+
*
|
|
343
|
+
* @deprecated Use {@link createConversation(parameters)} instead.
|
|
344
|
+
* @group Chat
|
|
345
|
+
* @beta
|
|
245
346
|
* @param name - the name of the conversation
|
|
246
347
|
* @param displayName - the display name of the conversation
|
|
247
348
|
* @returns the `cid` of the conversation
|
|
@@ -253,10 +354,23 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
253
354
|
* @example
|
|
254
355
|
* [[include: snippet_GetConversation.txt]]
|
|
255
356
|
*
|
|
256
|
-
* @param
|
|
357
|
+
* @param conversationIdOrName - the Conversation's id or conversation name
|
|
257
358
|
* @returns the `Conversation`
|
|
258
359
|
*/
|
|
259
|
-
getConversation(
|
|
360
|
+
getConversation(conversationIdOrName: string): Promise<Conversation>;
|
|
361
|
+
/**
|
|
362
|
+
* Updates a conversation object identified by its unique conversation ID.
|
|
363
|
+
*
|
|
364
|
+
* This method overrides the conversation properties to the provided parameters and rest remains as it is.
|
|
365
|
+
*
|
|
366
|
+
* @example
|
|
367
|
+
* [[include: snippet_UpdateConversation.txt]]
|
|
368
|
+
*
|
|
369
|
+
* @param conversationId - the Conversation's id.
|
|
370
|
+
* @param parameters - The properties of the conversation. These will replace existing values to the provided ones, rest will remain as they are.
|
|
371
|
+
* @returns `conversation`, this object will contain the updated conversation properties if the update is successful.
|
|
372
|
+
*/
|
|
373
|
+
updateConversation(conversationId: string, parameters: UpdateConversationParameters): Promise<Conversation>;
|
|
260
374
|
/**
|
|
261
375
|
* Leave a Conversation
|
|
262
376
|
*
|
|
@@ -302,7 +416,7 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
302
416
|
* @group Chat
|
|
303
417
|
* @beta
|
|
304
418
|
* @param id - the Conversation's id
|
|
305
|
-
* @param name - the
|
|
419
|
+
* @param name - the name of the user to invite
|
|
306
420
|
* @returns the `memberId` of the member
|
|
307
421
|
*/
|
|
308
422
|
inviteToConversation(id: string, name: string): Promise<string>;
|
|
@@ -331,7 +445,99 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
331
445
|
* @param customData - the body of the message
|
|
332
446
|
* @returns the `timestamp` of the message
|
|
333
447
|
*/
|
|
334
|
-
sendMessageCustomEvent(id: string, customData:
|
|
448
|
+
sendMessageCustomEvent(id: string, customData: CustomData): Promise<string>;
|
|
449
|
+
/**
|
|
450
|
+
* Send a Image message to a Conversation.
|
|
451
|
+
*
|
|
452
|
+
* @example
|
|
453
|
+
* [[include: snippet_SendImageMessage.txt]]
|
|
454
|
+
*
|
|
455
|
+
* @group Chat
|
|
456
|
+
* @beta
|
|
457
|
+
* @param id - the Conversation's id
|
|
458
|
+
* @param imageUrl - the url of the image resource.
|
|
459
|
+
* @returns the `timestamp` of the message
|
|
460
|
+
*/
|
|
461
|
+
sendMessageImageEvent(id: string, imageUrl: URL): Promise<string>;
|
|
462
|
+
/**
|
|
463
|
+
* Send a Vidoe message to a Conversation.
|
|
464
|
+
*
|
|
465
|
+
* @example
|
|
466
|
+
* [[include: snippet_SendVideoMessage.txt]]
|
|
467
|
+
*
|
|
468
|
+
* @group Chat
|
|
469
|
+
* @beta
|
|
470
|
+
* @param id - the Conversation's id
|
|
471
|
+
* @param videoUrl - the url of the video resource.
|
|
472
|
+
* @returns the `timestamp` of the message
|
|
473
|
+
*/
|
|
474
|
+
sendMessageVideoEvent(id: string, videoUrl: URL): Promise<string>;
|
|
475
|
+
/**
|
|
476
|
+
* Send a file message to a Conversation.
|
|
477
|
+
*
|
|
478
|
+
* @example
|
|
479
|
+
* [[include: snippet_SendFileMessage.txt]]
|
|
480
|
+
*
|
|
481
|
+
* @group Chat
|
|
482
|
+
* @beta
|
|
483
|
+
* @param id - the Conversation's id
|
|
484
|
+
* @param fileUrl - the url of the file resource.
|
|
485
|
+
* @returns the `timestamp` of the message
|
|
486
|
+
*/
|
|
487
|
+
sendMessageFileEvent(id: string, fileUrl: URL): Promise<string>;
|
|
488
|
+
/**
|
|
489
|
+
* Send a audio message to a Conversation.
|
|
490
|
+
*
|
|
491
|
+
* @example
|
|
492
|
+
* [[include: snippet_SendAudioMessage.txt]]
|
|
493
|
+
*
|
|
494
|
+
* @group Chat
|
|
495
|
+
* @beta
|
|
496
|
+
* @param id - the Conversation's id
|
|
497
|
+
* @param audioUrl - the url of the audio resource.
|
|
498
|
+
* @returns the `timestamp` of the message
|
|
499
|
+
*/
|
|
500
|
+
sendMessageAudioEvent(id: string, audioUrl: URL): Promise<string>;
|
|
501
|
+
/**
|
|
502
|
+
* Send a vcard message to a Conversation.
|
|
503
|
+
*
|
|
504
|
+
* @example
|
|
505
|
+
* [[include: snippet_SendVcardMessage.txt]]
|
|
506
|
+
*
|
|
507
|
+
* @group Chat
|
|
508
|
+
* @beta
|
|
509
|
+
* @param id - the Conversation's id
|
|
510
|
+
* @param vCardUrl - the url of the vCardUrl resource.
|
|
511
|
+
* @returns the `timestamp` of the message
|
|
512
|
+
*/
|
|
513
|
+
sendMessageVCardEvent(id: string, vCardUrl: URL): Promise<string>;
|
|
514
|
+
/**
|
|
515
|
+
* Send a Location message to a Conversation.
|
|
516
|
+
*
|
|
517
|
+
* @example
|
|
518
|
+
* [[include: snippet_SendLocationMessage.txt]]
|
|
519
|
+
*
|
|
520
|
+
* @group Chat
|
|
521
|
+
* @beta
|
|
522
|
+
* @param id - the Conversation's id
|
|
523
|
+
* @param location - the description of the location.
|
|
524
|
+
* @returns the `timestamp` of the message
|
|
525
|
+
*/
|
|
526
|
+
sendMessageLocationEvent(id: string, location: Location): Promise<string>;
|
|
527
|
+
/**
|
|
528
|
+
* Send a template message to a Conversation.
|
|
529
|
+
*
|
|
530
|
+
* @example
|
|
531
|
+
* [[include: snippet_SendTemplateMessage.txt]]
|
|
532
|
+
*
|
|
533
|
+
* @group Chat
|
|
534
|
+
* @beta
|
|
535
|
+
* @param id - the Conversation's id
|
|
536
|
+
* @param whatsappObject - the description(locale and policies of business account) of the location.
|
|
537
|
+
* @param templateObject - the description(name and paramters) of the template.
|
|
538
|
+
* @returns the `timestamp` of the message
|
|
539
|
+
*/
|
|
540
|
+
sendMessageTemplateEvent(id: string, templateObject: Template, whatsappObject: Whatsapp): Promise<string>;
|
|
335
541
|
/**
|
|
336
542
|
* Send an ephemeral event to a Conversation
|
|
337
543
|
*
|
|
@@ -341,15 +547,29 @@ export declare class VonageClient extends vonage.CombinedClientJS {
|
|
|
341
547
|
* @group Chat
|
|
342
548
|
* @beta
|
|
343
549
|
* @param id - the Conversation's id
|
|
344
|
-
* @param
|
|
550
|
+
* @param customData - the body of the event
|
|
551
|
+
* @returns the `timestamp` of the message
|
|
552
|
+
*/
|
|
553
|
+
sendEphemeralEvent(id: string, customData: CustomData): Promise<string>;
|
|
554
|
+
/**
|
|
555
|
+
* Send a Custom event to a Conversation
|
|
556
|
+
*
|
|
557
|
+
* @example
|
|
558
|
+
* [[include: snippet_SendCustomEvent.txt]]
|
|
559
|
+
*
|
|
560
|
+
* @group Chat
|
|
561
|
+
* @beta
|
|
562
|
+
* @param id - the Conversation's id
|
|
563
|
+
* @param evenType - the type of the custom event. Type must start with `custom:<...>`
|
|
564
|
+
* @param customData - the body of the event
|
|
345
565
|
* @returns the `timestamp` of the message
|
|
346
566
|
*/
|
|
347
|
-
|
|
567
|
+
sendCustomEvent(id: string, eventType: string, customData: CustomData): Promise<string>;
|
|
348
568
|
/**
|
|
349
569
|
* Delete an Event in a Conversation
|
|
350
570
|
*
|
|
351
571
|
* @example
|
|
352
|
-
* [[include:
|
|
572
|
+
* [[include:snippet_DeleteEvent.txt]]
|
|
353
573
|
*
|
|
354
574
|
* @group Chat
|
|
355
575
|
* @beta
|