@vonage/client-sdk 1.3.0-beta.1 → 1.3.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/README.md +2 -2
- package/api_docs/ts/assets/search.js +1 -1
- package/api_docs/ts/assets/style.css +11 -0
- package/api_docs/ts/classes/ClientConfig.html +3 -3
- package/api_docs/ts/classes/ClientInitConfig.html +5 -4
- package/api_docs/ts/classes/VonageClient.html +49 -49
- package/api_docs/ts/functions/setDefaultLoggingLevel.html +1 -1
- package/api_docs/ts/functions/setVonageClientLoggingLevel.html +1 -1
- package/api_docs/ts/interfaces/ConversationEvent.html +2 -2
- package/api_docs/ts/interfaces/ConversationState.html +66 -66
- package/api_docs/ts/interfaces/CustomConversationEvent.html +3 -3
- package/api_docs/ts/interfaces/EmbeddedInfo.html +2 -2
- package/api_docs/ts/interfaces/EphemeralConversationEvent.html +3 -3
- package/api_docs/ts/interfaces/EventDeleteConversationEvent.html +3 -3
- package/api_docs/ts/interfaces/From.html +2 -2
- package/api_docs/ts/interfaces/Location.html +1 -1
- package/api_docs/ts/interfaces/MemberInvitedEvent.html +3 -3
- package/api_docs/ts/interfaces/MemberJoinedEvent.html +3 -3
- package/api_docs/ts/interfaces/MemberLeftEvent.html +3 -3
- package/api_docs/ts/interfaces/MemberState.html +66 -66
- package/api_docs/ts/interfaces/MessageAudioEvent.html +3 -3
- package/api_docs/ts/interfaces/MessageCustomEvent.html +3 -3
- package/api_docs/ts/interfaces/MessageFileEvent.html +3 -3
- package/api_docs/ts/interfaces/MessageImageEvent.html +3 -3
- package/api_docs/ts/interfaces/MessageLocationEvent.html +3 -3
- package/api_docs/ts/interfaces/MessageTemplateEvent.html +3 -3
- package/api_docs/ts/interfaces/MessageTextEvent.html +3 -3
- package/api_docs/ts/interfaces/MessageVCardEvent.html +3 -3
- package/api_docs/ts/interfaces/MessageVideoEvent.html +3 -3
- package/api_docs/ts/interfaces/NonPersistentConversationEvent.html +2 -2
- package/api_docs/ts/interfaces/PersistentConversationEvent.html +2 -2
- package/api_docs/ts/interfaces/System.html +2 -2
- package/api_docs/ts/interfaces/Template.html +1 -1
- package/api_docs/ts/interfaces/UpdateConversationParameters.html +1 -1
- package/api_docs/ts/interfaces/Whatsapp.html +1 -1
- package/dist/client/index.cjs +7753 -7623
- package/dist/client/index.mjs +7753 -7623
- package/dist/kotlin/clientsdk-clientcore_js.d.ts +4 -5
- package/dist/lib/MediaClient.d.ts +0 -1
- package/dist/utils/ClientConfig.d.ts +3 -2
- package/dist/vonageClientSDK.js +7740 -7610
- package/dist/vonageClientSDK.min.js +1 -1
- package/dist/vonageClientSDK.min.mjs +1 -1
- package/dist/vonageClientSDK.mjs +7740 -7610
- package/package.json +1 -1
- package/dist/lib/ConnectivityManager.d.ts +0 -11
|
@@ -41,13 +41,13 @@
|
|
|
41
41
|
<a href="VonageClient.html#sendDTMF" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sendDTMF</span></a>
|
|
42
42
|
<a href="VonageClient.html#serverCall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>server<wbr/>Call</span></a>
|
|
43
43
|
<a href="VonageClient.html#unmute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a>
|
|
44
|
-
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="__doNotUseOrImplementIt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>__do<wbr/>Not<wbr/>Use<wbr/>Or<wbr/>Implement<wbr/>It</span><a href="#__doNotUseOrImplementIt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">__do<wbr/>Not<wbr/>Use<wbr/>Or<wbr/>Implement<wbr/>It</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">vonage.IChatClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-
|
|
45
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-
|
|
44
|
+
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="__doNotUseOrImplementIt" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>__do<wbr/>Not<wbr/>Use<wbr/>Or<wbr/>Implement<wbr/>It</span><a href="#__doNotUseOrImplementIt" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">__do<wbr/>Not<wbr/>Use<wbr/>Or<wbr/>Implement<wbr/>It</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">vonage.IChatClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.IChatClientJS</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">vonage.ICoreClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.ICoreClientJS</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> & </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">vonage.IVoiceClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.IVoiceClientJS</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">vonage.IChat<wbr/>ClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.IChatClientJS</a></h5></li></ul></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">vonage.ICore<wbr/>ClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.ICoreClientJS</a></h5></li></ul></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagReadonly">Readonly</code> <span class="tsd-kind-property">vonage.IVoice<wbr/>ClientJS</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-keyword">typeof </span><a href="" class="tsd-signature-type tsd-kind-property">vonage.IVoiceClientJS</a></h5></li></ul></div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.__doNotUseOrImplementIt</p></aside></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="clearCallbacks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear<wbr/>Callbacks</span><a href="#clearCallbacks" 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 tsd-anchor-link"><a id="clearCallbacks.clearCallbacks-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear<wbr/>Callbacks</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#clearCallbacks.clearCallbacks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clear all callbacks for an event.</p>
|
|
45
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type ">VonageEvent</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5><div class="tsd-comment tsd-typography"><p>the event to unregister from (e.g. 'legStatusUpdate')</p>
|
|
46
46
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>void</p>
|
|
47
47
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_ClearCallbacks</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
48
48
|
</code><button>Copy</button></pre>
|
|
49
49
|
<h4>Remarks</h4><p>This is useful for cleaning up callbacks when you no longer need them.</p>
|
|
50
|
-
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="createSession" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Session</span><a href="#createSession" 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 tsd-anchor-link" id="createSession.createSession-1"><span class="tsd-kind-call-signature">create<wbr/>Session</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span>, <span class="tsd-kind-parameter">sessionId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createSession.createSession-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a session with a token and optional sessionId
|
|
50
|
+
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="createSession" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Session</span><a href="#createSession" 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 tsd-anchor-link"><a id="createSession.createSession-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Session</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span>, <span class="tsd-kind-parameter">sessionId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createSession.createSession-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a session with a token and optional sessionId
|
|
51
51
|
If no sessionId is provided, a new one will be generated
|
|
52
52
|
and returned. If a sessionId is provided, it will be used
|
|
53
53
|
to resume an existing session.</p>
|
|
@@ -55,66 +55,66 @@ to resume an existing session.</p>
|
|
|
55
55
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>sessionId</code> of the session</p>
|
|
56
56
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SessionCreate</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
57
57
|
</code><button>Copy</button></pre>
|
|
58
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.createSession</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversation</span><a href="#getConversation" 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 tsd-anchor-link" id="getConversation.getConversation-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">conversationIdOrName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Conversation</span><span class="tsd-signature-symbol">></span><a href="#getConversation.getConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a Conversation</p>
|
|
58
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.createSession</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversation</span><a href="#getConversation" 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 tsd-anchor-link"><a id="getConversation.getConversation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">conversationIdOrName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Conversation</span><span class="tsd-signature-symbol">></span><a href="#getConversation.getConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a Conversation</p>
|
|
59
59
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">conversationIdOrName</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id or conversation name</p>
|
|
60
60
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Conversation</span><span class="tsd-signature-symbol">></span></h4><p>the <code>Conversation</code></p>
|
|
61
61
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_GetConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
62
62
|
</code><button>Copy</button></pre>
|
|
63
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off</span><a href="#off" 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 tsd-anchor-link" id="off.off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">callbackSymbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unregister a callback for an event.</p>
|
|
64
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-
|
|
63
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off</span><a href="#off" 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 tsd-anchor-link"><a id="off.off-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">callbackSymbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unregister a callback for an event.</p>
|
|
64
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type ">VonageEvent</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5><div class="tsd-comment tsd-typography"><p>the event to register for (e.g. 'legStatusUpdate')</p>
|
|
65
65
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">callbackSymbol</span>: <span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><p>the callback symbol to unregister</p>
|
|
66
66
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the callback was unregistered, false otherwise</p>
|
|
67
67
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_UnregisterListener</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
68
68
|
</code><button>Copy</button></pre>
|
|
69
69
|
<h4>Remarks</h4><p>We recommend deregistering callbacks when you no longer need them.</p>
|
|
70
|
-
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on</span><a href="#on" 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 tsd-anchor-link" id="on.on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Fn</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">symbol</span><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Register a callback for an event.</p>
|
|
71
|
-
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-
|
|
70
|
+
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on</span><a href="#on" 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 tsd-anchor-link"><a id="on.on-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">Fn</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">symbol</span><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Register a callback for an event.</p>
|
|
71
|
+
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-keyword">keyof </span><span class="tsd-signature-type ">VonageEvent</span></h4></li><li><h4><span class="tsd-kind-type-parameter">Fn</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">from</span>, <span class="tsd-kind-parameter">channelType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">conversationId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">legId</span>, <span class="tsd-kind-parameter">isMuted</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">legId</span>, <span class="tsd-kind-parameter">earmuffStatus</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">legId</span>, <span class="tsd-kind-parameter">digits</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">callQuality</span>, <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">legId</span>, <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">rtcStats</span>, <span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5><div class="tsd-comment tsd-typography"><p>the event to register for (e.g. 'legStatusUpdate')</p>
|
|
72
72
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type tsd-kind-type-parameter">Fn</span></h5><div class="tsd-comment tsd-typography"><p>the callback to register for the event</p>
|
|
73
73
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">symbol</span></h4><p>a symbol that can be used to unregister the callback</p>
|
|
74
74
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_OnConversationEventListener</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
75
75
|
</code><button>Copy</button></pre>
|
|
76
76
|
<h4>Remarks</h4><p>Besure to store the symbol returned by this method so you can unregister the callback later.
|
|
77
77
|
We recommend deregistering callbacks when you no longer need them. See <a href="VonageClient.html#off" class="tsd-kind-method">off</a>.</p>
|
|
78
|
-
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="setConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Config</span><a href="#setConfig" 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 tsd-anchor-link" id="setConfig.setConfig-1"><span class="tsd-kind-call-signature">set<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setConfig.setConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set a configuration for the client SDK</p>
|
|
78
|
+
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="setConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Config</span><a href="#setConfig" 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 tsd-anchor-link"><a id="setConfig.setConfig-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setConfig.setConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set a configuration for the client SDK</p>
|
|
79
79
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">config</span>: <span class="tsd-signature-type ">ClientConfigObject</span></h5><div class="tsd-comment tsd-typography"><p>A configuration object</p>
|
|
80
80
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>void</p>
|
|
81
81
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SetClientConfig</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
82
82
|
</code><button>Copy</button></pre>
|
|
83
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.setConfig</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Conversation</span><a href="#updateConversation" 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 tsd-anchor-link" id="updateConversation.updateConversation-1"><span class="tsd-kind-call-signature">update<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">conversationId</span>, <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Conversation</span><span class="tsd-signature-symbol">></span><a href="#updateConversation.updateConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates a conversation object identified by its unique conversation ID.</p>
|
|
83
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.setConfig</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Conversation</span><a href="#updateConversation" 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 tsd-anchor-link"><a id="updateConversation.updateConversation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">conversationId</span>, <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Conversation</span><span class="tsd-signature-symbol">></span><a href="#updateConversation.updateConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates a conversation object identified by its unique conversation ID.</p>
|
|
84
84
|
<p>This method overrides the conversation properties to the provided parameters and rest remains as it is.</p>
|
|
85
85
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">conversationId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id.</p>
|
|
86
86
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">parameters</span>: <a href="../interfaces/UpdateConversationParameters.html" class="tsd-signature-type tsd-kind-interface">UpdateConversationParameters</a></h5><div class="tsd-comment tsd-typography"><p>The properties of the conversation. These will replace existing values to the provided ones, rest will remain as they are.</p>
|
|
87
87
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Conversation</span><span class="tsd-signature-symbol">></span></h4><p><code>conversation</code>, this object will contain the updated conversation properties if the update is successful.</p>
|
|
88
88
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_updateConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
89
89
|
</code><button>Copy</button></pre>
|
|
90
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.updateConversation</p></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Chat</h2><section class="tsd-panel tsd-member"><a id="createConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Conversation</span><a href="#createConversation" 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 tsd-anchor-link" id="createConversation.createConversation-1"><span class="tsd-kind-call-signature">create<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createConversation.createConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Create a conversation</p>
|
|
90
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.updateConversation</p></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Chat</h2><section class="tsd-panel tsd-member"><a id="createConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Conversation</span><a href="#createConversation" 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 tsd-anchor-link"><a id="createConversation.createConversation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createConversation.createConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Create a conversation</p>
|
|
91
91
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">CreateConversationParameters</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>A CreateConversationParameters object containing the parameters for the creation request.</p>
|
|
92
92
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>cid</code> of the conversation</p>
|
|
93
93
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_CreateConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
94
94
|
</code><button>Copy</button></pre>
|
|
95
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.createConversation</p></aside></li><li class="tsd-signature tsd-anchor-link" id="createConversation.createConversation-2"><span class="tsd-kind-call-signature">create<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">displayName</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createConversation.createConversation-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Create a conversation</p>
|
|
95
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.createConversation</p></aside></li><li class="tsd-signature tsd-anchor-link"><a id="createConversation.createConversation-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">displayName</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createConversation.createConversation-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Create a conversation</p>
|
|
96
96
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the name of the conversation</p>
|
|
97
97
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">displayName</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the display name of the conversation</p>
|
|
98
98
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>cid</code> of the conversation</p>
|
|
99
99
|
<div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p>Use <a href="VonageClient.html#createConversation" class="tsd-kind-method">(parameters)</a> instead.</p>
|
|
100
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.createConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Conversation</span><a href="#deleteConversation" 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 tsd-anchor-link" id="deleteConversation.deleteConversation-1"><span class="tsd-kind-call-signature">delete<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteConversation.deleteConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Delete a Conversation</p>
|
|
100
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.createConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Conversation</span><a href="#deleteConversation" 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 tsd-anchor-link"><a id="deleteConversation.deleteConversation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteConversation.deleteConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Delete a Conversation</p>
|
|
101
101
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
102
102
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
103
103
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_DeleteConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
104
104
|
</code><button>Copy</button></pre>
|
|
105
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.deleteConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Event</span><a href="#deleteEvent" 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 tsd-anchor-link" id="deleteEvent.deleteEvent-1"><span class="tsd-kind-call-signature">delete<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">conversationId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteEvent.deleteEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Delete an Event in a Conversation</p>
|
|
105
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.deleteConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="deleteEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>delete<wbr/>Event</span><a href="#deleteEvent" 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 tsd-anchor-link"><a id="deleteEvent.deleteEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">delete<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">conversationId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#deleteEvent.deleteEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Delete an Event in a Conversation</p>
|
|
106
106
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the id for the Event to be deleted</p>
|
|
107
107
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">conversationId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the id for the conversation, the event belongs to.</p>
|
|
108
108
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
109
109
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">:</span><span class="hl-4">snippet_DeleteEvent</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
110
110
|
</code><button>Copy</button></pre>
|
|
111
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.deleteEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversationEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversation<wbr/>Events</span><a href="#getConversationEvents" 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 tsd-anchor-link" id="getConversationEvents.getConversationEvents-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">EventsPage</span><span class="tsd-signature-symbol">></span><a href="#getConversationEvents.getConversationEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a Conversation's Events</p>
|
|
111
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.deleteEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversationEvents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversation<wbr/>Events</span><a href="#getConversationEvents" 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 tsd-anchor-link"><a id="getConversationEvents.getConversationEvents-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">EventsPage</span><span class="tsd-signature-symbol">></span><a href="#getConversationEvents.getConversationEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a Conversation's Events</p>
|
|
112
112
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
113
113
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">GetConversationEventsParameters</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>A GetConversationEventsParameters object containing the parameters for the request.</p>
|
|
114
114
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">EventsPage</span><span class="tsd-signature-symbol">></span></h4><p>a EventsPage containing the events</p>
|
|
115
115
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_GetConversationEvents</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
116
116
|
</code><button>Copy</button></pre>
|
|
117
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationEvents</p></aside></li><li class="tsd-signature tsd-anchor-link" id="getConversationEvents.getConversationEvents-2"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">eventFilter</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">includeDeletedEvents</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">startId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">EventsPage</span><span class="tsd-signature-symbol">></span><a href="#getConversationEvents.getConversationEvents-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a Conversation's Events</p>
|
|
117
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationEvents</p></aside></li><li class="tsd-signature tsd-anchor-link"><a id="getConversationEvents.getConversationEvents-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Events</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">eventFilter</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">includeDeletedEvents</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">startId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">EventsPage</span><span class="tsd-signature-symbol">></span><a href="#getConversationEvents.getConversationEvents-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a Conversation's Events</p>
|
|
118
118
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
119
119
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">order</span>: <span class="tsd-signature-type ">PresentingOrderJS</span></h5><div class="tsd-comment tsd-typography"><p>the order to return the events in (default: 'asc')</p>
|
|
120
120
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">pageSize</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the number of events to return per page (default: 100)</p>
|
|
@@ -124,31 +124,31 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
|
|
|
124
124
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">startId</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>A number, the starting id of the events to be returned (default: null)</p>
|
|
125
125
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">EventsPage</span><span class="tsd-signature-symbol">></span></h4><p>a EventsPage containing the events</p>
|
|
126
126
|
<div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p>Use <a href="VonageClient.html#getConversationEvents" class="tsd-kind-method">(id, parameters)</a> instead.</p>
|
|
127
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationEvents</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversationMember" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversation<wbr/>Member</span><a href="#getConversationMember" 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 tsd-anchor-link" id="getConversationMember.getConversationMember-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Member</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cid</span>, <span class="tsd-kind-parameter">mid</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Member</span><span class="tsd-signature-symbol">></span><a href="#getConversationMember.getConversationMember-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a Member of a Conversation</p>
|
|
127
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationEvents</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversationMember" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversation<wbr/>Member</span><a href="#getConversationMember" 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 tsd-anchor-link"><a id="getConversationMember.getConversationMember-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Member</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cid</span>, <span class="tsd-kind-parameter">mid</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Member</span><span class="tsd-signature-symbol">></span><a href="#getConversationMember.getConversationMember-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a Member of a Conversation</p>
|
|
128
128
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">cid</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
129
129
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">mid</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Member's id</p>
|
|
130
130
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Member</span><span class="tsd-signature-symbol">></span></h4><p>the <code>Member</code></p>
|
|
131
131
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_GetConversationMember</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
132
132
|
</code><button>Copy</button></pre>
|
|
133
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationMember</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversationMembers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversation<wbr/>Members</span><a href="#getConversationMembers" 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 tsd-anchor-link" id="getConversationMembers.getConversationMembers-1"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Members</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">MembersPage</span><span class="tsd-signature-symbol">></span><a href="#getConversationMembers.getConversationMembers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a Conversation's Members</p>
|
|
133
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationMember</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversationMembers" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversation<wbr/>Members</span><a href="#getConversationMembers" 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 tsd-anchor-link"><a id="getConversationMembers.getConversationMembers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Members</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">MembersPage</span><span class="tsd-signature-symbol">></span><a href="#getConversationMembers.getConversationMembers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a Conversation's Members</p>
|
|
134
134
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
135
135
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">GetConversationMembersParameters</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>A GetConversationMembersParameters object containing the parameters for the request.</p>
|
|
136
136
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">MembersPage</span><span class="tsd-signature-symbol">></span></h4><p>a <code>MembersPage</code> containing the members</p>
|
|
137
137
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_GetConversationMembers</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
138
138
|
</code><button>Copy</button></pre>
|
|
139
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationMembers</p></aside></li><li class="tsd-signature tsd-anchor-link" id="getConversationMembers.getConversationMembers-2"><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Members</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">MembersPage</span><span class="tsd-signature-symbol">></span><a href="#getConversationMembers.getConversationMembers-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a Conversation's Members</p>
|
|
139
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationMembers</p></aside></li><li class="tsd-signature tsd-anchor-link"><a id="getConversationMembers.getConversationMembers-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Conversation<wbr/>Members</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">MembersPage</span><span class="tsd-signature-symbol">></span><a href="#getConversationMembers.getConversationMembers-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a Conversation's Members</p>
|
|
140
140
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
141
141
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">order</span>: <span class="tsd-signature-type ">PresentingOrderJS</span></h5><div class="tsd-comment tsd-typography"><p>the order to return the members in (default: 'asc')</p>
|
|
142
142
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">pageSize</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the number of members to return per page (default: 100)</p>
|
|
143
143
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">cursor</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the cursor to use for pagination (default: null)</p>
|
|
144
144
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">MembersPage</span><span class="tsd-signature-symbol">></span></h4><p>a <code>MembersPage</code> containing the members</p>
|
|
145
145
|
<div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p>Use <a href="VonageClient.html#getConversationMembers" class="tsd-kind-method">(id, parameters)</a> instead.</p>
|
|
146
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationMembers</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversations</span><a href="#getConversations" 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 tsd-anchor-link" id="getConversations.getConversations-1"><span class="tsd-kind-call-signature">get<wbr/>Conversations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ConversationsPage</span><span class="tsd-signature-symbol">></span><a href="#getConversations.getConversations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a list of Conversations for the user.</p>
|
|
146
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationMembers</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversations" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversations</span><a href="#getConversations" 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 tsd-anchor-link"><a id="getConversations.getConversations-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Conversations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ConversationsPage</span><span class="tsd-signature-symbol">></span><a href="#getConversations.getConversations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a list of Conversations for the user.</p>
|
|
147
147
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type ">Nullable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">GetConversationsParameters</span><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>A GetConversationsParameters object containing the parameters for the request.</p>
|
|
148
148
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ConversationsPage</span><span class="tsd-signature-symbol">></span></h4><p>a <code>ConversationsPage</code> containing the conversations</p>
|
|
149
149
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_GetConversations</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
150
150
|
</code><button>Copy</button></pre>
|
|
151
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversations</p></aside></li><li class="tsd-signature tsd-anchor-link" id="getConversations.getConversations-2"><span class="tsd-kind-call-signature">get<wbr/>Conversations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">includeCustomData</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">orderBy</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ConversationsPage</span><span class="tsd-signature-symbol">></span><a href="#getConversations.getConversations-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a list of Conversations for the user.</p>
|
|
151
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversations</p></aside></li><li class="tsd-signature tsd-anchor-link"><a id="getConversations.getConversations-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Conversations</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">order</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">cursor</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">includeCustomData</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">orderBy</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ConversationsPage</span><span class="tsd-signature-symbol">></span><a href="#getConversations.getConversations-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Get a list of Conversations for the user.</p>
|
|
152
152
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">order</span>: <span class="tsd-signature-type ">PresentingOrderJS</span></h5><div class="tsd-comment tsd-typography"><p>the order to return the conversations in (default: 'asc')</p>
|
|
153
153
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">pageSize</span>: <span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>the number of conversations to return per page (default: 100)</p>
|
|
154
154
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">cursor</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the cursor to use for pagination (default: null)</p>
|
|
@@ -156,153 +156,153 @@ We recommend deregistering callbacks when you no longer need them. See <a href="
|
|
|
156
156
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">orderBy</span>: <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">OrderByJS</span></h5><div class="tsd-comment tsd-typography"><p>order by strategy (default: null)</p>
|
|
157
157
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">ConversationsPage</span><span class="tsd-signature-symbol">></span></h4><p>a <code>ConversationsPage</code> containing the conversations</p>
|
|
158
158
|
<div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p>Use <a href="VonageClient.html#getConversations" class="tsd-kind-method">(parameters)</a> instead.</p>
|
|
159
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversations</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="inviteToConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>invite<wbr/>To<wbr/>Conversation</span><a href="#inviteToConversation" 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 tsd-anchor-link" id="inviteToConversation.inviteToConversation-1"><span class="tsd-kind-call-signature">invite<wbr/>To<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#inviteToConversation.inviteToConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Invite a user to a Conversation by user's <code>name</code></p>
|
|
159
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversations</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="inviteToConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>invite<wbr/>To<wbr/>Conversation</span><a href="#inviteToConversation" 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 tsd-anchor-link"><a id="inviteToConversation.inviteToConversation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">invite<wbr/>To<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#inviteToConversation.inviteToConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Invite a user to a Conversation by user's <code>name</code></p>
|
|
160
160
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
161
161
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the namne of the user to invite</p>
|
|
162
162
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>memberId</code> of the member</p>
|
|
163
163
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_InviteToConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
164
164
|
</code><button>Copy</button></pre>
|
|
165
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.inviteToConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="joinConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>join<wbr/>Conversation</span><a href="#joinConversation" 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 tsd-anchor-link" id="joinConversation.joinConversation-1"><span class="tsd-kind-call-signature">join<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#joinConversation.joinConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Join a Conversation</p>
|
|
165
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.inviteToConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="joinConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>join<wbr/>Conversation</span><a href="#joinConversation" 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 tsd-anchor-link"><a id="joinConversation.joinConversation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">join<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#joinConversation.joinConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Join a Conversation</p>
|
|
166
166
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
167
167
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>memberId</code> of the member</p>
|
|
168
168
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_JoinConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
169
169
|
</code><button>Copy</button></pre>
|
|
170
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.joinConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="leaveConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>leave<wbr/>Conversation</span><a href="#leaveConversation" 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 tsd-anchor-link" id="leaveConversation.leaveConversation-1"><span class="tsd-kind-call-signature">leave<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#leaveConversation.leaveConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Leave a Conversation</p>
|
|
170
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.joinConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="leaveConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>leave<wbr/>Conversation</span><a href="#leaveConversation" 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 tsd-anchor-link"><a id="leaveConversation.leaveConversation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">leave<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#leaveConversation.leaveConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Leave a Conversation</p>
|
|
171
171
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
172
172
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
173
173
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_LeaveConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
174
174
|
</code><button>Copy</button></pre>
|
|
175
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.leaveConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendCustomEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Custom<wbr/>Event</span><a href="#sendCustomEvent" 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 tsd-anchor-link" id="sendCustomEvent.sendCustomEvent-1"><span class="tsd-kind-call-signature">send<wbr/>Custom<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">eventType</span>, <span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendCustomEvent.sendCustomEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a Custom event to a Conversation</p>
|
|
175
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.leaveConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendCustomEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Custom<wbr/>Event</span><a href="#sendCustomEvent" 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 tsd-anchor-link"><a id="sendCustomEvent.sendCustomEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Custom<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">eventType</span>, <span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendCustomEvent.sendCustomEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a Custom event to a Conversation</p>
|
|
176
176
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
177
177
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">eventType</span>: <span class="tsd-signature-type">string</span></h5></li><li><h5><span class="tsd-kind-parameter">customData</span>: <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a></h5><div class="tsd-comment tsd-typography"><p>the body of the event</p>
|
|
178
178
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
179
179
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendCustomEvent</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
180
180
|
</code><button>Copy</button></pre>
|
|
181
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendCustomEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendEphemeralEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Ephemeral<wbr/>Event</span><a href="#sendEphemeralEvent" 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 tsd-anchor-link" id="sendEphemeralEvent.sendEphemeralEvent-1"><span class="tsd-kind-call-signature">send<wbr/>Ephemeral<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendEphemeralEvent.sendEphemeralEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send an ephemeral event to a Conversation</p>
|
|
181
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendCustomEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendEphemeralEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Ephemeral<wbr/>Event</span><a href="#sendEphemeralEvent" 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 tsd-anchor-link"><a id="sendEphemeralEvent.sendEphemeralEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Ephemeral<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendEphemeralEvent.sendEphemeralEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send an ephemeral event to a Conversation</p>
|
|
182
182
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
183
183
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">customData</span>: <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a></h5><div class="tsd-comment tsd-typography"><p>the body of the event</p>
|
|
184
184
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
185
185
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendEphemeralEvent</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
186
186
|
</code><button>Copy</button></pre>
|
|
187
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendEphemeralEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageAudioEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Audio<wbr/>Event</span><a href="#sendMessageAudioEvent" 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 tsd-anchor-link" id="sendMessageAudioEvent.sendMessageAudioEvent-1"><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Audio<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">audioUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageAudioEvent.sendMessageAudioEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a audio message to a Conversation.</p>
|
|
187
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendEphemeralEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageAudioEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Audio<wbr/>Event</span><a href="#sendMessageAudioEvent" 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 tsd-anchor-link"><a id="sendMessageAudioEvent.sendMessageAudioEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Audio<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">audioUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageAudioEvent.sendMessageAudioEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a audio message to a Conversation.</p>
|
|
188
188
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
189
189
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">audioUrl</span>: <span class="tsd-signature-type ">URL</span></h5><div class="tsd-comment tsd-typography"><p>the url of the audio resource.</p>
|
|
190
190
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
191
191
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendAudioMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
192
192
|
</code><button>Copy</button></pre>
|
|
193
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageAudioEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageCustomEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Custom<wbr/>Event</span><a href="#sendMessageCustomEvent" 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 tsd-anchor-link" id="sendMessageCustomEvent.sendMessageCustomEvent-1"><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Custom<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageCustomEvent.sendMessageCustomEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a custom message to a Conversation</p>
|
|
193
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageAudioEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageCustomEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Custom<wbr/>Event</span><a href="#sendMessageCustomEvent" 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 tsd-anchor-link"><a id="sendMessageCustomEvent.sendMessageCustomEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Custom<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageCustomEvent.sendMessageCustomEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a custom message to a Conversation</p>
|
|
194
194
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
195
195
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">customData</span>: <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a></h5><div class="tsd-comment tsd-typography"><p>the body of the message</p>
|
|
196
196
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
197
197
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendCustomMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
198
198
|
</code><button>Copy</button></pre>
|
|
199
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageCustomEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageFileEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>File<wbr/>Event</span><a href="#sendMessageFileEvent" 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 tsd-anchor-link" id="sendMessageFileEvent.sendMessageFileEvent-1"><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>File<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">fileUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageFileEvent.sendMessageFileEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a file message to a Conversation.</p>
|
|
199
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageCustomEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageFileEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>File<wbr/>Event</span><a href="#sendMessageFileEvent" 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 tsd-anchor-link"><a id="sendMessageFileEvent.sendMessageFileEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>File<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">fileUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageFileEvent.sendMessageFileEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a file message to a Conversation.</p>
|
|
200
200
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
201
201
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">fileUrl</span>: <span class="tsd-signature-type ">URL</span></h5><div class="tsd-comment tsd-typography"><p>the url of the file resource.</p>
|
|
202
202
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
203
203
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendFileMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
204
204
|
</code><button>Copy</button></pre>
|
|
205
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageFileEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageImageEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Image<wbr/>Event</span><a href="#sendMessageImageEvent" 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 tsd-anchor-link" id="sendMessageImageEvent.sendMessageImageEvent-1"><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Image<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">imageUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageImageEvent.sendMessageImageEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a Image message to a Conversation.</p>
|
|
205
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageFileEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageImageEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Image<wbr/>Event</span><a href="#sendMessageImageEvent" 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 tsd-anchor-link"><a id="sendMessageImageEvent.sendMessageImageEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Image<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">imageUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageImageEvent.sendMessageImageEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a Image message to a Conversation.</p>
|
|
206
206
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
207
207
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">imageUrl</span>: <span class="tsd-signature-type ">URL</span></h5><div class="tsd-comment tsd-typography"><p>the url of the image resource.</p>
|
|
208
208
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
209
209
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendImageMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
210
210
|
</code><button>Copy</button></pre>
|
|
211
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageImageEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageLocationEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Location<wbr/>Event</span><a href="#sendMessageLocationEvent" 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 tsd-anchor-link" id="sendMessageLocationEvent.sendMessageLocationEvent-1"><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Location<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">location</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageLocationEvent.sendMessageLocationEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a Location message to a Conversation.</p>
|
|
211
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageImageEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageLocationEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Location<wbr/>Event</span><a href="#sendMessageLocationEvent" 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 tsd-anchor-link"><a id="sendMessageLocationEvent.sendMessageLocationEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Location<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">location</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageLocationEvent.sendMessageLocationEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a Location message to a Conversation.</p>
|
|
212
212
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
213
213
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">location</span>: <a href="../interfaces/Location.html" class="tsd-signature-type tsd-kind-interface">Location</a></h5><div class="tsd-comment tsd-typography"><p>the description of the location.</p>
|
|
214
214
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
215
215
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendLocationMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
216
216
|
</code><button>Copy</button></pre>
|
|
217
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageLocationEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageTemplateEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Template<wbr/>Event</span><a href="#sendMessageTemplateEvent" 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 tsd-anchor-link" id="sendMessageTemplateEvent.sendMessageTemplateEvent-1"><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Template<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">templateObject</span>, <span class="tsd-kind-parameter">whatsappObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageTemplateEvent.sendMessageTemplateEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a template message to a Conversation.</p>
|
|
217
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageLocationEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageTemplateEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Template<wbr/>Event</span><a href="#sendMessageTemplateEvent" 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 tsd-anchor-link"><a id="sendMessageTemplateEvent.sendMessageTemplateEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Template<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">templateObject</span>, <span class="tsd-kind-parameter">whatsappObject</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageTemplateEvent.sendMessageTemplateEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a template message to a Conversation.</p>
|
|
218
218
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
219
219
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">templateObject</span>: <a href="../interfaces/Template.html" class="tsd-signature-type tsd-kind-interface">Template</a></h5><div class="tsd-comment tsd-typography"><p>the description(name and paramters) of the template.</p>
|
|
220
220
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">whatsappObject</span>: <a href="../interfaces/Whatsapp.html" class="tsd-signature-type tsd-kind-interface">Whatsapp</a></h5><div class="tsd-comment tsd-typography"><p>the description(locale and policies of business account) of the location.</p>
|
|
221
221
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
222
222
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendMessageTemplateEvent</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
223
223
|
</code><button>Copy</button></pre>
|
|
224
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageTemplateEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageTextEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Text<wbr/>Event</span><a href="#sendMessageTextEvent" 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 tsd-anchor-link" id="sendMessageTextEvent.sendMessageTextEvent-1"><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Text<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageTextEvent.sendMessageTextEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a text message to a Conversation</p>
|
|
224
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageTemplateEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageTextEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Text<wbr/>Event</span><a href="#sendMessageTextEvent" 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 tsd-anchor-link"><a id="sendMessageTextEvent.sendMessageTextEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Text<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageTextEvent.sendMessageTextEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a text message to a Conversation</p>
|
|
225
225
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
226
226
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Body of the message</p>
|
|
227
227
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
228
228
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendTextMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
229
229
|
</code><button>Copy</button></pre>
|
|
230
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageTextEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageVCardEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>MessageVCard<wbr/>Event</span><a href="#sendMessageVCardEvent" 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 tsd-anchor-link" id="sendMessageVCardEvent.sendMessageVCardEvent-1"><span class="tsd-kind-call-signature">send<wbr/>MessageVCard<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">vCardUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageVCardEvent.sendMessageVCardEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a vcard message to a Conversation.</p>
|
|
230
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageTextEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageVCardEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>MessageVCard<wbr/>Event</span><a href="#sendMessageVCardEvent" 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 tsd-anchor-link"><a id="sendMessageVCardEvent.sendMessageVCardEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>MessageVCard<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">vCardUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageVCardEvent.sendMessageVCardEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a vcard message to a Conversation.</p>
|
|
231
231
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
232
232
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">vCardUrl</span>: <span class="tsd-signature-type ">URL</span></h5><div class="tsd-comment tsd-typography"><p>the url of the vCardUrl resource.</p>
|
|
233
233
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
234
234
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendVCardMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
235
235
|
</code><button>Copy</button></pre>
|
|
236
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageVCardEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageVideoEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Video<wbr/>Event</span><a href="#sendMessageVideoEvent" 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 tsd-anchor-link" id="sendMessageVideoEvent.sendMessageVideoEvent-1"><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Video<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">videoUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageVideoEvent.sendMessageVideoEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a Vidoe message to a Conversation.</p>
|
|
236
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageVCardEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageVideoEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Video<wbr/>Event</span><a href="#sendMessageVideoEvent" 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 tsd-anchor-link"><a id="sendMessageVideoEvent.sendMessageVideoEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Video<wbr/>Event</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span>, <span class="tsd-kind-parameter">videoUrl</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageVideoEvent.sendMessageVideoEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagBeta">Beta</code> <div class="tsd-comment tsd-typography"><p>Send a Vidoe message to a Conversation.</p>
|
|
237
237
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
|
|
238
238
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">videoUrl</span>: <span class="tsd-signature-type ">URL</span></h5><div class="tsd-comment tsd-typography"><p>the url of the video resource.</p>
|
|
239
239
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>timestamp</code> of the message</p>
|
|
240
240
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendVideoMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
241
241
|
</code><button>Copy</button></pre>
|
|
242
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageVideoEvent</p></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Voice</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="answer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>answer</span><a href="#answer" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link" id="answer.answer-1"><span class="tsd-kind-call-signature">answer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#answer.answer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Answer a call</p>
|
|
242
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageVideoEvent</p></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Voice</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="answer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>answer</span><a href="#answer" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="answer.answer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">answer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#answer.answer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Answer a call</p>
|
|
243
243
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Call ID</p>
|
|
244
244
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
245
245
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_AnswerCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
246
246
|
</code><button>Copy</button></pre>
|
|
247
|
-
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.answer</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="disableEarmuff" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disable<wbr/>Earmuff</span><a href="#disableEarmuff" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link" id="disableEarmuff.disableEarmuff-1"><span class="tsd-kind-call-signature">disable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#disableEarmuff.disableEarmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unearmuff your leg of a call</p>
|
|
247
|
+
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.answer</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="disableEarmuff" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disable<wbr/>Earmuff</span><a href="#disableEarmuff" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="disableEarmuff.disableEarmuff-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#disableEarmuff.disableEarmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unearmuff your leg of a call</p>
|
|
248
248
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Call ID</p>
|
|
249
249
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
250
250
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_DisableEarmuff</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
251
251
|
</code><button>Copy</button></pre>
|
|
252
|
-
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.disableEarmuff</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableEarmuff" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enable<wbr/>Earmuff</span><a href="#enableEarmuff" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link" id="enableEarmuff.enableEarmuff-1"><span class="tsd-kind-call-signature">enable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#enableEarmuff.enableEarmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Earmuff your leg of a call</p>
|
|
252
|
+
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.disableEarmuff</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableEarmuff" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enable<wbr/>Earmuff</span><a href="#enableEarmuff" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="enableEarmuff.enableEarmuff-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">enable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#enableEarmuff.enableEarmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Earmuff your leg of a call</p>
|
|
253
253
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Call ID</p>
|
|
254
254
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
255
255
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_EnableEarmuff</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
256
256
|
</code><button>Copy</button></pre>
|
|
257
|
-
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.enableEarmuff</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getLeg" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Leg</span><a href="#getLeg" 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 tsd-anchor-link" id="getLeg.getLeg-1"><span class="tsd-kind-call-signature">get<wbr/>Leg</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">LegJS</span><span class="tsd-signature-symbol">></span><a href="#getLeg.getLeg-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the Leg for a call</p>
|
|
257
|
+
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.enableEarmuff</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getLeg" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Leg</span><a href="#getLeg" 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 tsd-anchor-link"><a id="getLeg.getLeg-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Leg</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">LegJS</span><span class="tsd-signature-symbol">></span><a href="#getLeg.getLeg-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the Leg for a call</p>
|
|
258
258
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">legId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The Leg Id</p>
|
|
259
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">LegJS</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getLeg</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getPeerConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Peer<wbr/>Connection</span><a href="#getPeerConnection" 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 tsd-anchor-link" id="getPeerConnection.getPeerConnection-1"><span class="tsd-kind-call-signature">get<wbr/>Peer<wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">RTCPeerConnection</span><a href="#getPeerConnection.getPeerConnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagExperimental">Experimental</code> <div class="tsd-comment tsd-typography"><p>Get the Peer Connection for a call</p>
|
|
259
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">LegJS</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getLeg</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getPeerConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Peer<wbr/>Connection</span><a href="#getPeerConnection" 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 tsd-anchor-link"><a id="getPeerConnection.getPeerConnection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Peer<wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">RTCPeerConnection</span><a href="#getPeerConnection.getPeerConnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagExperimental">Experimental</code> <div class="tsd-comment tsd-typography"><p>Get the Peer Connection for a call</p>
|
|
260
260
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The Call Id</p>
|
|
261
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">RTCPeerConnection</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getPeerConnection</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hangup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hangup</span><a href="#hangup" 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 tsd-anchor-link" id="hangup.hangup-1"><span class="tsd-kind-call-signature">hangup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">reasonText</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">reasonCode</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#hangup.hangup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Hangup a call.</p>
|
|
261
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">RTCPeerConnection</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getPeerConnection</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hangup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hangup</span><a href="#hangup" 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 tsd-anchor-link"><a id="hangup.hangup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hangup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">reasonText</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">reasonCode</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#hangup.hangup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Hangup a call.</p>
|
|
262
262
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to hangup</p>
|
|
263
263
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">reasonText</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>optional reason text to send to the other party</p>
|
|
264
264
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">reasonCode</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>optional reason code to send to the other party</p>
|
|
265
265
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
266
266
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_Hangup</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
267
267
|
</code><button>Copy</button></pre>
|
|
268
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.hangup</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="mute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mute</span><a href="#mute" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link" id="mute.mute-1"><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#mute.mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mute your leg of a call</p>
|
|
268
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.hangup</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="mute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mute</span><a href="#mute" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="mute.mute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#mute.mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mute your leg of a call</p>
|
|
269
269
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Call ID</p>
|
|
270
270
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
271
271
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_Mute</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
272
272
|
</code><button>Copy</button></pre>
|
|
273
|
-
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.mute</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="reconnectCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reconnect<wbr/>Call</span><a href="#reconnectCall" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link" id="reconnectCall.reconnectCall-1"><span class="tsd-kind-call-signature">reconnect<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reconnectCall.reconnectCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reconnect a call</p>
|
|
273
|
+
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.mute</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="reconnectCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reconnect<wbr/>Call</span><a href="#reconnectCall" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="reconnectCall.reconnectCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reconnect<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reconnectCall.reconnectCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reconnect a call</p>
|
|
274
274
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Call ID</p>
|
|
275
275
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
276
276
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_ReconnectCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
277
277
|
</code><button>Copy</button></pre>
|
|
278
|
-
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.reconnectCall</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="reject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reject</span><a href="#reject" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link" id="reject.reject-1"><span class="tsd-kind-call-signature">reject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reject.reject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reject a call</p>
|
|
278
|
+
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.reconnectCall</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="reject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reject</span><a href="#reject" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="reject.reject-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reject.reject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reject a call</p>
|
|
279
279
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Call ID</p>
|
|
280
280
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
281
281
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_RejectCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
282
282
|
</code><button>Copy</button></pre>
|
|
283
|
-
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.reject</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="say" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>say</span><a href="#say" 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 tsd-anchor-link" id="say.say-1"><span class="tsd-kind-call-signature">say</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#say.say-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a TTS message to the Call</p>
|
|
283
|
+
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.reject</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="say" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>say</span><a href="#say" 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 tsd-anchor-link"><a id="say.say-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">say</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#say.say-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a TTS message to the Call</p>
|
|
284
284
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to send the message to</p>
|
|
285
285
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the text to send</p>
|
|
286
286
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
287
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.say</p></aside></li><li class="tsd-signature tsd-anchor-link" id="say.say-2"><span class="tsd-kind-call-signature">say</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#say.say-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a TTS message to the Call</p>
|
|
287
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.say</p></aside></li><li class="tsd-signature tsd-anchor-link"><a id="say.say-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">say</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#say.say-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a TTS message to the Call</p>
|
|
288
288
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to send the message to</p>
|
|
289
289
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type ">CallSayParams</span></h5><div class="tsd-comment tsd-typography"><p>the <code>CallSayParams</code> to send</p>
|
|
290
290
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
291
291
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_Say</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
292
292
|
</code><button>Copy</button></pre>
|
|
293
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.say</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="sendDTMF" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sendDTMF</span><a href="#sendDTMF" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link" id="sendDTMF.sendDTMF-1"><span class="tsd-kind-call-signature">sendDTMF</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">digits</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#sendDTMF.sendDTMF-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Send a string of digits to a call via DTMF</p>
|
|
293
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.say</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="sendDTMF" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sendDTMF</span><a href="#sendDTMF" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="sendDTMF.sendDTMF-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sendDTMF</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">digits</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#sendDTMF.sendDTMF-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Send a string of digits to a call via DTMF</p>
|
|
294
294
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Call ID</p>
|
|
295
295
|
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">digits</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>DTMF digits</p>
|
|
296
296
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
297
297
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_Dtmf</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
298
298
|
</code><button>Copy</button></pre>
|
|
299
|
-
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.sendDTMF</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="serverCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>server<wbr/>Call</span><a href="#serverCall" 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 tsd-anchor-link" id="serverCall.serverCall-1"><span class="tsd-kind-call-signature">server<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#serverCall.serverCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Make a server call to the Vonage API.
|
|
299
|
+
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.sendDTMF</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="serverCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>server<wbr/>Call</span><a href="#serverCall" 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 tsd-anchor-link"><a id="serverCall.serverCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">server<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#serverCall.serverCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Make a server call to the Vonage API.
|
|
300
300
|
This is used to initiate a call using the Voice API and NCCO.</p>
|
|
301
301
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type ">Json</span></h5><div class="tsd-comment tsd-typography"><p>the context to send to the server passed as Custom data to the voice answer webhook</p>
|
|
302
302
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>callId</code> of the call</p>
|
|
303
303
|
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_OutboundCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
304
304
|
</code><button>Copy</button></pre>
|
|
305
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.serverCall</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unmute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unmute</span><a href="#unmute" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link" id="unmute.unmute-1"><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#unmute.unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unmute your leg of a call</p>
|
|
305
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.serverCall</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unmute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unmute</span><a href="#unmute" 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 tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="unmute.unmute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#unmute.unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unmute your leg of a call</p>
|
|
306
306
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Call ID</p>
|
|
307
307
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>void</p>
|
|
308
308
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.unmute</p></aside></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"/><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"/><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="#__doNotUseOrImplementIt" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>__do<wbr/>Not<wbr/>Use<wbr/>Or<wbr/>Implement<wbr/>It</span></a></li><li><a href="#clearCallbacks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>clear<wbr/>Callbacks</span></a></li><li><a href="#createSession" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Session</span></a></li><li><a href="#getConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversation</span></a></li><li><a href="#off" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a></li><li><a href="#on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li><li><a href="#setConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Config</span></a></li><li><a href="#updateConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Conversation</span></a></li><li><a href="#createConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Conversation</span></a></li><li><a href="#deleteConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Conversation</span></a></li><li><a href="#deleteEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Event</span></a></li><li><a href="#getConversationEvents" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Events</span></a></li><li><a href="#getConversationMember" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Member</span></a></li><li><a href="#getConversationMembers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Members</span></a></li><li><a href="#getConversations" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversations</span></a></li><li><a href="#inviteToConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>invite<wbr/>To<wbr/>Conversation</span></a></li><li><a href="#joinConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>join<wbr/>Conversation</span></a></li><li><a href="#leaveConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>leave<wbr/>Conversation</span></a></li><li><a href="#sendCustomEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Custom<wbr/>Event</span></a></li><li><a href="#sendEphemeralEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Ephemeral<wbr/>Event</span></a></li><li><a href="#sendMessageAudioEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Audio<wbr/>Event</span></a></li><li><a href="#sendMessageCustomEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Custom<wbr/>Event</span></a></li><li><a href="#sendMessageFileEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>File<wbr/>Event</span></a></li><li><a href="#sendMessageImageEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Image<wbr/>Event</span></a></li><li><a href="#sendMessageLocationEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Location<wbr/>Event</span></a></li><li><a href="#sendMessageTemplateEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Template<wbr/>Event</span></a></li><li><a href="#sendMessageTextEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Text<wbr/>Event</span></a></li><li><a href="#sendMessageVCardEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>MessageVCard<wbr/>Event</span></a></li><li><a href="#sendMessageVideoEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Video<wbr/>Event</span></a></li><li><a href="#answer" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>answer</span></a></li><li><a href="#disableEarmuff" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>disable<wbr/>Earmuff</span></a></li><li><a href="#enableEarmuff" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Earmuff</span></a></li><li><a href="#getLeg" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Leg</span></a></li><li><a href="#getPeerConnection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Peer<wbr/>Connection</span></a></li><li><a href="#hangup" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>hangup</span></a></li><li><a href="#mute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>mute</span></a></li><li><a href="#reconnectCall" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reconnect<wbr/>Call</span></a></li><li><a href="#reject" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reject</span></a></li><li><a href="#say" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>say</span></a></li><li><a href="#sendDTMF" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sendDTMF</span></a></li><li><a href="#serverCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>server<wbr/>Call</span></a></li><li><a href="#unmute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</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="ClientConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClientConfig</a></li><li><a href="ClientInitConfig.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>ClientInitConfig</a></li><li><a href="VonageClient.html" class="current"><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/ConversationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversationEvent</a></li><li><a href="../interfaces/ConversationState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>ConversationState</a></li><li><a href="../interfaces/CustomConversationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>CustomConversationEvent</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/EphemeralConversationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EphemeralConversationEvent</a></li><li><a href="../interfaces/EventDeleteConversationEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>EventDeleteConversationEvent</a></li><li><a href="../interfaces/From.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>From</a></li><li><a href="../interfaces/Location.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>Location</a></li><li><a href="../interfaces/MemberInvitedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberInvitedEvent</a></li><li><a href="../interfaces/MemberJoinedEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberJoinedEvent</a></li><li><a href="../interfaces/MemberLeftEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberLeftEvent</a></li><li><a href="../interfaces/MemberState.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MemberState</a></li><li><a href="../interfaces/MessageAudioEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageAudioEvent</a></li><li><a href="../interfaces/MessageCustomEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageCustomEvent</a></li><li><a href="../interfaces/MessageFileEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageFileEvent</a></li><li><a href="../interfaces/MessageImageEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg>MessageImageEvent</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>
|