@vonage/client-sdk 1.6.1-alpha.0 → 1.6.1-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api_docs/ts/assets/navigation.js +1 -1
- package/api_docs/ts/assets/search.js +1 -1
- package/api_docs/ts/classes/VonageClient.html +27 -27
- package/api_docs/ts/enums/OrderBy.html +1 -1
- package/api_docs/ts/enums/PresentingOrder.html +1 -1
- package/api_docs/ts/index.html +2 -6
- package/api_docs/ts/interfaces/ConversationsPage.html +1 -1
- package/api_docs/ts/interfaces/CreateConversationParameters.html +1 -1
- package/api_docs/ts/interfaces/EventsPage.html +1 -1
- package/api_docs/ts/interfaces/GetCallLegsParameters.html +1 -1
- package/api_docs/ts/interfaces/GetConversationEventsParameters.html +1 -1
- package/api_docs/ts/interfaces/GetConversationMembersParameters.html +1 -1
- package/api_docs/ts/interfaces/GetConversationsParameters.html +1 -1
- package/api_docs/ts/interfaces/LegsPage.html +1 -1
- package/api_docs/ts/interfaces/Location.html +1 -1
- package/api_docs/ts/interfaces/MemberEventBody.html +1 -1
- package/api_docs/ts/interfaces/MembersPage.html +1 -1
- package/api_docs/ts/interfaces/MessageAudioEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageCustomEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageFileEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageImageEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageLocationEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageTemplateEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageTextEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageVCardEventBody.html +1 -1
- package/api_docs/ts/interfaces/MessageVideoEventBody.html +1 -1
- 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/api_docs/ts/modules.html +26 -26
- package/api_docs/ts/types/Option.html +1 -1
- package/dist/client/VonageClient.d.ts +0 -27
- package/dist/client/index.cjs +6 -26
- package/dist/client/index.mjs +6 -26
- package/dist/coreExtend.d.ts +0 -1
- package/dist/utils/ConversationEventBodies.d.ts +0 -16
- package/dist/utils/ConversationModels.d.ts +0 -4
- package/dist/utils/Option.d.ts +0 -1
- package/dist/utils/RequestParameterModels.d.ts +0 -10
- package/dist/vonageClientSDK.js +6 -26
- package/dist/vonageClientSDK.min.js +1 -1
- package/dist/vonageClientSDK.min.mjs +1 -1
- package/dist/vonageClientSDK.mjs +6 -26
- package/package.json +1 -1
|
@@ -89,34 +89,34 @@ We recommend unregistering callbacks when you no longer need them. See <a href="
|
|
|
89
89
|
</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><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><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>
|
|
90
90
|
<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>
|
|
91
91
|
</code><button>Copy</button></pre>
|
|
92
|
-
</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"><
|
|
92
|
+
</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"><div class="tsd-comment tsd-typography"><p>Create a conversation</p>
|
|
93
93
|
</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><a href="../interfaces/CreateConversationParameters.html" class="tsd-signature-type tsd-kind-interface">CreateConversationParameters</a><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>A <a href="../interfaces/CreateConversationParameters.html" class="tsd-kind-interface">CreateConversationParameters</a> object containing the parameters for the creation request.</p>
|
|
94
94
|
</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>
|
|
95
95
|
<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>
|
|
96
96
|
</code><button>Copy</button></pre>
|
|
97
|
-
</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"><
|
|
97
|
+
</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"><div class="tsd-comment tsd-typography"><p>Create a conversation</p>
|
|
98
98
|
</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>
|
|
99
99
|
</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>
|
|
100
100
|
</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>
|
|
101
101
|
<div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p>Use <a href="VonageClient.html#createConversation" class="tsd-kind-method">(parameters)</a> instead.</p>
|
|
102
|
-
</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"><
|
|
102
|
+
</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"><div class="tsd-comment tsd-typography"><p>Delete a Conversation</p>
|
|
103
103
|
</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>
|
|
104
104
|
</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>
|
|
105
105
|
<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>
|
|
106
106
|
</code><button>Copy</button></pre>
|
|
107
|
-
</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"><
|
|
107
|
+
</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"><div class="tsd-comment tsd-typography"><p>Delete an Event in a Conversation</p>
|
|
108
108
|
</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>
|
|
109
109
|
</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>
|
|
110
110
|
</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>
|
|
111
111
|
<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>
|
|
112
112
|
</code><button>Copy</button></pre>
|
|
113
|
-
</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><a href="../interfaces/EventsPage.html" class="tsd-signature-type tsd-kind-interface">EventsPage</a><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"><
|
|
113
|
+
</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><a href="../interfaces/EventsPage.html" class="tsd-signature-type tsd-kind-interface">EventsPage</a><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"><div class="tsd-comment tsd-typography"><p>Get a Conversation's Events</p>
|
|
114
114
|
</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>
|
|
115
115
|
</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><a href="../interfaces/GetConversationEventsParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationEventsParameters</a><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>A <a href="../interfaces/GetConversationEventsParameters.html" class="tsd-kind-interface">GetConversationEventsParameters</a> object containing the parameters for the request.</p>
|
|
116
116
|
</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><a href="../interfaces/EventsPage.html" class="tsd-signature-type tsd-kind-interface">EventsPage</a><span class="tsd-signature-symbol">></span></h4><p>a <a href="../interfaces/EventsPage.html" class="tsd-kind-interface">EventsPage</a> containing the events</p>
|
|
117
117
|
<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>
|
|
118
118
|
</code><button>Copy</button></pre>
|
|
119
|
-
</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><a href="../interfaces/EventsPage.html" class="tsd-signature-type tsd-kind-interface">EventsPage</a><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"><
|
|
119
|
+
</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><a href="../interfaces/EventsPage.html" class="tsd-signature-type tsd-kind-interface">EventsPage</a><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"><div class="tsd-comment tsd-typography"><p>Get a Conversation's Events</p>
|
|
120
120
|
</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>
|
|
121
121
|
</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>: <a href="../enums/PresentingOrder.html" class="tsd-signature-type tsd-kind-enum">PresentingOrder</a></h5><div class="tsd-comment tsd-typography"><p>the order to return the events in (default: 'asc')</p>
|
|
122
122
|
</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>
|
|
@@ -126,31 +126,31 @@ We recommend unregistering callbacks when you no longer need them. See <a href="
|
|
|
126
126
|
</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>
|
|
127
127
|
</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><a href="../interfaces/EventsPage.html" class="tsd-signature-type tsd-kind-interface">EventsPage</a><span class="tsd-signature-symbol">></span></h4><p>a <a href="../interfaces/EventsPage.html" class="tsd-kind-interface">EventsPage</a> containing the events</p>
|
|
128
128
|
<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>
|
|
129
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationEvents</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><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 tsd-is-inherited"><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><a href="../interfaces/Member.html" class="tsd-signature-type tsd-kind-interface">Member</a><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"><
|
|
129
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversationEvents</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><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 tsd-is-inherited"><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><a href="../interfaces/Member.html" class="tsd-signature-type tsd-kind-interface">Member</a><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"><div class="tsd-comment tsd-typography"><p>Get a Member of a Conversation</p>
|
|
130
130
|
</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>
|
|
131
131
|
</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>
|
|
132
132
|
</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><a href="../interfaces/Member.html" class="tsd-signature-type tsd-kind-interface">Member</a><span class="tsd-signature-symbol">></span></h4><p>the <code>Member</code></p>
|
|
133
133
|
<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>
|
|
134
134
|
</code><button>Copy</button></pre>
|
|
135
|
-
</div><aside class="tsd-sources"><p>Inherited from 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><a href="../interfaces/MembersPage.html" class="tsd-signature-type tsd-kind-interface">MembersPage</a><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"><
|
|
135
|
+
</div><aside class="tsd-sources"><p>Inherited from 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><a href="../interfaces/MembersPage.html" class="tsd-signature-type tsd-kind-interface">MembersPage</a><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"><div class="tsd-comment tsd-typography"><p>Get a Conversation's Members</p>
|
|
136
136
|
</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>
|
|
137
137
|
</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><a href="../interfaces/GetConversationMembersParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationMembersParameters</a><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>A <a href="../interfaces/GetConversationMembersParameters.html" class="tsd-kind-interface">GetConversationMembersParameters</a> object containing the parameters for the request.</p>
|
|
138
138
|
</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><a href="../interfaces/MembersPage.html" class="tsd-signature-type tsd-kind-interface">MembersPage</a><span class="tsd-signature-symbol">></span></h4><p>a <code>MembersPage</code> containing the members</p>
|
|
139
139
|
<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>
|
|
140
140
|
</code><button>Copy</button></pre>
|
|
141
|
-
</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><a href="../interfaces/MembersPage.html" class="tsd-signature-type tsd-kind-interface">MembersPage</a><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"><
|
|
141
|
+
</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><a href="../interfaces/MembersPage.html" class="tsd-signature-type tsd-kind-interface">MembersPage</a><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"><div class="tsd-comment tsd-typography"><p>Get a Conversation's Members</p>
|
|
142
142
|
</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>
|
|
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">order</span>: <a href="../enums/PresentingOrder.html" class="tsd-signature-type tsd-kind-enum">PresentingOrder</a></h5><div class="tsd-comment tsd-typography"><p>the order to return the members in (default: 'asc')</p>
|
|
144
144
|
</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>
|
|
145
145
|
</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>
|
|
146
146
|
</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><a href="../interfaces/MembersPage.html" class="tsd-signature-type tsd-kind-interface">MembersPage</a><span class="tsd-signature-symbol">></span></h4><p>a <code>MembersPage</code> containing the members</p>
|
|
147
147
|
<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>
|
|
148
|
-
</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><a href="../interfaces/ConversationsPage.html" class="tsd-signature-type tsd-kind-interface">ConversationsPage</a><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"><
|
|
148
|
+
</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><a href="../interfaces/ConversationsPage.html" class="tsd-signature-type tsd-kind-interface">ConversationsPage</a><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"><div class="tsd-comment tsd-typography"><p>Get a list of Conversations for the user.</p>
|
|
149
149
|
</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><a href="../interfaces/GetConversationsParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationsParameters</a><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>A <a href="../interfaces/GetConversationsParameters.html" class="tsd-kind-interface">GetConversationsParameters</a> object containing the parameters for the request.</p>
|
|
150
150
|
</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><a href="../interfaces/ConversationsPage.html" class="tsd-signature-type tsd-kind-interface">ConversationsPage</a><span class="tsd-signature-symbol">></span></h4><p>a <code>ConversationsPage</code> containing the conversations</p>
|
|
151
151
|
<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>
|
|
152
152
|
</code><button>Copy</button></pre>
|
|
153
|
-
</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><a href="../interfaces/ConversationsPage.html" class="tsd-signature-type tsd-kind-interface">ConversationsPage</a><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"><
|
|
153
|
+
</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><a href="../interfaces/ConversationsPage.html" class="tsd-signature-type tsd-kind-interface">ConversationsPage</a><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"><div class="tsd-comment tsd-typography"><p>Get a list of Conversations for the user.</p>
|
|
154
154
|
</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>: <a href="../enums/PresentingOrder.html" class="tsd-signature-type tsd-kind-enum">PresentingOrder</a></h5><div class="tsd-comment tsd-typography"><p>the order to return the conversations in (default: 'asc')</p>
|
|
155
155
|
</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>
|
|
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">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>
|
|
@@ -158,90 +158,90 @@ We recommend unregistering callbacks when you no longer need them. See <a href="
|
|
|
158
158
|
</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><a href="../enums/OrderBy.html" class="tsd-signature-type tsd-kind-enum">OrderBy</a></h5><div class="tsd-comment tsd-typography"><p>order by strategy (default: null)</p>
|
|
159
159
|
</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><a href="../interfaces/ConversationsPage.html" class="tsd-signature-type tsd-kind-interface">ConversationsPage</a><span class="tsd-signature-symbol">></span></h4><p>a <code>ConversationsPage</code> containing the conversations</p>
|
|
160
160
|
<div class="tsd-comment tsd-typography"><h4>Deprecated</h4><p>Use <a href="VonageClient.html#getConversations" class="tsd-kind-method">(parameters)</a> instead.</p>
|
|
161
|
-
</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"><
|
|
161
|
+
</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"><div class="tsd-comment tsd-typography"><p>Invite a user to a Conversation by user's <code>name</code></p>
|
|
162
162
|
</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>
|
|
163
163
|
</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 name of the user to invite</p>
|
|
164
164
|
</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>
|
|
165
165
|
<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>
|
|
166
166
|
</code><button>Copy</button></pre>
|
|
167
|
-
</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"><
|
|
167
|
+
</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"><div class="tsd-comment tsd-typography"><p>Join a Conversation</p>
|
|
168
168
|
</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>
|
|
169
169
|
</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>
|
|
170
170
|
<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>
|
|
171
171
|
</code><button>Copy</button></pre>
|
|
172
|
-
</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"><
|
|
172
|
+
</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"><div class="tsd-comment tsd-typography"><p>Leave a Conversation</p>
|
|
173
173
|
</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>
|
|
174
174
|
</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>
|
|
175
175
|
<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>
|
|
176
176
|
</code><button>Copy</button></pre>
|
|
177
|
-
</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"><
|
|
177
|
+
</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"><div class="tsd-comment tsd-typography"><p>Send a Custom event to a Conversation</p>
|
|
178
178
|
</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>
|
|
179
179
|
</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>
|
|
180
180
|
</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>
|
|
181
181
|
<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>
|
|
182
182
|
</code><button>Copy</button></pre>
|
|
183
|
-
</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"><
|
|
183
|
+
</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"><div class="tsd-comment tsd-typography"><p>Send an ephemeral event to a Conversation</p>
|
|
184
184
|
</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>
|
|
185
185
|
</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>
|
|
186
186
|
</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>
|
|
187
187
|
<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>
|
|
188
188
|
</code><button>Copy</button></pre>
|
|
189
|
-
</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"><
|
|
189
|
+
</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"><div class="tsd-comment tsd-typography"><p>Send a audio message to a Conversation.</p>
|
|
190
190
|
</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>
|
|
191
191
|
</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>
|
|
192
192
|
</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>
|
|
193
193
|
<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>
|
|
194
194
|
</code><button>Copy</button></pre>
|
|
195
|
-
</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"><
|
|
195
|
+
</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"><div class="tsd-comment tsd-typography"><p>Send a custom message to a Conversation</p>
|
|
196
196
|
</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>
|
|
197
197
|
</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>
|
|
198
198
|
</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>
|
|
199
199
|
<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>
|
|
200
200
|
</code><button>Copy</button></pre>
|
|
201
|
-
</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"><
|
|
201
|
+
</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"><div class="tsd-comment tsd-typography"><p>Send a file message to a Conversation.</p>
|
|
202
202
|
</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>
|
|
203
203
|
</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>
|
|
204
204
|
</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>
|
|
205
205
|
<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>
|
|
206
206
|
</code><button>Copy</button></pre>
|
|
207
|
-
</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"><
|
|
207
|
+
</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"><div class="tsd-comment tsd-typography"><p>Send a Image message to a Conversation.</p>
|
|
208
208
|
</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>
|
|
209
209
|
</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>
|
|
210
210
|
</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>
|
|
211
211
|
<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>
|
|
212
212
|
</code><button>Copy</button></pre>
|
|
213
|
-
</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"><
|
|
213
|
+
</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"><div class="tsd-comment tsd-typography"><p>Send a Location message to a Conversation.</p>
|
|
214
214
|
</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>
|
|
215
215
|
</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>
|
|
216
216
|
</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>
|
|
217
217
|
<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>
|
|
218
218
|
</code><button>Copy</button></pre>
|
|
219
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageLocationEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageSeenEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Seen<wbr/>Event</span><a href="#sendMessageSeenEvent" 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="sendMessageSeenEvent.sendMessageSeenEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Seen<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">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageSeenEvent.sendMessageSeenEvent-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"><
|
|
219
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageLocationEvent</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendMessageSeenEvent" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Message<wbr/>Seen<wbr/>Event</span><a href="#sendMessageSeenEvent" 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="sendMessageSeenEvent.sendMessageSeenEvent-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Message<wbr/>Seen<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">string</span><span class="tsd-signature-symbol">></span><a href="#sendMessageSeenEvent.sendMessageSeenEvent-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 message seen event to a Conversation</p>
|
|
220
220
|
</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 event id</p>
|
|
221
221
|
</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 conversation id</p>
|
|
222
222
|
</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>
|
|
223
223
|
<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_SendMessageSeenEvent</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
224
224
|
</code><button>Copy</button></pre>
|
|
225
|
-
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageSeenEvent</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"><
|
|
225
|
+
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageSeenEvent</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"><div class="tsd-comment tsd-typography"><p>Send a template message to a Conversation.</p>
|
|
226
226
|
</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>
|
|
227
227
|
</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>
|
|
228
228
|
</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>
|
|
229
229
|
</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>
|
|
230
230
|
<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_SendTemplateMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|
|
231
231
|
</code><button>Copy</button></pre>
|
|
232
|
-
</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"><
|
|
232
|
+
</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"><div class="tsd-comment tsd-typography"><p>Send a text message to a Conversation</p>
|
|
233
233
|
</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>
|
|
234
234
|
</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>
|
|
235
235
|
</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>
|
|
236
236
|
<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>
|
|
237
237
|
</code><button>Copy</button></pre>
|
|
238
|
-
</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"><
|
|
238
|
+
</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"><div class="tsd-comment tsd-typography"><p>Send a vcard message to a Conversation.</p>
|
|
239
239
|
</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>
|
|
240
240
|
</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>
|
|
241
241
|
</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>
|
|
242
242
|
<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>
|
|
243
243
|
</code><button>Copy</button></pre>
|
|
244
|
-
</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"><
|
|
244
|
+
</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"><div class="tsd-comment tsd-typography"><p>Send a Vidoe message to a Conversation.</p>
|
|
245
245
|
</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>
|
|
246
246
|
</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>
|
|
247
247
|
</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>
|
|
@@ -264,7 +264,7 @@ We recommend unregistering callbacks when you no longer need them. See <a href="
|
|
|
264
264
|
</code><button>Copy</button></pre>
|
|
265
265
|
</div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.enableEarmuff</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAudioElement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Audio<wbr/>Element</span><a href="#getAudioElement" 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="getAudioElement.getAudioElement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Audio<wbr/>Element</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLAudioElement</span><a href="#getAudioElement.getAudioElement-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 HTML Audio Element for the SDK.
|
|
266
266
|
It can be used to route output to other devices.</p>
|
|
267
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLAudioElement</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getAudioElement</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getCallLegs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Call<wbr/>Legs</span><a href="#getCallLegs" 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="getCallLegs.getCallLegs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Call<wbr/>Legs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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><a href="../interfaces/LegsPage.html" class="tsd-signature-type tsd-kind-interface">LegsPage</a><span class="tsd-signature-symbol">></span><a href="#getCallLegs.getCallLegs-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"><
|
|
267
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLAudioElement</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getAudioElement</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getCallLegs" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Call<wbr/>Legs</span><a href="#getCallLegs" 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="getCallLegs.getCallLegs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Call<wbr/>Legs</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</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><a href="../interfaces/LegsPage.html" class="tsd-signature-type tsd-kind-interface">LegsPage</a><span class="tsd-signature-symbol">></span><a href="#getCallLegs.getCallLegs-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 Call's Legs</p>
|
|
268
268
|
</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></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><a href="../interfaces/GetCallLegsParameters.html" class="tsd-signature-type tsd-kind-interface">GetCallLegsParameters</a><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>A <a href="../interfaces/GetCallLegsParameters.html" class="tsd-kind-interface">GetCallLegsParameters</a> object containing the parameters for the request.</p>
|
|
269
269
|
</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><a href="../interfaces/LegsPage.html" class="tsd-signature-type tsd-kind-interface">LegsPage</a><span class="tsd-signature-symbol">></span></h4><p>a <code>LegsPage</code> containing the legs</p>
|
|
270
270
|
<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_GetCallLegs</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
|