@vonage/client-sdk
Version:
The Client SDK is intended to provide a ready solution for developers to build Programmable Conversation applications across multiple Channels including: Messages, Voice, SIP, websockets, and App.
108 lines • 164 kB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>VonageClient | @vonage/client-sdk - v0.0.0</title><meta name="description" content="Documentation for @vonage/client-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@vonage/client-sdk - v0.0.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">@vonage/client-sdk</a></li><li><a href="VonageClient.html">VonageClient</a></li></ul><h1>Class VonageClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>VonageClient is the main entry point for the Vonage Client SDK.</p>
</div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-hierarchy"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li><span class="tsd-signature-type ">CombinedClientJS</span><ul class="tsd-hierarchy"><li><span class="target">VonageClient</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="VonageClient.html#clearCallbacks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>clear<wbr/>Callbacks</span></a>
<a href="VonageClient.html#createSession" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Session</span></a>
<a href="VonageClient.html#getConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversation</span></a>
<a href="VonageClient.html#off" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>off</span></a>
<a href="VonageClient.html#on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a>
<a href="VonageClient.html#setConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>set<wbr/>Config</span></a>
<a href="VonageClient.html#updateConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>update<wbr/>Conversation</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Chat</h3><div class="tsd-index-list"><a href="VonageClient.html#createConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Conversation</span></a>
<a href="VonageClient.html#deleteConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Conversation</span></a>
<a href="VonageClient.html#deleteEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>delete<wbr/>Event</span></a>
<a href="VonageClient.html#getConversationEvents" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Events</span></a>
<a href="VonageClient.html#getConversationMember" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Member</span></a>
<a href="VonageClient.html#getConversationMembers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Members</span></a>
<a href="VonageClient.html#getConversations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Conversations</span></a>
<a href="VonageClient.html#inviteToConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>invite<wbr/>To<wbr/>Conversation</span></a>
<a href="VonageClient.html#joinConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>join<wbr/>Conversation</span></a>
<a href="VonageClient.html#leaveConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>leave<wbr/>Conversation</span></a>
<a href="VonageClient.html#sendCustomEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Custom<wbr/>Event</span></a>
<a href="VonageClient.html#sendEphemeralEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Ephemeral<wbr/>Event</span></a>
<a href="VonageClient.html#sendMessageAudioEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Audio<wbr/>Event</span></a>
<a href="VonageClient.html#sendMessageCustomEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Custom<wbr/>Event</span></a>
<a href="VonageClient.html#sendMessageFileEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>File<wbr/>Event</span></a>
<a href="VonageClient.html#sendMessageImageEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Image<wbr/>Event</span></a>
<a href="VonageClient.html#sendMessageLocationEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Location<wbr/>Event</span></a>
<a href="VonageClient.html#sendMessageSeenEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Seen<wbr/>Event</span></a>
<a href="VonageClient.html#sendMessageTemplateEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Template<wbr/>Event</span></a>
<a href="VonageClient.html#sendMessageTextEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Text<wbr/>Event</span></a>
<a href="VonageClient.html#sendMessageVCardEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>MessageVCard<wbr/>Event</span></a>
<a href="VonageClient.html#sendMessageVideoEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Video<wbr/>Event</span></a>
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Voice</h3><div class="tsd-index-list"><a href="VonageClient.html#answer" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>answer</span></a>
<a href="VonageClient.html#disableEarmuff" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>disable<wbr/>Earmuff</span></a>
<a href="VonageClient.html#enableEarmuff" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>enable<wbr/>Earmuff</span></a>
<a href="VonageClient.html#getAudioOutputElement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Audio<wbr/>Output<wbr/>Element</span></a>
<a href="VonageClient.html#getCallLegs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Call<wbr/>Legs</span></a>
<a href="VonageClient.html#getLeg" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Leg</span></a>
<a href="VonageClient.html#getPeerConnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>get<wbr/>Peer<wbr/>Connection</span></a>
<a href="VonageClient.html#hangup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>hangup</span></a>
<a href="VonageClient.html#mute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>mute</span></a>
<a href="VonageClient.html#reconnectCall" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reconnect<wbr/>Call</span></a>
<a href="VonageClient.html#reject" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>reject</span></a>
<a href="VonageClient.html#say" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>say</span></a>
<a href="VonageClient.html#sendDTMF" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>sendDTMF</span></a>
<a href="VonageClient.html#serverCall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>server<wbr/>Call</span></a>
<a href="VonageClient.html#unmute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>unmute</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="clearCallbacks" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>clear<wbr/>Callbacks</span><a href="#clearCallbacks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="clearCallbacks.clearCallbacks-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">clear<wbr/>Callbacks</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#clearCallbacks.clearCallbacks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clear all callbacks for an event.</p>
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"mute"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"conversationEvent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callHangup"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaDisconnect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"legStatusUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rtcStatsUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callInvite"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callInviteCancel"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sessionError"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaError"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callTransfer"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"earmuff"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dtmf"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaReconnecting"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaReconnection"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"reconnecting"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"reconnection"</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5><div class="tsd-comment tsd-typography"><p>the event to unregister from (e.g. 'legStatusUpdate')</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>void</p>
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_ClearCallbacks</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
</code><button>Copy</button></pre>
<h4>Remarks</h4><p>This is useful for cleaning up callbacks when you no longer need them.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="createSession" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Session</span><a href="#createSession" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createSession.createSession-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Session</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span>, <span class="tsd-kind-parameter">sessionId</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#createSession.createSession-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a session with a token and optional sessionId
If no sessionId is provided, a new one will be generated
and returned. If a sessionId is provided, it will be used
to resume an existing session.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"></div></li><li><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">sessionId</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>optional sessionId to use</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>the <code>sessionId</code> of the session</p>
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SessionCreate</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.createSession</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Conversation</span><a href="#getConversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getConversation.getConversation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">conversationIdOrName</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><span class="tsd-signature-symbol">></span><a href="#getConversation.getConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a Conversation</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">conversationIdOrName</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id or conversation name</p>
</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>the <code>Conversation</code></p>
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_GetConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getConversation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="off" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="off.off-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">callbackSymbol</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#off.off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unregister a callback for an event.</p>
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"mute"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"conversationEvent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callHangup"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaDisconnect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"legStatusUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rtcStatsUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callInvite"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callInviteCancel"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sessionError"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaError"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callTransfer"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"earmuff"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dtmf"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaReconnecting"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaReconnection"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"reconnecting"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"reconnection"</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5><div class="tsd-comment tsd-typography"><p>the event to register for (e.g. 'legStatusUpdate')</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">callbackSymbol</span>: <span class="tsd-signature-type">symbol</span></h5><div class="tsd-comment tsd-typography"><p>the callback symbol to unregister</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the callback was unregistered, false otherwise</p>
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_UnregisterListener</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
</code><button>Copy</button></pre>
<h4>Remarks</h4><p>We recommend deregistering callbacks when you no longer need them.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="on.on-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span>, <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">symbol</span><a href="#on.on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Register a callback for an event.</p>
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><h4><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-type">"mute"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"conversationEvent"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callHangup"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaDisconnect"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"legStatusUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"rtcStatsUpdate"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callInvite"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callInviteCancel"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"sessionError"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaError"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callTransfer"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"earmuff"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"dtmf"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaReconnecting"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"callMediaReconnection"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"reconnecting"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"reconnection"</span></h4></li><li><h4><span class="tsd-kind-type-parameter">P</span><span class="tsd-signature-symbol"> extends </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">callQuality</span>, <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">legId</span>, <span class="tsd-kind-parameter">legStatus</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stats</span>, <span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">from</span>, <span class="tsd-kind-parameter">channelType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">legId</span>, <span class="tsd-kind-parameter">isMuted</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">conversationId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">legId</span>, <span class="tsd-kind-parameter">earmuffStatus</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">legId</span>, <span class="tsd-kind-parameter">digits</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></h4></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type tsd-kind-type-parameter">T</span></h5><div class="tsd-comment tsd-typography"><p>the event to register for (e.g. 'legStatusUpdate')</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">callback</span>: <span class="tsd-signature-type tsd-kind-type-parameter">P</span></h5><div class="tsd-comment tsd-typography"><p>the callback to register for the event</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">symbol</span></h4><p>a symbol that can be used to unregister the callback</p>
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_OnConversationEventListener</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
</code><button>Copy</button></pre>
<h4>Remarks</h4><p>Be sure to store the symbol returned by this method so you can unregister the callback later.
We recommend unregistering callbacks when you no longer need them. See <a href="VonageClient.html#off" class="tsd-kind-method">off</a>.</p>
</div></li></ul></section><section class="tsd-panel tsd-member"><a id="setConfig" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Config</span><a href="#setConfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="setConfig.setConfig-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Config</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setConfig.setConfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set a configuration for the client SDK</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">config</span>: <a href="../types/ClientConfigObject.html" class="tsd-signature-type tsd-kind-type-alias">ClientConfigObject</a></h5><div class="tsd-comment tsd-typography"><p>A configuration object</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>void</p>
<div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SetClientConfig</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.setConfig</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="updateConversation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>update<wbr/>Conversation</span><a href="#updateConversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="updateConversation.updateConversation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">update<wbr/>Conversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">conversationId</span>, <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><span class="tsd-signature-symbol">></span><a href="#updateConversation.updateConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates a conversation object identified by its unique conversation ID.</p>
<p>This method overrides the conversation properties to the provided parameters and rest remains as it is.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">conversationId</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>the Conversation's id.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">parameters</span>: <a href="../interfaces/UpdateConversationParameters.html" class="tsd-signature-type tsd-kind-interface">UpdateConversationParameters</a></h5><div class="tsd-comment tsd-typography"><p>The properties of the conversation. These will replace existing values to the provided ones, rest will remain as they are.</p>
</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>
<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>
</code><button>Copy</button></pre>
</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>
</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>
</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>
<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>
</code><button>Copy</button></pre>
</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>
</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>
</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>
<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>
</code><button>Copy</button></pre>
</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>
</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>
</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>
</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>
<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>
</code><button>Copy</button></pre>
</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="getConversationEv