@vonage/client-sdk 1.4.0-rc.0 → 1.4.0-rc.1
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/api_docs/ts/assets/navigation.js +1 -1
- package/api_docs/ts/assets/search.js +1 -1
- package/api_docs/ts/classes/VonageClient.html +4 -4
- package/api_docs/ts/enums/OrderBy.html +2 -0
- package/api_docs/ts/enums/PresentingOrder.html +8 -0
- package/api_docs/ts/interfaces/ConversationProperties.html +3 -3
- package/api_docs/ts/interfaces/CustomConversationEvent.html +3 -3
- package/api_docs/ts/interfaces/GetCallLegsParameters.html +2 -2
- package/api_docs/ts/interfaces/GetConversationEventsParameters.html +2 -2
- package/api_docs/ts/interfaces/GetConversationMembersParameters.html +2 -2
- package/api_docs/ts/interfaces/GetConversationsParameters.html +3 -3
- package/api_docs/ts/interfaces/MessageCustomEventBody.html +2 -2
- package/api_docs/ts/interfaces/User.html +3 -3
- package/api_docs/ts/modules.html +3 -3
- package/dist/client/index.cjs +97 -21
- package/dist/client/index.mjs +97 -21
- package/dist/kotlin/clientsdk-clientcore_js.d.ts +4 -4
- package/dist/utils/RequestParameterModels.d.ts +31 -8
- package/dist/utils/jsEnumToVonageObject.d.ts +10 -0
- package/dist/vonageClientSDK.js +97 -21
- package/dist/vonageClientSDK.min.js +1 -1
- package/dist/vonageClientSDK.min.mjs +1 -1
- package/dist/vonageClientSDK.mjs +97 -21
- package/package.json +1 -1
- package/api_docs/ts/types/OrderBy.html +0 -2
- package/api_docs/ts/types/PresentingOrder.html +0 -2
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>MessageCustomEventBody | @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="MessageCustomEventBody.html">MessageCustomEventBody</a></li></ul><h1>Interface MessageCustomEventBody<code class="tsd-tag ts-flagBeta">Beta</code> </h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>The <a href="MessageCustomEvent.html" class="tsd-kind-interface">MessageCustomEvent</a> Body type</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">MessageCustomEventBody </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="MessageCustomEventBody.html#customData.customData-1">customData</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type">
|
|
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">MessageCustomEventBody </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="MessageCustomEventBody.html#customData.customData-1">customData</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="MessageCustomEventBody.html#deleted.deleted-1">deleted</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-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"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="MessageCustomEventBody.html#customData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>custom<wbr/>Data</span></a>
|
|
3
3
|
<a href="MessageCustomEventBody.html#deleted" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>deleted</span></a>
|
|
4
|
-
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="customData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>custom<wbr/>Data</span><a href="#customData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="customData.customData-1"><span class="tsd-signature-symbol">get</span> customData<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">
|
|
4
|
+
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="customData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>custom<wbr/>Data</span><a href="#customData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="customData.customData-1"><span class="tsd-signature-symbol">get</span> customData<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="deleted" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>deleted</span><a href="#deleted" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="deleted.deleted-1"><span class="tsd-signature-symbol">get</span> deleted<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The message deletion timestamp</p>
|
|
5
5
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section></section></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><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><ul><li><a href="#customData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>custom<wbr/>Data</span></a></li><li><a href="#deleted" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>deleted</span></a></li></ul></div></details></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="Channel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Channel</a></li><li><a href="ClientConfigObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ClientConfigObject</a></li><li><a href="ClientInitConfigObject.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ClientInitConfigObject</a></li><li><a href="Conversation.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Conversation</a></li><li><a href="ConversationProperties.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversationProperties</a></li><li><a href="ConversationTimestamp.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversationTimestamp</a></li><li><a href="EmbeddedInfo.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EmbeddedInfo</a></li><li><a href="Member.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Member</a></li><li><a href="MemberChannel.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberChannel</a></li><li><a href="MemberTimestamp.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberTimestamp</a></li><li><a href="System.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>System</a></li><li><a href="User.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>User</a></li><li><a href="UserChannels.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>UserChannels</a></li><li><a href="UserTimestamp.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>UserTimestamp</a></li><li><a href="VonageEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>VonageEvent</a></li><li><a href="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,5 +1,5 @@
|
|
|
1
1
|
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>User | @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="User.html">User</a></li></ul><h1>Interface User</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Represents an SDK user</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">User </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="User.html#channels.channels-1">channels</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">UserChannelsJS</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="User.html#customData.customData-1">customData</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type
|
|
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">User </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="User.html#channels.channels-1">channels</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">UserChannelsJS</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="User.html#customData.customData-1">customData</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="User.html#displayName.displayName-1">displayName</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="User.html#id.id-1">id</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="User.html#imageUrl.imageUrl-1">imageUrl</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="User.html#name.name-1">name</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-signature-keyword">get </span><a class="tsd-kind-get-signature" href="User.html#timestamp.timestamp-1">timestamp</a><span class="tsd-signature-symbol">(): </span><span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">UserTimestampJS</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-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"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="User.html#channels" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>channels</span></a>
|
|
3
3
|
<a href="User.html#customData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>custom<wbr/>Data</span></a>
|
|
4
4
|
<a href="User.html#displayName" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>display<wbr/>Name</span></a>
|
|
5
5
|
<a href="User.html#id" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>id</span></a>
|
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
<a href="User.html#name" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>name</span></a>
|
|
8
8
|
<a href="User.html#timestamp" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>timestamp</span></a>
|
|
9
9
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member"><a id="channels" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>channels</span><a href="#channels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="channels.channels-1"><span class="tsd-signature-symbol">get</span> channels<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">UserChannelsJS</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The user channels</p>
|
|
10
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">UserChannelsJS</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="customData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>custom<wbr/>Data</span><a href="#customData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="customData.customData-1"><span class="tsd-signature-symbol">get</span> customData<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type
|
|
11
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type
|
|
10
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">UserChannelsJS</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="customData" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>custom<wbr/>Data</span><a href="#customData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="customData.customData-1"><span class="tsd-signature-symbol">get</span> customData<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The user custom data</p>
|
|
11
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="displayName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>display<wbr/>Name</span><a href="#displayName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="displayName.displayName-1"><span class="tsd-signature-symbol">get</span> displayName<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The user display name</p>
|
|
12
12
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="id.id-1"><span class="tsd-signature-symbol">get</span> id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The user id</p>
|
|
13
13
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="imageUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>image<wbr/>Url</span><a href="#imageUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="imageUrl.imageUrl-1"><span class="tsd-signature-symbol">get</span> imageUrl<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The user image url</p>
|
|
14
14
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="name" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>name</span><a href="#name" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature" id="name.name-1"><span class="tsd-signature-symbol">get</span> name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>The user name</p>
|
package/api_docs/ts/modules.html
CHANGED
|
@@ -33,7 +33,9 @@
|
|
|
33
33
|
<a href="functions/setDefaultLoggingLevel.html" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>set<wbr/>Default<wbr/>Logging<wbr/>Level</span></a>
|
|
34
34
|
<a href="functions/setVonageClientLoggingLevel.html" class="tsd-index-link deprecated"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>set<wbr/>Vonage<wbr/>Client<wbr/>Logging<wbr/>Level</span></a>
|
|
35
35
|
<a href="functions/some.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-64"></use></svg><span>some</span></a>
|
|
36
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Chat</h3><div class="tsd-index-list"><a href="
|
|
36
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Chat</h3><div class="tsd-index-list"><a href="enums/OrderBy.html" class="tsd-index-link tsd-is-beta"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Order<wbr/>By</span></a>
|
|
37
|
+
<a href="enums/PresentingOrder.html" class="tsd-index-link tsd-is-beta"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-8"></use></svg><span>Presenting<wbr/>Order</span></a>
|
|
38
|
+
<a href="interfaces/ConversationsPage.html" class="tsd-index-link tsd-is-beta"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Conversations<wbr/>Page</span></a>
|
|
37
39
|
<a href="interfaces/CreateConversationParameters.html" class="tsd-index-link tsd-is-beta"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Create<wbr/>Conversation<wbr/>Parameters</span></a>
|
|
38
40
|
<a href="interfaces/CustomConversationEvent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Custom<wbr/>Conversation<wbr/>Event</span></a>
|
|
39
41
|
<a href="interfaces/EphemeralConversationEvent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ephemeral<wbr/>Conversation<wbr/>Event</span></a>
|
|
@@ -71,9 +73,7 @@
|
|
|
71
73
|
<a href="interfaces/Whatsapp.html" class="tsd-index-link tsd-is-beta"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Whatsapp</span></a>
|
|
72
74
|
<a href="types/ConversationEvent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Conversation<wbr/>Event</span></a>
|
|
73
75
|
<a href="types/NonPersistentConversationEvent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Non<wbr/>Persistent<wbr/>Conversation<wbr/>Event</span></a>
|
|
74
|
-
<a href="types/OrderBy.html" class="tsd-index-link tsd-is-beta"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Order<wbr/>By</span></a>
|
|
75
76
|
<a href="types/PersistentConversationEvent.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Persistent<wbr/>Conversation<wbr/>Event</span></a>
|
|
76
|
-
<a href="types/PresentingOrder.html" class="tsd-index-link tsd-is-beta"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2097152"></use></svg><span>Presenting<wbr/>Order</span></a>
|
|
77
77
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Voice</h3><div class="tsd-index-list"><a href="interfaces/CallSayParams.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Call<wbr/>Say<wbr/>Params</span></a>
|
|
78
78
|
<a href="interfaces/GetCallLegsParameters.html" class="tsd-index-link tsd-is-beta"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Get<wbr/>Call<wbr/>Legs<wbr/>Parameters</span></a>
|
|
79
79
|
<a href="interfaces/Leg.html" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Leg</span></a>
|
package/dist/client/index.cjs
CHANGED
|
@@ -20448,7 +20448,7 @@ function requireClientsdkClientcore () {
|
|
|
20448
20448
|
//endregion
|
|
20449
20449
|
function BuildKonfig() {
|
|
20450
20450
|
BuildKonfig_instance = this;
|
|
20451
|
-
this.t17_1 = '1.4.0-rc.
|
|
20451
|
+
this.t17_1 = '1.4.0-rc.1';
|
|
20452
20452
|
}
|
|
20453
20453
|
var BuildKonfig_instance;
|
|
20454
20454
|
function BuildKonfig_getInstance() {
|
|
@@ -61616,7 +61616,7 @@ function requireClientsdkClientcore () {
|
|
|
61616
61616
|
this.conversationId = event.d2s_1;
|
|
61617
61617
|
this.from = map(event.e2s_1);
|
|
61618
61618
|
this.eventType = event.g2s_1;
|
|
61619
|
-
this.body = event.f2s_1;
|
|
61619
|
+
this.body = parseCustomJson(event.f2s_1);
|
|
61620
61620
|
}
|
|
61621
61621
|
protoOf(CustomConversationEventJS).lf = function () {
|
|
61622
61622
|
return this.kind;
|
|
@@ -61815,7 +61815,7 @@ function requireClientsdkClientcore () {
|
|
|
61815
61815
|
return this.body;
|
|
61816
61816
|
};
|
|
61817
61817
|
function MessageCustomEventBody(body) {
|
|
61818
|
-
this.customData = body.g2u_1;
|
|
61818
|
+
this.customData = parseCustomJson(body.g2u_1);
|
|
61819
61819
|
this.deleted = body.h2u_1;
|
|
61820
61820
|
}
|
|
61821
61821
|
protoOf(MessageCustomEventBody).s3g = function () {
|
|
@@ -62257,7 +62257,17 @@ function requireClientsdkClientcore () {
|
|
|
62257
62257
|
var tmp_0 = this;
|
|
62258
62258
|
tmp_0.customSortKey = properties == null ? null : properties.m2q_1;
|
|
62259
62259
|
var tmp_1 = this;
|
|
62260
|
-
|
|
62260
|
+
var tmp1_safe_receiver = properties == null ? null : properties.n2q_1;
|
|
62261
|
+
var tmp_2;
|
|
62262
|
+
if (tmp1_safe_receiver == null) {
|
|
62263
|
+
tmp_2 = null;
|
|
62264
|
+
} else {
|
|
62265
|
+
// Inline function 'kotlin.let' call
|
|
62266
|
+
// Inline function 'kotlin.contracts.contract' call
|
|
62267
|
+
// Inline function 'vonage.Properties.customData.<anonymous>' call
|
|
62268
|
+
tmp_2 = parseCustomJson(tmp1_safe_receiver);
|
|
62269
|
+
}
|
|
62270
|
+
tmp_1.customData = tmp_2;
|
|
62261
62271
|
}
|
|
62262
62272
|
protoOf(Properties).o3h = function () {
|
|
62263
62273
|
return this.ttl;
|
|
@@ -62552,7 +62562,18 @@ function requireClientsdkClientcore () {
|
|
|
62552
62562
|
}
|
|
62553
62563
|
tmp_1.timestamp = tmp_2;
|
|
62554
62564
|
this.imageUrl = user.v2w_1;
|
|
62555
|
-
|
|
62565
|
+
var tmp_3 = this;
|
|
62566
|
+
var tmp0_safe_receiver_1 = user.w2w_1;
|
|
62567
|
+
var tmp_4;
|
|
62568
|
+
if (tmp0_safe_receiver_1 == null) {
|
|
62569
|
+
tmp_4 = null;
|
|
62570
|
+
} else {
|
|
62571
|
+
// Inline function 'kotlin.let' call
|
|
62572
|
+
// Inline function 'kotlin.contracts.contract' call
|
|
62573
|
+
// Inline function 'vonage.UserJS.customData.<anonymous>' call
|
|
62574
|
+
tmp_4 = parseCustomJson(tmp0_safe_receiver_1);
|
|
62575
|
+
}
|
|
62576
|
+
tmp_3.customData = tmp_4;
|
|
62556
62577
|
}
|
|
62557
62578
|
protoOf(UserJS).h20 = function () {
|
|
62558
62579
|
return this.id;
|
|
@@ -67299,6 +67320,10 @@ function requireClientsdkClientcore () {
|
|
|
67299
67320
|
tmp$ret$9 = copyToArray(tmp0_mapTo);
|
|
67300
67321
|
return json(tmp$ret$9.slice());
|
|
67301
67322
|
}
|
|
67323
|
+
function parseCustomJson(value) {
|
|
67324
|
+
var tmp = JSON.parse;
|
|
67325
|
+
return ((!(tmp == null) ? typeof tmp === 'function' : false) ? tmp : THROW_CCE())(value);
|
|
67326
|
+
}
|
|
67302
67327
|
function None() {
|
|
67303
67328
|
OptionJS.call(this);
|
|
67304
67329
|
}
|
|
@@ -68331,8 +68356,28 @@ const VonageErrorType = clientsdkClientcore_jsExports.vonage.VonageErrorTypeJS;
|
|
|
68331
68356
|
const CSErrorCodes = clientsdkClientcore_jsExports.vonage.CSErrorCodesJS;
|
|
68332
68357
|
const SessionErrorCodes = clientsdkClientcore_jsExports.vonage.SessionErrorCodesJS;
|
|
68333
68358
|
|
|
68334
|
-
|
|
68335
|
-
|
|
68359
|
+
/**
|
|
68360
|
+
* The order in which paginated objects are presented.
|
|
68361
|
+
* @beta
|
|
68362
|
+
* @group Chat
|
|
68363
|
+
* @enum
|
|
68364
|
+
* @property ASC Ascending order
|
|
68365
|
+
* @property DESC Descending order
|
|
68366
|
+
*/
|
|
68367
|
+
const PresentingOrder = {
|
|
68368
|
+
ASC: 'asc',
|
|
68369
|
+
DESC: 'desc'
|
|
68370
|
+
};
|
|
68371
|
+
/**
|
|
68372
|
+
* The sorting strategy used for paginated objects.
|
|
68373
|
+
* @beta
|
|
68374
|
+
* @group Chat
|
|
68375
|
+
* @enum
|
|
68376
|
+
*/
|
|
68377
|
+
const OrderBy = {
|
|
68378
|
+
CREATED: 'created',
|
|
68379
|
+
CUSTOM_SORT_KEY: 'custom_sort_key'
|
|
68380
|
+
};
|
|
68336
68381
|
|
|
68337
68382
|
const Option = clientsdkClientcore_jsExports.vonage.utils.OptionJS;
|
|
68338
68383
|
const mapOption = (value) => {
|
|
@@ -68353,6 +68398,19 @@ const some = (value) => new Option.Some(value);
|
|
|
68353
68398
|
*/
|
|
68354
68399
|
const none = () => new Option.None();
|
|
68355
68400
|
|
|
68401
|
+
const isKotlinType = (type, value) => value instanceof type;
|
|
68402
|
+
// converts a js enum value to a kotlin enum value
|
|
68403
|
+
// e.g. jsEnumToVonageObject(vonage.PresentingOrderJS, 'asc') => vonage.PresentingOrderJS.Asc
|
|
68404
|
+
const jsEnumToVonageObject = (kotlinType, value) => {
|
|
68405
|
+
if (isKotlinType(kotlinType, value))
|
|
68406
|
+
return value;
|
|
68407
|
+
const enumVal = kotlinType[value.toUpperCase()];
|
|
68408
|
+
if (!enumVal) {
|
|
68409
|
+
console.warn(`Invalid parameter ${value}`);
|
|
68410
|
+
}
|
|
68411
|
+
return enumVal;
|
|
68412
|
+
};
|
|
68413
|
+
|
|
68356
68414
|
const CancelReason = clientsdkClientcore_jsExports.vonage.CancelReasonJS;
|
|
68357
68415
|
const HangupReason = clientsdkClientcore_jsExports.vonage.HangupReasonJS;
|
|
68358
68416
|
const SessionErrorReason = clientsdkClientcore_jsExports.vonage.SessionErrorReasonJS;
|
|
@@ -68545,7 +68603,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
68545
68603
|
* @param legId - The Leg Id
|
|
68546
68604
|
*/
|
|
68547
68605
|
getLeg(legId) {
|
|
68548
|
-
|
|
68606
|
+
const _super = Object.create(null, {
|
|
68607
|
+
getLeg: { get: () => super.getLeg }
|
|
68608
|
+
});
|
|
68609
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
68610
|
+
return _super.getLeg.call(this, legId);
|
|
68611
|
+
});
|
|
68549
68612
|
}
|
|
68550
68613
|
/**
|
|
68551
68614
|
* Get a Call's Legs
|
|
@@ -68560,7 +68623,16 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
68560
68623
|
* @returns a `LegsPage` containing the legs
|
|
68561
68624
|
*/
|
|
68562
68625
|
getCallLegs(callId, parameters) {
|
|
68563
|
-
|
|
68626
|
+
const _super = Object.create(null, {
|
|
68627
|
+
getCallLegs: { get: () => super.getCallLegs }
|
|
68628
|
+
});
|
|
68629
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
68630
|
+
if ((parameters && typeof (parameters === null || parameters === void 0 ? void 0 : parameters.order) === 'string') ||
|
|
68631
|
+
(parameters === null || parameters === void 0 ? void 0 : parameters.order) instanceof clientsdkClientcore_jsExports.vonage.PresentingOrderJS) {
|
|
68632
|
+
return _super.getCallLegs.call(this, callId, Object.assign(Object.assign({}, parameters), { order: jsEnumToVonageObject(clientsdkClientcore_jsExports.vonage.PresentingOrderJS, parameters.order), pageSize: parameters.pageSize, cursor: parameters.cursor }));
|
|
68633
|
+
}
|
|
68634
|
+
return (yield _super.getCallLegs.call(this, callId, parameters));
|
|
68635
|
+
});
|
|
68564
68636
|
}
|
|
68565
68637
|
/**
|
|
68566
68638
|
* Make a server call to the Vonage API.
|
|
@@ -68621,20 +68693,20 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
68621
68693
|
getConversations: { get: () => super.getConversations }
|
|
68622
68694
|
});
|
|
68623
68695
|
return __awaiter(this, void 0, void 0, function* () {
|
|
68624
|
-
if (orderOrParams &&
|
|
68696
|
+
if (orderOrParams &&
|
|
68697
|
+
(typeof orderOrParams === 'string' ||
|
|
68698
|
+
orderOrParams instanceof clientsdkClientcore_jsExports.vonage.PresentingOrderJS)) {
|
|
68625
68699
|
// Handle the case where individual parameters are provided
|
|
68626
68700
|
return (yield _super.getConversations.call(this, {
|
|
68627
|
-
order: orderOrParams,
|
|
68701
|
+
order: jsEnumToVonageObject(clientsdkClientcore_jsExports.vonage.PresentingOrderJS, orderOrParams),
|
|
68628
68702
|
pageSize,
|
|
68629
68703
|
cursor,
|
|
68630
68704
|
includeCustomData,
|
|
68631
|
-
orderBy
|
|
68705
|
+
orderBy: jsEnumToVonageObject(clientsdkClientcore_jsExports.vonage.OrderByJS, orderBy)
|
|
68632
68706
|
}));
|
|
68633
68707
|
}
|
|
68634
|
-
|
|
68635
|
-
|
|
68636
|
-
return (yield _super.getConversations.call(this, orderOrParams));
|
|
68637
|
-
}
|
|
68708
|
+
// Handle the case where GetConversationsParameters object is provided
|
|
68709
|
+
return (yield _super.getConversations.call(this, orderOrParams));
|
|
68638
68710
|
});
|
|
68639
68711
|
}
|
|
68640
68712
|
getConversationEvents(id, orderOrParams, pageSize, cursor, eventFilter, includeDeletedEvents = false, startId) {
|
|
@@ -68642,10 +68714,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
68642
68714
|
getConversationEvents: { get: () => super.getConversationEvents }
|
|
68643
68715
|
});
|
|
68644
68716
|
return __awaiter(this, void 0, void 0, function* () {
|
|
68645
|
-
if (orderOrParams &&
|
|
68717
|
+
if (orderOrParams &&
|
|
68718
|
+
(typeof orderOrParams === 'string' ||
|
|
68719
|
+
orderOrParams instanceof clientsdkClientcore_jsExports.vonage.PresentingOrderJS)) {
|
|
68646
68720
|
// Handle the case where individual parameters are provided
|
|
68647
68721
|
return (yield _super.getConversationEvents.call(this, id, {
|
|
68648
|
-
order: orderOrParams,
|
|
68722
|
+
order: jsEnumToVonageObject(clientsdkClientcore_jsExports.vonage.PresentingOrderJS, orderOrParams),
|
|
68649
68723
|
pageSize,
|
|
68650
68724
|
cursor,
|
|
68651
68725
|
eventFilter,
|
|
@@ -68655,7 +68729,7 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
68655
68729
|
}
|
|
68656
68730
|
else {
|
|
68657
68731
|
// Handle the case where GetConversationEventsParameters object is provided
|
|
68658
|
-
return (yield _super.getConversationEvents.call(this, id, orderOrParams));
|
|
68732
|
+
return (yield _super.getConversationEvents.call(this, id, Object.assign(Object.assign({}, orderOrParams), { order: jsEnumToVonageObject(clientsdkClientcore_jsExports.vonage.PresentingOrderJS, orderOrParams === null || orderOrParams === void 0 ? void 0 : orderOrParams.order) })));
|
|
68659
68733
|
}
|
|
68660
68734
|
});
|
|
68661
68735
|
}
|
|
@@ -68664,10 +68738,12 @@ class VonageClient extends clientsdkClientcore_jsExports.vonage.CombinedClientJS
|
|
|
68664
68738
|
getConversationMembers: { get: () => super.getConversationMembers }
|
|
68665
68739
|
});
|
|
68666
68740
|
return __awaiter(this, void 0, void 0, function* () {
|
|
68667
|
-
if (orderOrParams &&
|
|
68741
|
+
if (orderOrParams &&
|
|
68742
|
+
(typeof orderOrParams === 'string' ||
|
|
68743
|
+
orderOrParams instanceof clientsdkClientcore_jsExports.vonage.PresentingOrderJS)) {
|
|
68668
68744
|
// Handle the case where individual parameters are provided
|
|
68669
68745
|
return (yield _super.getConversationMembers.call(this, id, {
|
|
68670
|
-
order: orderOrParams,
|
|
68746
|
+
order: jsEnumToVonageObject(clientsdkClientcore_jsExports.vonage.PresentingOrderJS, orderOrParams),
|
|
68671
68747
|
pageSize,
|
|
68672
68748
|
cursor
|
|
68673
68749
|
}));
|