@vonage/client-sdk 2.6.1 → 2.6.2-snapshot.20260820113314

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.
Files changed (111) hide show
  1. package/api_docs/ts/assets/hierarchy.js +1 -0
  2. package/api_docs/ts/assets/highlight.css +1 -1
  3. package/api_docs/ts/assets/icons.js +17 -14
  4. package/api_docs/ts/assets/icons.svg +1 -1
  5. package/api_docs/ts/assets/main.js +5 -4
  6. package/api_docs/ts/assets/navigation.js +1 -1
  7. package/api_docs/ts/assets/search.js +1 -1
  8. package/api_docs/ts/assets/style.css +1460 -1224
  9. package/api_docs/ts/classes/ClientConfig.html +207 -16
  10. package/api_docs/ts/classes/ClientInitConfig.html +130 -14
  11. package/api_docs/ts/classes/VonageClient.html +1697 -335
  12. package/api_docs/ts/enums/CallDisconnectReason.html +54 -3
  13. package/api_docs/ts/enums/CancelReason.html +66 -6
  14. package/api_docs/ts/enums/HangupReason.html +70 -7
  15. package/api_docs/ts/enums/LegStatus.html +62 -5
  16. package/api_docs/ts/enums/LoggingLevel.html +74 -8
  17. package/api_docs/ts/enums/MemberChannelType.html +94 -13
  18. package/api_docs/ts/enums/OrderBy.html +58 -2
  19. package/api_docs/ts/enums/PresentingOrder.html +62 -8
  20. package/api_docs/ts/enums/SessionErrorReason.html +62 -5
  21. package/api_docs/ts/enums/VoiceChannelType.html +66 -6
  22. package/api_docs/ts/enums/VonageErrorType.html +70 -7
  23. package/api_docs/ts/functions/none.html +42 -2
  24. package/api_docs/ts/functions/some.html +48 -3
  25. package/api_docs/ts/hierarchy.html +30 -0
  26. package/api_docs/ts/index.html +102 -26
  27. package/api_docs/ts/interfaces/CallSayParams.html +75 -8
  28. package/api_docs/ts/interfaces/Channel.html +67 -6
  29. package/api_docs/ts/interfaces/Conversation.html +127 -20
  30. package/api_docs/ts/interfaces/ConversationProperties.html +75 -8
  31. package/api_docs/ts/interfaces/ConversationTimestamp.html +75 -5
  32. package/api_docs/ts/interfaces/ConversationsPage.html +81 -8
  33. package/api_docs/ts/interfaces/CreateConversationParameters.html +88 -15
  34. package/api_docs/ts/interfaces/EmergencyCallData.html +67 -6
  35. package/api_docs/ts/interfaces/EmergencyCallOptions.html +57 -4
  36. package/api_docs/ts/interfaces/EphemeralConversationEvent.html +81 -12
  37. package/api_docs/ts/interfaces/EventsPage.html +81 -8
  38. package/api_docs/ts/interfaces/GetCallLegsParameters.html +69 -8
  39. package/api_docs/ts/interfaces/GetConversationEventsParameters.html +87 -14
  40. package/api_docs/ts/interfaces/GetConversationMembersParameters.html +69 -8
  41. package/api_docs/ts/interfaces/GetConversationsParameters.html +81 -12
  42. package/api_docs/ts/interfaces/Leg.html +131 -21
  43. package/api_docs/ts/interfaces/LegChannel.html +75 -8
  44. package/api_docs/ts/interfaces/LegsPage.html +81 -8
  45. package/api_docs/ts/interfaces/Location.html +67 -6
  46. package/api_docs/ts/interfaces/Member.html +81 -12
  47. package/api_docs/ts/interfaces/MemberChannel.html +69 -8
  48. package/api_docs/ts/interfaces/MemberEventBody.html +75 -7
  49. package/api_docs/ts/interfaces/MemberTimestamp.html +75 -5
  50. package/api_docs/ts/interfaces/MembersPage.html +81 -8
  51. package/api_docs/ts/interfaces/MessageAudioEventBody.html +67 -5
  52. package/api_docs/ts/interfaces/MessageCustomEventBody.html +67 -5
  53. package/api_docs/ts/interfaces/MessageFileEventBody.html +67 -6
  54. package/api_docs/ts/interfaces/MessageImageEventBody.html +67 -6
  55. package/api_docs/ts/interfaces/MessageLocationEventBody.html +67 -6
  56. package/api_docs/ts/interfaces/MessageTemplateEventBody.html +93 -9
  57. package/api_docs/ts/interfaces/MessageTextEventBody.html +67 -6
  58. package/api_docs/ts/interfaces/MessageVCardEventBody.html +67 -6
  59. package/api_docs/ts/interfaces/MessageVideoEventBody.html +67 -6
  60. package/api_docs/ts/interfaces/RTCQuality.html +123 -11
  61. package/api_docs/ts/interfaces/RtcStats.html +179 -18
  62. package/api_docs/ts/interfaces/Template.html +59 -4
  63. package/api_docs/ts/interfaces/UpdateConversationParameters.html +87 -14
  64. package/api_docs/ts/interfaces/User.html +107 -16
  65. package/api_docs/ts/interfaces/UserChannels.html +139 -13
  66. package/api_docs/ts/interfaces/UserTimestamp.html +75 -5
  67. package/api_docs/ts/interfaces/VonageError.html +89 -12
  68. package/api_docs/ts/interfaces/VonageEvent.html +131 -22
  69. package/api_docs/ts/interfaces/Whatsapp.html +59 -4
  70. package/api_docs/ts/modules.html +69 -74
  71. package/api_docs/ts/types/ClientConfigObject.html +52 -5
  72. package/api_docs/ts/types/ClientInitConfigObject.html +59 -4
  73. package/api_docs/ts/types/ConfigRegion.html +34 -2
  74. package/api_docs/ts/types/ConversationEvent.html +34 -2
  75. package/api_docs/ts/types/CustomData.html +34 -2
  76. package/api_docs/ts/types/Json.html +34 -2
  77. package/api_docs/ts/types/JsonValue.html +34 -2
  78. package/api_docs/ts/types/MemberStatus.html +34 -2
  79. package/api_docs/ts/types/Option.html +38 -2
  80. package/api_docs/ts/types/PersistentConversationEvent.html +34 -2
  81. package/api_docs/ts/types/Topics.html +34 -2
  82. package/api_docs/ts/types/VonageLogger.html +59 -4
  83. package/api_docs/ts/variables/Topics.html +34 -0
  84. package/api_docs/ts/variables/VonageError.html +38 -0
  85. package/dist/client/VonageClient.d.ts +704 -704
  86. package/dist/client/index.cjs +45072 -36319
  87. package/dist/client/index.d.ts +2 -2
  88. package/dist/client/index.mjs +44700 -35947
  89. package/dist/coreExtend.d.ts +107 -107
  90. package/dist/kotlin/JsUnions.d.ts +443 -443
  91. package/dist/kotlin/clientsdk-clientcore_js.d.ts +724 -145
  92. package/dist/utils/ClientConfig.d.ts +104 -104
  93. package/dist/utils/ConversationEventBodies.d.ts +125 -125
  94. package/dist/utils/ConversationModels.d.ts +170 -170
  95. package/dist/utils/Enums.d.ts +56 -56
  96. package/dist/utils/ErrorModels.d.ts +23 -23
  97. package/dist/utils/JsonUtils.d.ts +15 -15
  98. package/dist/utils/Option.d.ts +19 -19
  99. package/dist/utils/RequestParameterModels.d.ts +134 -134
  100. package/dist/utils/index.d.ts +10 -10
  101. package/dist/utils/jsEnumToVonageObject.d.ts +10 -10
  102. package/dist/utils/logging.d.ts +53 -53
  103. package/dist/utils/vonage.d.ts +2 -2
  104. package/dist/vonageClientSDK.js +44299 -35558
  105. package/dist/vonageClientSDK.min.js +25 -25
  106. package/dist/vonageClientSDK.min.mjs +26 -26
  107. package/dist/vonageClientSDK.mjs +44299 -35558
  108. package/package.json +6 -6
  109. package/typedoc.json +3 -0
  110. package/api_docs/ts/variables/Topics-1.html +0 -2
  111. package/api_docs/ts/variables/VonageError-1.html +0 -3
package/api_docs/ts/classes/VonageClient.html CHANGED
@@ -1,69 +1,152 @@
1
- <!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/icons.js" id="tsd-icons-script"></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";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</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="../assets/icons.svg#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="../assets/icons.svg#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>
2
- </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="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Accessors</h3><div class="tsd-index-list"><a href="VonageClient.html#emergencyCore" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>emergency<wbr/>Core</span></a>
3
- </div></section><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="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Callbacks</span></a>
4
- <a href="VonageClient.html#createSession" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Session</span></a>
5
- <a href="VonageClient.html#getConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation</span></a>
6
- <a href="VonageClient.html#off" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a>
7
- <a href="VonageClient.html#on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a>
8
- <a href="VonageClient.html#setConfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Config</span></a>
9
- <a href="VonageClient.html#updateConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Conversation</span></a>
10
- </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="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Conversation</span></a>
11
- <a href="VonageClient.html#deleteConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Conversation</span></a>
12
- <a href="VonageClient.html#deleteEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Event</span></a>
13
- <a href="VonageClient.html#getConversationEvents" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Events</span></a>
14
- <a href="VonageClient.html#getConversationMember" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Member</span></a>
15
- <a href="VonageClient.html#getConversationMembers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Members</span></a>
16
- <a href="VonageClient.html#getConversations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversations</span></a>
17
- <a href="VonageClient.html#inviteToConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>invite<wbr/>To<wbr/>Conversation</span></a>
18
- <a href="VonageClient.html#joinConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>join<wbr/>Conversation</span></a>
19
- <a href="VonageClient.html#leaveConversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Conversation</span></a>
20
- <a href="VonageClient.html#sendCustomEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Custom<wbr/>Event</span></a>
21
- <a href="VonageClient.html#sendEphemeralEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Ephemeral<wbr/>Event</span></a>
22
- <a href="VonageClient.html#sendMessageAudioEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Audio<wbr/>Event</span></a>
23
- <a href="VonageClient.html#sendMessageCustomEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Custom<wbr/>Event</span></a>
24
- <a href="VonageClient.html#sendMessageFileEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>File<wbr/>Event</span></a>
25
- <a href="VonageClient.html#sendMessageImageEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Image<wbr/>Event</span></a>
26
- <a href="VonageClient.html#sendMessageLocationEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Location<wbr/>Event</span></a>
27
- <a href="VonageClient.html#sendMessageSeenEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Seen<wbr/>Event</span></a>
28
- <a href="VonageClient.html#sendMessageTemplateEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Template<wbr/>Event</span></a>
29
- <a href="VonageClient.html#sendMessageTextEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Text<wbr/>Event</span></a>
30
- <a href="VonageClient.html#sendMessageVCardEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>MessageVCard<wbr/>Event</span></a>
31
- <a href="VonageClient.html#sendMessageVideoEvent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Video<wbr/>Event</span></a>
32
- </div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Emergency</h3><div class="tsd-index-list"><a href="VonageClient.html#disableEarmuffEmergencyCall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span></a>
33
- <a href="VonageClient.html#emergencyCall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emergency<wbr/>Call</span></a>
34
- <a href="VonageClient.html#enableEarmuffEmergencyCall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span></a>
35
- <a href="VonageClient.html#hangupEmergencyCall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hangup<wbr/>Emergency<wbr/>Call</span></a>
36
- <a href="VonageClient.html#muteEmergencyCall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute<wbr/>Emergency<wbr/>Call</span></a>
37
- <a href="VonageClient.html#reconnectEmergencyCall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconnect<wbr/>Emergency<wbr/>Call</span></a>
38
- <a href="VonageClient.html#unmuteEmergencyCall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute<wbr/>Emergency<wbr/>Call</span></a>
39
- </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="../assets/icons.svg#icon-2048"></use></svg><span>answer</span></a>
40
- <a href="VonageClient.html#disableAutoGainControl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Auto<wbr/>Gain<wbr/>Control</span></a>
41
- <a href="VonageClient.html#disableEarmuff" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Earmuff</span></a>
42
- <a href="VonageClient.html#disableEchoCancellation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Echo<wbr/>Cancellation</span></a>
43
- <a href="VonageClient.html#disableNoiseSuppression" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Noise<wbr/>Suppression</span></a>
44
- <a href="VonageClient.html#enableAutoGainControl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Auto<wbr/>Gain<wbr/>Control</span></a>
45
- <a href="VonageClient.html#enableEarmuff" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Earmuff</span></a>
46
- <a href="VonageClient.html#enableEchoCancellation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Echo<wbr/>Cancellation</span></a>
47
- <a href="VonageClient.html#enableNoiseSuppression" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Noise<wbr/>Suppression</span></a>
48
- <a href="VonageClient.html#getAudioOutputElement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Audio<wbr/>Output<wbr/>Element</span></a>
49
- <a href="VonageClient.html#getCallLegs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Call<wbr/>Legs</span></a>
50
- <a href="VonageClient.html#getLeg" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Leg</span></a>
51
- <a href="VonageClient.html#getPeerConnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peer<wbr/>Connection</span></a>
52
- <a href="VonageClient.html#hangup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hangup</span></a>
53
- <a href="VonageClient.html#mute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute</span></a>
54
- <a href="VonageClient.html#reconnectCall" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconnect<wbr/>Call</span></a>
55
- <a href="VonageClient.html#reject" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reject</span></a>
56
- <a href="VonageClient.html#say" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>say</span></a>
57
- <a href="VonageClient.html#sendDTMF" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sendDTMF</span></a>
58
- <a href="VonageClient.html#serverCall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>server<wbr/>Call</span></a>
59
- <a href="VonageClient.html#unmute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute</span></a>
60
- </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="emergencyCore" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emergency<wbr/>Core</span><a href="#emergencyCore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature" id="emergencyCore.emergencyCore-1"><span class="tsd-signature-keyword">get</span> emergencyCore<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.emergencyCore</p></aside></li></ul></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="../assets/icons.svg#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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="VonageClient.html#clearCallbacks.clearCallbacks-1.T">T</a><span class="tsd-signature-symbol">&gt;</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="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clear all callbacks for an event.</p>
61
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="clearCallbacks.clearCallbacks-1.T" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;mute&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;conversationEvent&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callHangup&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaDisconnect&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;legStatusUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;rtcStatsUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callInvite&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callInviteCancel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;sessionError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;emergencyCallDisconnected&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;emergencyCallHangup&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callTransfer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;earmuff&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dtmf&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaReconnecting&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaReconnection&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;reconnecting&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;reconnection&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;peerConnectionCreated&quot;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="VonageClient.html#clearCallbacks.clearCallbacks-1.T">T</a></span><div class="tsd-comment tsd-typography"><p>the event to unregister from (e.g. &#39;legStatusUpdate&#39;)</p>
62
- </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>
63
- <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>
64
- </code><button>Copy</button></pre>
65
- <h4>Remarks</h4><p>This is useful for cleaning up callbacks when you no longer need them.</p>
66
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#createSession.createSession-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create (or reconnect to) a session.</p>
1
+ <!DOCTYPE html><html class="default" lang="en" data-base="../"><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/icons.js" id="tsd-icons-script"></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";document.body.style.display="none";setTimeout(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar">
2
+ <div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@vonage/client-sdk - v0.0.0</a>
3
+ <div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/>
4
+ <ul role="listbox" id="tsd-search-results"></ul>
5
+ <div id="tsd-search-status" aria-live="polite" aria-atomic="true">
6
+ <div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header>
7
+ <div class="container container-main">
8
+ <div class="col-content">
9
+ <div class="tsd-page-title">
10
+ <ul class="tsd-breadcrumb" aria-label="Breadcrumb">
11
+ <li><a href="" aria-current="page">VonageClient</a></li></ul>
12
+ <h1>Class VonageClient</h1></div>
13
+ <section class="tsd-panel tsd-comment">
14
+ <div class="tsd-comment tsd-typography"><p>VonageClient is the main entry point for the Vonage Client SDK.</p>
15
+ </div></section>
16
+ <section class="tsd-panel tsd-hierarchy" data-refl="235">
17
+ <h4>Hierarchy</h4>
18
+ <ul class="tsd-hierarchy">
19
+ <li class="tsd-hierarchy-item"><span class="tsd-signature-type">CombinedClientJS</span>
20
+ <ul class="tsd-hierarchy">
21
+ <li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">VonageClient</span></li></ul></li></ul></section>
22
+ <section class="tsd-panel-group tsd-index-group">
23
+ <section class="tsd-panel tsd-index-panel">
24
+ <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
25
+ <h5 class="tsd-index-heading uppercase">Index</h5></summary>
26
+ <div class="tsd-accordion-details">
27
+ <section class="tsd-index-section">
28
+ <h3 class="tsd-index-heading tsd-anchor-link" id="accessors">Accessors<a href="#accessors" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
29
+ <div class="tsd-index-list"><a href="#emergencycore" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>emergency<wbr/>Core</span></a>
30
+ </div></section>
31
+ <section class="tsd-index-section">
32
+ <h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
33
+ <div class="tsd-index-list"><a href="#clearcallbacks" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Callbacks</span></a>
34
+ <a href="#createsession" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Session</span></a>
35
+ <a href="#getconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation</span></a>
36
+ <a href="#off" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a>
37
+ <a href="#on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a>
38
+ <a href="#setconfig" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Config</span></a>
39
+ <a href="#updateconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Conversation</span></a>
40
+ </div></section>
41
+ <section class="tsd-index-section">
42
+ <h3 class="tsd-index-heading tsd-anchor-link" id="chat">Chat<a href="#chat" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
43
+ <div class="tsd-index-list"><a href="#createconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Conversation</span></a>
44
+ <a href="#deleteconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Conversation</span></a>
45
+ <a href="#deleteevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Event</span></a>
46
+ <a href="#getconversationevents" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Events</span></a>
47
+ <a href="#getconversationmember" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Member</span></a>
48
+ <a href="#getconversationmembers" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Members</span></a>
49
+ <a href="#getconversations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversations</span></a>
50
+ <a href="#invitetoconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>invite<wbr/>To<wbr/>Conversation</span></a>
51
+ <a href="#joinconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>join<wbr/>Conversation</span></a>
52
+ <a href="#leaveconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Conversation</span></a>
53
+ <a href="#sendcustomevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Custom<wbr/>Event</span></a>
54
+ <a href="#sendephemeralevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Ephemeral<wbr/>Event</span></a>
55
+ <a href="#sendmessageaudioevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Audio<wbr/>Event</span></a>
56
+ <a href="#sendmessagecustomevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Custom<wbr/>Event</span></a>
57
+ <a href="#sendmessagefileevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>File<wbr/>Event</span></a>
58
+ <a href="#sendmessageimageevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Image<wbr/>Event</span></a>
59
+ <a href="#sendmessagelocationevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Location<wbr/>Event</span></a>
60
+ <a href="#sendmessageseenevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Seen<wbr/>Event</span></a>
61
+ <a href="#sendmessagetemplateevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Template<wbr/>Event</span></a>
62
+ <a href="#sendmessagetextevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Text<wbr/>Event</span></a>
63
+ <a href="#sendmessagevcardevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>V<wbr/>Card<wbr/>Event</span></a>
64
+ <a href="#sendmessagevideoevent" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Video<wbr/>Event</span></a>
65
+ </div></section>
66
+ <section class="tsd-index-section">
67
+ <h3 class="tsd-index-heading tsd-anchor-link" id="emergency">Emergency<a href="#emergency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
68
+ <div class="tsd-index-list"><a href="#disableearmuffemergencycall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span></a>
69
+ <a href="#emergencycall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emergency<wbr/>Call</span></a>
70
+ <a href="#enableearmuffemergencycall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span></a>
71
+ <a href="#hangupemergencycall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hangup<wbr/>Emergency<wbr/>Call</span></a>
72
+ <a href="#muteemergencycall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute<wbr/>Emergency<wbr/>Call</span></a>
73
+ <a href="#reconnectemergencycall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconnect<wbr/>Emergency<wbr/>Call</span></a>
74
+ <a href="#unmuteemergencycall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute<wbr/>Emergency<wbr/>Call</span></a>
75
+ </div></section>
76
+ <section class="tsd-index-section">
77
+ <h3 class="tsd-index-heading tsd-anchor-link" id="voice">Voice<a href="#voice" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
78
+ <div class="tsd-index-list"><a href="#answer" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>answer</span></a>
79
+ <a href="#disableautogaincontrol" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Auto<wbr/>Gain<wbr/>Control</span></a>
80
+ <a href="#disableearmuff" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Earmuff</span></a>
81
+ <a href="#disableechocancellation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Echo<wbr/>Cancellation</span></a>
82
+ <a href="#disablenoisesuppression" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Noise<wbr/>Suppression</span></a>
83
+ <a href="#enableautogaincontrol" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Auto<wbr/>Gain<wbr/>Control</span></a>
84
+ <a href="#enableearmuff" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Earmuff</span></a>
85
+ <a href="#enableechocancellation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Echo<wbr/>Cancellation</span></a>
86
+ <a href="#enablenoisesuppression" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Noise<wbr/>Suppression</span></a>
87
+ <a href="#getaudiooutputelement" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Audio<wbr/>Output<wbr/>Element</span></a>
88
+ <a href="#getcalllegs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Call<wbr/>Legs</span></a>
89
+ <a href="#getleg" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Leg</span></a>
90
+ <a href="#getpeerconnection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peer<wbr/>Connection</span></a>
91
+ <a href="#hangup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hangup</span></a>
92
+ <a href="#mute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute</span></a>
93
+ <a href="#reconnectcall" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconnect<wbr/>Call</span></a>
94
+ <a href="#reject" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reject</span></a>
95
+ <a href="#say" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>say</span></a>
96
+ <a href="#senddtmf" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>DTMF</span></a>
97
+ <a href="#servercall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>server<wbr/>Call</span></a>
98
+ <a href="#unmute" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute</span></a>
99
+ </div></section></div></details></section></section>
100
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
101
+ <h2 class="tsd-anchor-link" id="accessors-1">Accessors<a href="#accessors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
102
+ <section>
103
+ <section class="tsd-panel tsd-member tsd-is-inherited">
104
+ <h3 class="tsd-anchor-link" id="emergencycore"><span>emergency<wbr/>Core</span><a href="#emergencycore" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
105
+ <ul class="tsd-signatures tsd-is-inherited">
106
+ <li>
107
+ <div class="tsd-signature" id="emergencycoreemergencycore"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">emergencyCore</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
108
+ <div class="tsd-description">
109
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4><aside class="tsd-sources">
110
+ <p>Inherited from vonage.CombinedClientJS.emergencyCore</p></aside></div></li></ul></section></section></details>
111
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
112
+ <h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
113
+ <section>
114
+ <section class="tsd-panel tsd-member">
115
+ <h3 class="tsd-anchor-link" id="clearcallbacks"><span>clear<wbr/>Callbacks</span><a href="#clearcallbacks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
116
+ <ul class="tsd-signatures">
117
+ <li class="">
118
+ <div class="tsd-signature tsd-anchor-link" id="clearcallbacks-1"><span class="tsd-kind-call-signature">clearCallbacks</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#clearcallbackst">T</a> <span class="tsd-signature-keyword">extends</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;mute&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;conversationEvent&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callHangup&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaDisconnect&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;legStatusUpdate&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;rtcStatsUpdate&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInvite&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInviteCancel&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;sessionError&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaError&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallDisconnected&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallHangup&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callTransfer&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;earmuff&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;dtmf&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnecting&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnection&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnecting&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnection&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;peerConnectionCreated&quot;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#clearcallbackst">T</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#clearcallbacks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
119
+ <div class="tsd-description">
120
+ <div class="tsd-comment tsd-typography"><p>Clear all callbacks for an event.</p>
121
+ </div>
122
+ <section class="tsd-panel">
123
+ <h4>Type Parameters</h4>
124
+ <ul class="tsd-type-parameter-list">
125
+ <li><span id="clearcallbackst"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;mute&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;conversationEvent&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callHangup&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaDisconnect&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;legStatusUpdate&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;rtcStatsUpdate&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInvite&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInviteCancel&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;sessionError&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaError&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallDisconnected&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallHangup&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callTransfer&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;earmuff&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;dtmf&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnecting&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnection&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnecting&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnection&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;peerConnectionCreated&quot;</span></span></li></ul></section>
126
+ <div class="tsd-parameters">
127
+ <h4 class="tsd-parameters-title">Parameters</h4>
128
+ <ul class="tsd-parameter-list">
129
+ <li><span><span class="tsd-kind-parameter">event</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#clearcallbackst">T</a></span>
130
+ <div class="tsd-comment tsd-typography"><p>the event to unregister from (e.g. 'legStatusUpdate')</p>
131
+ </div></li></ul></div>
132
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>void</p>
133
+
134
+ <div class="tsd-comment tsd-typography">
135
+ <div class="tsd-tag-example">
136
+ <h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">client.clearCallbacks(&#39;sessionError&#39;);
137
+ </code><button type="button">Copy</button></pre>
138
+
139
+ </div>
140
+ <div class="tsd-tag-remarks">
141
+ <h4 class="tsd-anchor-link" id="remarks">Remarks<a href="#remarks" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>This is useful for cleaning up callbacks when you no longer need them.</p>
142
+ </div></div></div></li></ul></section>
143
+ <section class="tsd-panel tsd-member">
144
+ <h3 class="tsd-anchor-link" id="createsession"><span>create<wbr/>Session</span><a href="#createsession" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
145
+ <ul class="tsd-signatures">
146
+ <li class="">
147
+ <div class="tsd-signature tsd-anchor-link" id="createsession-1"><span class="tsd-kind-call-signature">createSession</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">sessionId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#createsession-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
148
+ <div class="tsd-description">
149
+ <div class="tsd-comment tsd-typography"><p>Create (or reconnect to) a session.</p>
67
150
  <p>When <code>sessionId</code> is omitted or <code>null</code>, a completely new session is created.</p>
68
151
  <p>When <code>sessionId</code> is set to the value returned by a <strong>previous</strong> <code>createSession</code> call, the
69
152
  Conversation Service will replay any pending events into the new session. In particular, an
@@ -71,275 +154,1554 @@ unanswered inbound call invite that arrived before a page refresh will be re-del
71
154
  <code>onCallInvite</code> fires automatically — no extra API call is needed.</p>
72
155
  <p><strong>Important:</strong> The Conversation Service retains pending events for approximately 30 seconds.
73
156
  Persist the session ID (e.g. in <code>sessionStorage</code>) and pass it back within that window.</p>
74
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>JWT token of the user.</p>
75
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><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></span><div class="tsd-comment tsd-typography"><p>Optional previous session ID. Omit or pass <code>null</code> for a fresh session.</p>
76
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The <code>sessionId</code> of the newly established session.</p>
77
- <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>
78
- </code><button>Copy</button></pre>
79
- </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="../assets/icons.svg#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">&lt;</span><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><span class="tsd-signature-symbol">&gt;</span><a href="#getConversation.getConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a Conversation</p>
80
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">conversationIdOrName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id or conversation name</p>
81
- </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">&lt;</span><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>Conversation</code></p>
82
- <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>
83
- </code><button>Copy</button></pre>
84
- </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="../assets/icons.svg#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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="VonageClient.html#off.off-1.T-1">T</a><span class="tsd-signature-symbol">&gt;</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="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unregister a callback for an event.</p>
85
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="off.off-1.T-1" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;mute&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;conversationEvent&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callHangup&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaDisconnect&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;legStatusUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;rtcStatsUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callInvite&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callInviteCancel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;sessionError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;emergencyCallDisconnected&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;emergencyCallHangup&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callTransfer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;earmuff&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dtmf&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaReconnecting&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaReconnection&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;reconnecting&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;reconnection&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;peerConnectionCreated&quot;</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="VonageClient.html#off.off-1.T-1">T</a></span><div class="tsd-comment tsd-typography"><p>the event to register for (e.g. &#39;legStatusUpdate&#39;)</p>
86
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callbackSymbol</span>: <span class="tsd-signature-type">symbol</span></span><div class="tsd-comment tsd-typography"><p>the callback symbol to unregister</p>
87
- </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>
88
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_UnregisterListener</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
89
- </code><button>Copy</button></pre>
90
- <h4>Remarks</h4><p>We recommend deregistering callbacks when you no longer need them.</p>
91
- </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="../assets/icons.svg#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">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="VonageClient.html#on.on-1.T-2">T</a><span class="tsd-signature-symbol">, </span><a class="tsd-signature-type tsd-kind-type-parameter" href="VonageClient.html#on.on-1.P">P</a><span class="tsd-signature-symbol">&gt;</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="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Register a callback for an event.</p>
92
- </div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="on.on-1.T-2" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><span class="tsd-signature-type">&quot;mute&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;conversationEvent&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callHangup&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaDisconnect&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;legStatusUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;rtcStatsUpdate&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callInvite&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callInviteCancel&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;sessionError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaError&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;emergencyCallDisconnected&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;emergencyCallHangup&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callTransfer&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;earmuff&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;dtmf&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaReconnecting&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callMediaReconnection&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;reconnecting&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;reconnection&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;peerConnectionCreated&quot;</span></span></li><li><span><a id="on.on-1.P" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">P</span><span class="tsd-signature-keyword"> 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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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">pc</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </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"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">event</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="VonageClient.html#on.on-1.T-2">T</a></span><div class="tsd-comment tsd-typography"><p>the event to register for (e.g. &#39;legStatusUpdate&#39;)</p>
93
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="VonageClient.html#on.on-1.P">P</a></span><div class="tsd-comment tsd-typography"><p>the callback to register for the event</p>
94
- </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>
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_OnConversationEventListener</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
96
- </code><button>Copy</button></pre>
97
- <h4>Remarks</h4><p>Be sure to store the symbol returned by this method so you can unregister the callback later.
98
- We recommend unregistering callbacks when you no longer need them. See <a href="VonageClient.html#off" class="tsd-kind-method">off</a>.</p>
99
- </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="../assets/icons.svg#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="../assets/icons.svg#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>
100
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">config</span>: <a href="../types/ClientConfigObject.html" class="tsd-signature-type tsd-kind-type-alias">ClientConfigObject</a></span><div class="tsd-comment tsd-typography"><p>A configuration object</p>
101
- </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>
102
- <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_Config</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
103
- </code><button>Copy</button></pre>
104
- </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="../assets/icons.svg#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">&lt;</span><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><span class="tsd-signature-symbol">&gt;</span><a href="#updateConversation.updateConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
157
+ </div>
158
+ <div class="tsd-parameters">
159
+ <h4 class="tsd-parameters-title">Parameters</h4>
160
+ <ul class="tsd-parameter-list">
161
+ <li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></span>
162
+ <div class="tsd-comment tsd-typography"><p>JWT token of the user.</p>
163
+ </div></li>
164
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">sessionId</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span></span>
165
+ <div class="tsd-comment tsd-typography"><p>Optional previous session ID. Omit or pass <code>null</code> for a fresh session.</p>
166
+ </div></li></ul></div>
167
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>The <code>sessionId</code> of the newly established session.</p>
168
+
169
+ <div class="tsd-comment tsd-typography">
170
+ <div class="tsd-tag-example">
171
+ <h4 class="tsd-anchor-link" id="example-1">Example<a href="#example-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const token = &#39;token&#39;;
172
+
173
+ try {
174
+ const sessionId: string = await client.createSession(token);
175
+ console.log({ sessionId });
176
+ } catch (e) {
177
+ console.log({ e });
178
+ }
179
+ </code><button type="button">Copy</button></pre>
180
+
181
+ </div></div><aside class="tsd-sources">
182
+ <p>Overrides vonage.CombinedClientJS.createSession</p></aside></div></li></ul></section>
183
+ <section class="tsd-panel tsd-member">
184
+ <h3 class="tsd-anchor-link" id="getconversation"><span>get<wbr/>Conversation</span><a href="#getconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
185
+ <ul class="tsd-signatures">
186
+ <li class="">
187
+ <div class="tsd-signature tsd-anchor-link" id="getconversation-1"><span class="tsd-kind-call-signature">getConversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">conversationIdOrName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><span class="tsd-signature-symbol">&gt;</span><a href="#getconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
188
+ <div class="tsd-description">
189
+ <div class="tsd-comment tsd-typography"><p>Get a Conversation</p>
190
+ </div>
191
+ <div class="tsd-parameters">
192
+ <h4 class="tsd-parameters-title">Parameters</h4>
193
+ <ul class="tsd-parameter-list">
194
+ <li><span><span class="tsd-kind-parameter">conversationIdOrName</span>: <span class="tsd-signature-type">string</span></span>
195
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id or conversation name</p>
196
+ </div></li></ul></div>
197
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>Conversation</code></p>
198
+
199
+ <div class="tsd-comment tsd-typography">
200
+ <div class="tsd-tag-example">
201
+ <h4 class="tsd-anchor-link" id="example-2">Example<a href="#example-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">try {
202
+ const conversation: Conversation = await client.getConversation(
203
+ &#39;conversationIdOrName&#39;
204
+ );
205
+ console.log({ conversation });
206
+ } catch (e) {
207
+ console.log({ e });
208
+ }
209
+ </code><button type="button">Copy</button></pre>
210
+
211
+ </div></div><aside class="tsd-sources">
212
+ <p>Overrides vonage.CombinedClientJS.getConversation</p></aside></div></li></ul></section>
213
+ <section class="tsd-panel tsd-member">
214
+ <h3 class="tsd-anchor-link" id="off"><span>off</span><a href="#off" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
215
+ <ul class="tsd-signatures">
216
+ <li class="">
217
+ <div class="tsd-signature tsd-anchor-link" id="off-1"><span class="tsd-kind-call-signature">off</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#offt">T</a> <span class="tsd-signature-keyword">extends</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;mute&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;conversationEvent&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callHangup&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaDisconnect&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;legStatusUpdate&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;rtcStatsUpdate&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInvite&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInviteCancel&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;sessionError&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaError&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallDisconnected&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallHangup&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callTransfer&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;earmuff&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;dtmf&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnecting&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnection&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnecting&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnection&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;peerConnectionCreated&quot;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#offt">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">callbackSymbol</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">symbol</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><a href="#off-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
218
+ <div class="tsd-description">
219
+ <div class="tsd-comment tsd-typography"><p>Unregister a callback for an event.</p>
220
+ </div>
221
+ <section class="tsd-panel">
222
+ <h4>Type Parameters</h4>
223
+ <ul class="tsd-type-parameter-list">
224
+ <li><span id="offt"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;mute&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;conversationEvent&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callHangup&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaDisconnect&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;legStatusUpdate&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;rtcStatsUpdate&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInvite&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInviteCancel&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;sessionError&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaError&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallDisconnected&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallHangup&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callTransfer&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;earmuff&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;dtmf&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnecting&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnection&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnecting&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnection&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;peerConnectionCreated&quot;</span></span></li></ul></section>
225
+ <div class="tsd-parameters">
226
+ <h4 class="tsd-parameters-title">Parameters</h4>
227
+ <ul class="tsd-parameter-list">
228
+ <li><span><span class="tsd-kind-parameter">event</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#offt">T</a></span>
229
+ <div class="tsd-comment tsd-typography"><p>the event to register for (e.g. 'legStatusUpdate')</p>
230
+ </div></li>
231
+ <li><span><span class="tsd-kind-parameter">callbackSymbol</span>: <span class="tsd-signature-type">symbol</span></span>
232
+ <div class="tsd-comment tsd-typography"><p>the callback symbol to unregister</p>
233
+ </div></li></ul></div>
234
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><p>true if the callback was unregistered, false otherwise</p>
235
+
236
+ <div class="tsd-comment tsd-typography">
237
+ <div class="tsd-tag-example">
238
+ <h4 class="tsd-anchor-link" id="example-3">Example<a href="#example-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">client.off(&#39;reconnecting&#39;, reeconnectingListener);
239
+ client.off(&#39;reconnection&#39;, reeconnectionListener);
240
+ client.off(&#39;sessionError&#39;, sessionErrorListener);
241
+ </code><button type="button">Copy</button></pre>
242
+
243
+ </div>
244
+ <div class="tsd-tag-remarks">
245
+ <h4 class="tsd-anchor-link" id="remarks-1">Remarks<a href="#remarks-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>We recommend deregistering callbacks when you no longer need them.</p>
246
+ </div></div></div></li></ul></section>
247
+ <section class="tsd-panel tsd-member">
248
+ <h3 class="tsd-anchor-link" id="on"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
249
+ <ul class="tsd-signatures">
250
+ <li class="">
251
+ <div class="tsd-signature tsd-anchor-link" id="on-1"><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol">&lt;</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#ont">T</a> <span class="tsd-signature-keyword">extends</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;mute&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;conversationEvent&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callHangup&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaDisconnect&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;legStatusUpdate&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;rtcStatsUpdate&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInvite&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInviteCancel&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;sessionError&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaError&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallDisconnected&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallHangup&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callTransfer&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;earmuff&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;dtmf&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnecting&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnection&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnecting&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnection&quot;</span><br/>        <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;peerConnectionCreated&quot;</span><span class="tsd-signature-symbol">,</span><br/>    <a class="tsd-signature-type tsd-kind-type-parameter" href="#onp">P</a> <span class="tsd-signature-keyword">extends</span><br/>        <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> <a href="../types/ConversationEvent.html" class="tsd-signature-type tsd-kind-type-alias">ConversationEvent</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <span class="tsd-signature-symbol">|</span> (<br/>            <span class="tsd-signature-symbol">(</span><br/>                <span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>                <span class="tsd-kind-parameter">callQuality</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RTCQualityJS</span><span class="tsd-signature-symbol">,</span><br/>                <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">:</span> <a href="../enums/HangupReason.html" class="tsd-signature-type tsd-kind-enum">HangupReason</a><span class="tsd-signature-symbol">,</span><br/>            <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><br/>        )<br/>        <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;networkChange&quot;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">legStatus</span><span class="tsd-signature-symbol">:</span> <a href="../enums/LegStatus.html" class="tsd-signature-type tsd-kind-enum">LegStatus</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stats</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RTCStatsJS</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">:</span> <a href="../enums/CancelReason.html" class="tsd-signature-type tsd-kind-enum">CancelReason</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">channelType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/VoiceChannelType.html" class="tsd-signature-type tsd-kind-enum">VoiceChannelType</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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> <a href="../enums/SessionErrorReason.html" class="tsd-signature-type tsd-kind-enum">SessionErrorReason</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/VonageError.html" class="tsd-signature-type tsd-kind-interface">VonageError</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">pc</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RTCPeerConnection</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">isMuted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">conversationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">earmuffStatus</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">digits</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <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-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>        <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#ont">T</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">callback</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="#onp">P</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">symbol</span><a href="#on-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
252
+ <div class="tsd-description">
253
+ <div class="tsd-comment tsd-typography"><p>Register a callback for an event.</p>
254
+ </div>
255
+ <section class="tsd-panel">
256
+ <h4>Type Parameters</h4>
257
+ <ul class="tsd-type-parameter-list">
258
+ <li><span id="ont"><span class="tsd-kind-type-parameter">T</span> <span class="tsd-signature-keyword">extends</span> <br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;mute&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;conversationEvent&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callHangup&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaDisconnect&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;legStatusUpdate&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;rtcStatsUpdate&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInvite&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callInviteCancel&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;sessionError&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaError&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallDisconnected&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;emergencyCallHangup&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callTransfer&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;earmuff&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;dtmf&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnecting&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;callMediaReconnection&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnecting&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;reconnection&quot;</span><br/>    <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">&quot;peerConnectionCreated&quot;</span></span></li>
259
+ <li><span id="onp"><span class="tsd-kind-type-parameter">P</span> <span class="tsd-signature-keyword">extends</span> <br/>    <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> <a href="../types/ConversationEvent.html" class="tsd-signature-type tsd-kind-type-alias">ConversationEvent</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <span class="tsd-signature-symbol">|</span> (<br/>        <span class="tsd-signature-symbol">(</span><br/>            <span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>            <span class="tsd-kind-parameter">callQuality</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RTCQualityJS</span><span class="tsd-signature-symbol">,</span><br/>            <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">:</span> <a href="../enums/HangupReason.html" class="tsd-signature-type tsd-kind-enum">HangupReason</a><span class="tsd-signature-symbol">,</span><br/>        <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span><br/>    )<br/>    <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;networkChange&quot;</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">legStatus</span><span class="tsd-signature-symbol">:</span> <a href="../enums/LegStatus.html" class="tsd-signature-type tsd-kind-enum">LegStatus</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">stats</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RTCStatsJS</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">reason</span><span class="tsd-signature-symbol">:</span> <a href="../enums/CancelReason.html" class="tsd-signature-type tsd-kind-enum">CancelReason</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">channelType</span><span class="tsd-signature-symbol">:</span> <a href="../enums/VoiceChannelType.html" class="tsd-signature-type tsd-kind-enum">VoiceChannelType</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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> <a href="../enums/SessionErrorReason.html" class="tsd-signature-type tsd-kind-enum">SessionErrorReason</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">error</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/VonageError.html" class="tsd-signature-type tsd-kind-interface">VonageError</a><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">pc</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RTCPeerConnection</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">isMuted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">conversationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">earmuffStatus</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">digits</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <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-type">string</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)<br/>    <span class="tsd-signature-symbol">|</span> (<span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=&gt;</span> <span class="tsd-signature-type">void</span>)</span></li></ul></section>
260
+ <div class="tsd-parameters">
261
+ <h4 class="tsd-parameters-title">Parameters</h4>
262
+ <ul class="tsd-parameter-list">
263
+ <li><span><span class="tsd-kind-parameter">event</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#ont">T</a></span>
264
+ <div class="tsd-comment tsd-typography"><p>the event to register for (e.g. 'legStatusUpdate')</p>
265
+ </div></li>
266
+ <li><span><span class="tsd-kind-parameter">callback</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="#onp">P</a></span>
267
+ <div class="tsd-comment tsd-typography"><p>the callback to register for the event</p>
268
+ </div></li></ul></div>
269
+ <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>
270
+
271
+ <div class="tsd-comment tsd-typography">
272
+ <div class="tsd-tag-example">
273
+ <h4 class="tsd-anchor-link" id="example-4">Example<a href="#example-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const eventHandler = (event: ConversationEvent) =&gt; {
274
+ if (event.kind == &#39;member:invited&#39;) {
275
+ console.log(`Member invited: ${event.body.memberId}`);
276
+ } else if (event.kind == &#39;member:joined&#39;) {
277
+ console.log(`Member joined: ${event.body.memberId}`);
278
+ } else if (event.kind == &#39;member:left&#39;) {
279
+ console.log(`Member left: ${event.body.memberId}`);
280
+ } else if (event.kind == &#39;ephemeral&#39;) {
281
+ console.log(`Ephemeral event: ${event.body}`);
282
+ } else if (event.kind == &#39;custom&#39;) {
283
+ console.log(`Custom event: ${event.body}`);
284
+ } else if (event.kind == &#39;message:text&#39;) {
285
+ console.log(`Text message: ${event.body.text}`);
286
+ } else if (event.kind == &#39;message:custom&#39;) {
287
+ console.log(`Custom message: ${event.body.customData}`);
288
+ } else if (event.kind == &#39;message:image&#39;) {
289
+ console.log(`Image message: ${event.body.imageUrl}`);
290
+ } else if (event.kind == &#39;message:video&#39;) {
291
+ console.log(`Video message: ${event.body.videoUrl}`);
292
+ } else if (event.kind == &#39;message:audio&#39;) {
293
+ console.log(`Audio message: ${event.body.audioUrl}`);
294
+ } else if (event.kind == &#39;message:file&#39;) {
295
+ console.log(`File message: ${event.body.fileUrl}`);
296
+ } else if (event.kind == &#39;message:vcard&#39;) {
297
+ console.log(`Vcard message: ${event.body.vcardUrl}`);
298
+ } else if (event.kind == &#39;message:location&#39;) {
299
+ console.log(`Location message: ${event.body.location}`);
300
+ } else if (event.kind == &#39;message:template&#39;) {
301
+ console.log(`Template message: ${event.body.template}`);
302
+ } else if (event.kind == &#39;event:delete&#39;) {
303
+ console.log(`Template message: ${event.body}`);
304
+ } else if (event.kind == &#39;message:seen&#39;) {
305
+ console.log(`Template message: ${event.body}`);
306
+ } else if (event.kind == &#39;message:delivered&#39;) {
307
+ console.log(`Message delivered event: ${event.body}`);
308
+ } else if (event.kind == &#39;message:rejected&#39;) {
309
+ console.log(`Message rejected event ${event.body}`);
310
+ } else if (event.kind == &#39;message:submitted&#39;) {
311
+ console.log(`Message delivered event ${event.body}`);
312
+ } else if (event.kind == &#39;message:undeliverable&#39;) {
313
+ console.log(`Message undeliverable event ${event.body}`);
314
+ } else {
315
+ exhaustiveCheck(event);
316
+ }
317
+ };
318
+
319
+ const listener = client.on(&#39;conversationEvent&#39;, eventHandler);
320
+
321
+ client.off(&#39;conversationEvent&#39;, listener);
322
+ </code><button type="button">Copy</button></pre>
323
+
324
+ </div>
325
+ <div class="tsd-tag-remarks">
326
+ <h4 class="tsd-anchor-link" id="remarks-2">Remarks<a href="#remarks-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Be sure to store the symbol returned by this method so you can unregister the callback later.
327
+ We recommend unregistering callbacks when you no longer need them. See <a href="#off" class="tsd-kind-method">off</a>.</p>
328
+ </div></div></div></li></ul></section>
329
+ <section class="tsd-panel tsd-member">
330
+ <h3 class="tsd-anchor-link" id="setconfig"><span>set<wbr/>Config</span><a href="#setconfig" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
331
+ <ul class="tsd-signatures">
332
+ <li class="">
333
+ <div class="tsd-signature tsd-anchor-link" id="setconfig-1"><span class="tsd-kind-call-signature">setConfig</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">config</span><span class="tsd-signature-symbol">:</span> <a href="../types/ClientConfigObject.html" class="tsd-signature-type tsd-kind-type-alias">ClientConfigObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setconfig-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
334
+ <div class="tsd-description">
335
+ <div class="tsd-comment tsd-typography"><p>Set a configuration for the client SDK</p>
336
+ </div>
337
+ <div class="tsd-parameters">
338
+ <h4 class="tsd-parameters-title">Parameters</h4>
339
+ <ul class="tsd-parameter-list">
340
+ <li><span><span class="tsd-kind-parameter">config</span>: <a href="../types/ClientConfigObject.html" class="tsd-signature-type tsd-kind-type-alias">ClientConfigObject</a></span>
341
+ <div class="tsd-comment tsd-typography"><p>A configuration object</p>
342
+ </div></li></ul></div>
343
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><p>void</p>
344
+
345
+ <div class="tsd-comment tsd-typography">
346
+ <div class="tsd-tag-example">
347
+ <h4 class="tsd-anchor-link" id="example-5">Example<a href="#example-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const config: ClientConfig = new ClientConfig(ConfigRegion.EU);
348
+ config.apiUrl = &#39;https://api.example.com&#39;;
349
+ config.websocketUrl = &#39;https://ws.example.com&#39;;
350
+ config.rtcStatsTelemetry = true;
351
+ config.autoReconnectMedia = false;
352
+ client.setConfig(config);
353
+ // or
354
+ client.setConfig({
355
+ apiUrl: &#39;https://api.example.com&#39;,
356
+ websocketUrl: &#39;https://ws.example.com&#39;,
357
+ region: &#39;EU&#39;
358
+ });
359
+ </code><button type="button">Copy</button></pre>
360
+
361
+ </div></div><aside class="tsd-sources">
362
+ <p>Overrides vonage.CombinedClientJS.setConfig</p></aside></div></li></ul></section>
363
+ <section class="tsd-panel tsd-member">
364
+ <h3 class="tsd-anchor-link" id="updateconversation"><span>update<wbr/>Conversation</span><a href="#updateconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
365
+ <ul class="tsd-signatures">
366
+ <li class="">
367
+ <div class="tsd-signature tsd-anchor-link" id="updateconversation-1"><span class="tsd-kind-call-signature">updateConversation</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">conversationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/UpdateConversationParameters.html" class="tsd-signature-type tsd-kind-interface">UpdateConversationParameters</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><span class="tsd-signature-symbol">&gt;</span><a href="#updateconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
368
+ <div class="tsd-description">
369
+ <div class="tsd-comment tsd-typography"><p>Updates a conversation object identified by its unique conversation ID.</p>
105
370
  <p>This method overrides the conversation properties to the provided parameters and rest remains as it is.</p>
106
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">conversationId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id.</p>
107
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">parameters</span>: <a href="../interfaces/UpdateConversationParameters.html" class="tsd-signature-type tsd-kind-interface">UpdateConversationParameters</a></span><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>
108
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><span class="tsd-signature-symbol">&gt;</span></h4><p><code>conversation</code>, this object will contain the updated conversation properties if the update is successful.</p>
109
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_UpdateConversation</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
110
- </code><button>Copy</button></pre>
111
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#createConversation.createConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create a conversation</p>
112
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><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">&lt;</span><a href="../interfaces/CreateConversationParameters.html" class="tsd-signature-type tsd-kind-interface">CreateConversationParameters</a><span class="tsd-signature-symbol">&gt;</span></span><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>
113
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>cid</code> of the conversation</p>
114
- <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>
115
- </code><button>Copy</button></pre>
116
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#deleteConversation.deleteConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete a Conversation</p>
117
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
118
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
119
- <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>
120
- </code><button>Copy</button></pre>
121
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#deleteEvent.deleteEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete an Event in a Conversation</p>
122
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the id for the Event to be deleted</p>
123
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">conversationId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the id for the conversation, the event belongs to.</p>
124
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
125
- <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>
126
- </code><button>Copy</button></pre>
127
- </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="../assets/icons.svg#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">&lt;</span><a href="../interfaces/EventsPage.html" class="tsd-signature-type tsd-kind-interface">EventsPage</a><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationEvents.getConversationEvents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a Conversation&#39;s Events</p>
128
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
129
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><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">&lt;</span><a href="../interfaces/GetConversationEventsParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationEventsParameters</a><span class="tsd-signature-symbol">&gt;</span></span><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>
130
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/EventsPage.html" class="tsd-signature-type tsd-kind-interface">EventsPage</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a <a href="../interfaces/EventsPage.html" class="tsd-kind-interface">EventsPage</a> containing the events</p>
131
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_GetConversationEvents</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
132
- </code><button>Copy</button></pre>
133
- </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="../assets/icons.svg#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">&lt;</span><a href="../interfaces/Member.html" class="tsd-signature-type tsd-kind-interface">Member</a><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationMember.getConversationMember-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a Member of a Conversation</p>
134
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">cid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
135
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">mid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Member&#39;s id</p>
136
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Member.html" class="tsd-signature-type tsd-kind-interface">Member</a><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>Member</code></p>
137
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_GetConversationMember</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
138
- </code><button>Copy</button></pre>
139
- </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="../assets/icons.svg#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">&lt;</span><a href="../interfaces/MembersPage.html" class="tsd-signature-type tsd-kind-interface">MembersPage</a><span class="tsd-signature-symbol">&gt;</span><a href="#getConversationMembers.getConversationMembers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a Conversation&#39;s Members</p>
140
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
141
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><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">&lt;</span><a href="../interfaces/GetConversationMembersParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationMembersParameters</a><span class="tsd-signature-symbol">&gt;</span></span><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>
142
- </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">&lt;</span><a href="../interfaces/MembersPage.html" class="tsd-signature-type tsd-kind-interface">MembersPage</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>MembersPage</code> containing the members</p>
143
- <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>
144
- </code><button>Copy</button></pre>
145
- </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="../assets/icons.svg#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">&lt;</span><a href="../interfaces/ConversationsPage.html" class="tsd-signature-type tsd-kind-interface">ConversationsPage</a><span class="tsd-signature-symbol">&gt;</span><a href="#getConversations.getConversations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
146
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><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">&lt;</span><a href="../interfaces/GetConversationsParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationsParameters</a><span class="tsd-signature-symbol">&gt;</span></span><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>
147
- </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">&lt;</span><a href="../interfaces/ConversationsPage.html" class="tsd-signature-type tsd-kind-interface">ConversationsPage</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>ConversationsPage</code> containing the conversations</p>
148
- <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>
149
- </code><button>Copy</button></pre>
150
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#inviteToConversation.inviteToConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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&#39;s <code>name</code></p>
151
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
152
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the name of the user to invite</p>
153
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>memberId</code> of the member</p>
154
- <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>
155
- </code><button>Copy</button></pre>
156
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#joinConversation.joinConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Join a Conversation</p>
157
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
158
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>memberId</code> of the member</p>
159
- <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>
160
- </code><button>Copy</button></pre>
161
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#leaveConversation.leaveConversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Leave a Conversation</p>
162
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
163
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
164
- <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>
165
- </code><button>Copy</button></pre>
166
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendCustomEvent.sendCustomEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
167
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
168
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">eventType</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">customData</span>: <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a></span><div class="tsd-comment tsd-typography"><p>the body of the event</p>
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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
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_SendCustomEvent</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
171
- </code><button>Copy</button></pre>
172
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendEphemeralEvent.sendEphemeralEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
173
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
174
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">customData</span>: <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a></span><div class="tsd-comment tsd-typography"><p>the body of the event</p>
175
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
176
- <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>
177
- </code><button>Copy</button></pre>
178
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageAudioEvent.sendMessageAudioEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
179
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
180
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">audioUrl</span>: <span class="tsd-signature-type">URL</span></span><div class="tsd-comment tsd-typography"><p>the url of the audio resource.</p>
181
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
182
- <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>
183
- </code><button>Copy</button></pre>
184
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageCustomEvent.sendMessageCustomEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
185
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
186
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">customData</span>: <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a></span><div class="tsd-comment tsd-typography"><p>the body of the message</p>
187
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
188
- <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>
189
- </code><button>Copy</button></pre>
190
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageFileEvent.sendMessageFileEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
191
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
192
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">fileUrl</span>: <span class="tsd-signature-type">URL</span></span><div class="tsd-comment tsd-typography"><p>the url of the file resource.</p>
193
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
194
- <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>
195
- </code><button>Copy</button></pre>
196
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageImageEvent.sendMessageImageEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
197
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
198
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">imageUrl</span>: <span class="tsd-signature-type">URL</span></span><div class="tsd-comment tsd-typography"><p>the url of the image resource.</p>
199
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
200
- <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>
201
- </code><button>Copy</button></pre>
202
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageLocationEvent.sendMessageLocationEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
203
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
204
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">location</span>: <a href="../interfaces/Location.html" class="tsd-signature-type tsd-kind-interface">Location</a></span><div class="tsd-comment tsd-typography"><p>the description of the location.</p>
205
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
206
- <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>
207
- </code><button>Copy</button></pre>
208
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageSeenEvent.sendMessageSeenEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
209
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>the event id</p>
210
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">conversationId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the conversation id</p>
211
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
212
- <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>
213
- </code><button>Copy</button></pre>
214
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageTemplateEvent.sendMessageTemplateEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
215
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
216
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">templateObject</span>: <a href="../interfaces/Template.html" class="tsd-signature-type tsd-kind-interface">Template</a></span><div class="tsd-comment tsd-typography"><p>the description(name and paramters) of the template.</p>
217
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">whatsappObject</span>: <a href="../interfaces/Whatsapp.html" class="tsd-signature-type tsd-kind-interface">Whatsapp</a></span><div class="tsd-comment tsd-typography"><p>the description(locale and policies of business account) of the location.</p>
218
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
219
- <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>
220
- </code><button>Copy</button></pre>
221
- </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="../assets/icons.svg#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-kind-parameter">raw</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageTextEvent.sendMessageTextEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
222
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
223
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Body of the message</p>
224
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">raw</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span><div class="tsd-comment tsd-typography"><p>whether to send the text as raw or not (default: false, not recommended)</p>
225
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
226
- <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>
227
- </code><button>Copy</button></pre>
228
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageVCardEvent.sendMessageVCardEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
229
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
230
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">vCardUrl</span>: <span class="tsd-signature-type">URL</span></span><div class="tsd-comment tsd-typography"><p>the url of the vCardUrl resource.</p>
231
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
232
- <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>
233
- </code><button>Copy</button></pre>
234
- </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="../assets/icons.svg#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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendMessageVideoEvent.sendMessageVideoEvent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>
235
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the Conversation&#39;s id</p>
236
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">videoUrl</span>: <span class="tsd-signature-type">URL</span></span><div class="tsd-comment tsd-typography"><p>the url of the video resource.</p>
237
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
238
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_SendVideoMessage</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
239
- </code><button>Copy</button></pre>
240
- </div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.sendMessageVideoEvent</p></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Emergency</h2><section class="tsd-panel tsd-member"><a id="disableEarmuffEmergencyCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span><a href="#disableEarmuffEmergencyCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="disableEarmuffEmergencyCall.disableEarmuffEmergencyCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableEarmuffEmergencyCall.disableEarmuffEmergencyCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Disable earmuff for an emergency call.</p>
241
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to disable earmuff for</p>
242
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
243
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.disableEarmuffEmergencyCall</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="emergencyCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emergency<wbr/>Call</span><a href="#emergencyCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="emergencyCall.emergencyCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">emergency<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span>, <span class="tsd-kind-parameter">from</span>, <span class="tsd-kind-parameter">to</span>, <span class="tsd-kind-parameter">options</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">&lt;</span><span class="tsd-signature-type">EmergencyCallDataJS</span><span class="tsd-signature-symbol">&gt;</span><a href="#emergencyCall.emergencyCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Starts an emergency call.</p>
244
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">from</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">to</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">EmergencyCallOptionsJS</span><span class="tsd-signature-symbol">&gt;</span></span><div class="tsd-comment tsd-typography"><p>Optional <a href="../interfaces/EmergencyCallOptions.html" class="tsd-kind-interface">EmergencyCallOptions</a> containing call options</p>
245
- </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">&lt;</span><span class="tsd-signature-type">EmergencyCallDataJS</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the result containing <code>callId</code> and <code>reconnectToken</code></p>
246
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.emergencyCall</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="enableEarmuffEmergencyCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span><a href="#enableEarmuffEmergencyCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="enableEarmuffEmergencyCall.enableEarmuffEmergencyCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">enable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableEarmuffEmergencyCall.enableEarmuffEmergencyCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Enable earmuff for an emergency call.</p>
247
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to enable earmuff for</p>
248
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
249
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.enableEarmuffEmergencyCall</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hangupEmergencyCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hangup<wbr/>Emergency<wbr/>Call</span><a href="#hangupEmergencyCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="hangupEmergencyCall.hangupEmergencyCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hangup<wbr/>Emergency<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#hangupEmergencyCall.hangupEmergencyCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Hangup an emergency call.</p>
250
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to hangup</p>
251
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
252
- <div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member"><a id="muteEmergencyCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mute<wbr/>Emergency<wbr/>Call</span><a href="#muteEmergencyCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="muteEmergencyCall.muteEmergencyCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mute<wbr/>Emergency<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#muteEmergencyCall.muteEmergencyCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mute an emergency call.</p>
253
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to mute</p>
254
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
255
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.muteEmergencyCall</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="reconnectEmergencyCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reconnect<wbr/>Emergency<wbr/>Call</span><a href="#reconnectEmergencyCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="reconnectEmergencyCall.reconnectEmergencyCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reconnect<wbr/>Emergency<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">token</span>, <span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">reconnectToken</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reconnectEmergencyCall.reconnectEmergencyCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reconnects an existing emergency call.</p>
256
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">reconnectToken</span>: <span class="tsd-signature-type">string</span></span><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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
257
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.reconnectEmergencyCall</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unmuteEmergencyCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unmute<wbr/>Emergency<wbr/>Call</span><a href="#unmuteEmergencyCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="unmuteEmergencyCall.unmuteEmergencyCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unmute<wbr/>Emergency<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#unmuteEmergencyCall.unmuteEmergencyCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unmute an emergency call.</p>
258
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to unmute</p>
259
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
260
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.unmuteEmergencyCall</p></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Voice</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="answer" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>answer</span><a href="#answer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="answer.answer-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">answer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#answer.answer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Answer a call</p>
261
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Call ID</p>
262
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
263
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_AnswerCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
264
- </code><button>Copy</button></pre>
265
- </div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.answer</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="disableAutoGainControl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disable<wbr/>Auto<wbr/>Gain<wbr/>Control</span><a href="#disableAutoGainControl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="disableAutoGainControl.disableAutoGainControl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disable<wbr/>Auto<wbr/>Gain<wbr/>Control</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableAutoGainControl.disableAutoGainControl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>Disable auto gain control on a call&#39;s audio track.</p>
266
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Call Id</p>
267
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.disableAutoGainControl</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="disableEarmuff" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disable<wbr/>Earmuff</span><a href="#disableEarmuff" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="disableEarmuff.disableEarmuff-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableEarmuff.disableEarmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unearmuff your leg of a call</p>
268
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Call ID</p>
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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
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_DisableEarmuff</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
271
- </code><button>Copy</button></pre>
272
- </div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.disableEarmuff</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="disableEchoCancellation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disable<wbr/>Echo<wbr/>Cancellation</span><a href="#disableEchoCancellation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="disableEchoCancellation.disableEchoCancellation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disable<wbr/>Echo<wbr/>Cancellation</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableEchoCancellation.disableEchoCancellation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>Disable echo cancellation on a call&#39;s audio track.</p>
273
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Call Id</p>
274
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.disableEchoCancellation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="disableNoiseSuppression" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disable<wbr/>Noise<wbr/>Suppression</span><a href="#disableNoiseSuppression" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="disableNoiseSuppression.disableNoiseSuppression-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disable<wbr/>Noise<wbr/>Suppression</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableNoiseSuppression.disableNoiseSuppression-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>Disable noise suppression on a call&#39;s audio track.</p>
275
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Call Id</p>
276
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.disableNoiseSuppression</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="enableAutoGainControl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enable<wbr/>Auto<wbr/>Gain<wbr/>Control</span><a href="#enableAutoGainControl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="enableAutoGainControl.enableAutoGainControl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">enable<wbr/>Auto<wbr/>Gain<wbr/>Control</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableAutoGainControl.enableAutoGainControl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>Enable auto gain control on a call&#39;s audio track.</p>
277
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Call Id</p>
278
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.enableAutoGainControl</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="enableEarmuff" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enable<wbr/>Earmuff</span><a href="#enableEarmuff" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="enableEarmuff.enableEarmuff-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">enable<wbr/>Earmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableEarmuff.enableEarmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Earmuff your leg of a call</p>
279
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Call ID</p>
280
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
281
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_EnableEarmuff</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
282
- </code><button>Copy</button></pre>
283
- </div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.enableEarmuff</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="enableEchoCancellation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enable<wbr/>Echo<wbr/>Cancellation</span><a href="#enableEchoCancellation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="enableEchoCancellation.enableEchoCancellation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">enable<wbr/>Echo<wbr/>Cancellation</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableEchoCancellation.enableEchoCancellation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>Enable echo cancellation on a call&#39;s audio track.</p>
284
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Call Id</p>
285
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.enableEchoCancellation</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="enableNoiseSuppression" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>enable<wbr/>Noise<wbr/>Suppression</span><a href="#enableNoiseSuppression" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="enableNoiseSuppression.enableNoiseSuppression-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">enable<wbr/>Noise<wbr/>Suppression</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableNoiseSuppression.enableNoiseSuppression-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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>Enable noise suppression on a call&#39;s audio track.</p>
286
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Call Id</p>
287
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.enableNoiseSuppression</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getAudioOutputElement" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Audio<wbr/>Output<wbr/>Element</span><a href="#getAudioOutputElement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getAudioOutputElement.getAudioOutputElement-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Audio<wbr/>Output<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="#getAudioOutputElement.getAudioOutputElement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#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.
371
+ </div>
372
+ <div class="tsd-parameters">
373
+ <h4 class="tsd-parameters-title">Parameters</h4>
374
+ <ul class="tsd-parameter-list">
375
+ <li><span><span class="tsd-kind-parameter">conversationId</span>: <span class="tsd-signature-type">string</span></span>
376
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id.</p>
377
+ </div></li>
378
+ <li><span><span class="tsd-kind-parameter">parameters</span>: <a href="../interfaces/UpdateConversationParameters.html" class="tsd-signature-type tsd-kind-interface">UpdateConversationParameters</a></span>
379
+ <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>
380
+ </div></li></ul></div>
381
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Conversation.html" class="tsd-signature-type tsd-kind-interface">Conversation</a><span class="tsd-signature-symbol">&gt;</span></h4><p><code>conversation</code>, this object will contain the updated conversation properties if the update is successful.</p>
382
+
383
+ <div class="tsd-comment tsd-typography">
384
+ <div class="tsd-tag-example">
385
+ <h4 class="tsd-anchor-link" id="example-6">Example<a href="#example-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const conversation = await client.updateConversation(&#39;ConversationID&#39;, {
386
+ // Update Name
387
+ name: some(&#39;name&#39;),
388
+ // Reset Display Name
389
+ displayName: some(null),
390
+ // Update imageUrl
391
+ imageUrl: &#39;imageUrl&#39;,
392
+ // Leave TTL as is (implicitly via omission)
393
+ // Leave customSortKey as is (explicitly via none)
394
+ customSortKey: none(),
395
+ customData: { key: &#39;value&#39; }
396
+ });
397
+ </code><button type="button">Copy</button></pre>
398
+
399
+ </div></div><aside class="tsd-sources">
400
+ <p>Overrides vonage.CombinedClientJS.updateConversation</p></aside></div></li></ul></section></section></details>
401
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Chat"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
402
+ <h2 class="tsd-anchor-link" id="chat-1">Chat<a href="#chat-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
403
+ <section>
404
+ <section class="tsd-panel tsd-member">
405
+ <h3 class="tsd-anchor-link" id="createconversation"><span>create<wbr/>Conversation</span><a href="#createconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
406
+ <ul class="tsd-signatures">
407
+ <li class="">
408
+ <div class="tsd-signature tsd-anchor-link" id="createconversation-1"><span class="tsd-kind-call-signature">createConversation</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CreateConversationParameters.html" class="tsd-signature-type tsd-kind-interface">CreateConversationParameters</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#createconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
409
+ <div class="tsd-description">
410
+ <div class="tsd-comment tsd-typography"><p>Create a conversation</p>
411
+ </div>
412
+ <div class="tsd-parameters">
413
+ <h4 class="tsd-parameters-title">Parameters</h4>
414
+ <ul class="tsd-parameter-list">
415
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CreateConversationParameters.html" class="tsd-signature-type tsd-kind-interface">CreateConversationParameters</a><span class="tsd-signature-symbol">&gt;</span></span>
416
+ <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>
417
+ </div></li></ul></div>
418
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>cid</code> of the conversation</p>
419
+
420
+ <div class="tsd-comment tsd-typography">
421
+ <div class="tsd-tag-example">
422
+ <h4 class="tsd-anchor-link" id="example-7">Example<a href="#example-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const conversationId = await client.createConversation({
423
+ name: &#39;name&#39;,
424
+ displayName: &#39;displayName&#39;,
425
+ imageUrl: &#39;imageUrl&#39;,
426
+ ttl: 60,
427
+ customSortKey: &#39;customSortKey&#39;,
428
+ customData: { key: &#39;value&#39; }
429
+ });
430
+ </code><button type="button">Copy</button></pre>
431
+
432
+ </div></div><aside class="tsd-sources">
433
+ <p>Overrides vonage.CombinedClientJS.createConversation</p></aside></div></li></ul></section>
434
+ <section class="tsd-panel tsd-member">
435
+ <h3 class="tsd-anchor-link" id="deleteconversation"><span>delete<wbr/>Conversation</span><a href="#deleteconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
436
+ <ul class="tsd-signatures">
437
+ <li class="">
438
+ <div class="tsd-signature tsd-anchor-link" id="deleteconversation-1"><span class="tsd-kind-call-signature">deleteConversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#deleteconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
439
+ <div class="tsd-description">
440
+ <div class="tsd-comment tsd-typography"><p>Delete a Conversation</p>
441
+ </div>
442
+ <div class="tsd-parameters">
443
+ <h4 class="tsd-parameters-title">Parameters</h4>
444
+ <ul class="tsd-parameter-list">
445
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
446
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
447
+ </div></li></ul></div>
448
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
449
+
450
+ <div class="tsd-comment tsd-typography">
451
+ <div class="tsd-tag-example">
452
+ <h4 class="tsd-anchor-link" id="example-8">Example<a href="#example-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">await client.deleteConversation(&#39;CONVERSATION_ID&#39;);
453
+ </code><button type="button">Copy</button></pre>
454
+
455
+ </div></div><aside class="tsd-sources">
456
+ <p>Overrides vonage.CombinedClientJS.deleteConversation</p></aside></div></li></ul></section>
457
+ <section class="tsd-panel tsd-member">
458
+ <h3 class="tsd-anchor-link" id="deleteevent"><span>delete<wbr/>Event</span><a href="#deleteevent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
459
+ <ul class="tsd-signatures">
460
+ <li class="">
461
+ <div class="tsd-signature tsd-anchor-link" id="deleteevent-1"><span class="tsd-kind-call-signature">deleteEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">conversationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#deleteevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
462
+ <div class="tsd-description">
463
+ <div class="tsd-comment tsd-typography"><p>Delete an Event in a Conversation</p>
464
+ </div>
465
+ <div class="tsd-parameters">
466
+ <h4 class="tsd-parameters-title">Parameters</h4>
467
+ <ul class="tsd-parameter-list">
468
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></span>
469
+ <div class="tsd-comment tsd-typography"><p>the id for the Event to be deleted</p>
470
+ </div></li>
471
+ <li><span><span class="tsd-kind-parameter">conversationId</span>: <span class="tsd-signature-type">string</span></span>
472
+ <div class="tsd-comment tsd-typography"><p>the id for the conversation, the event belongs to.</p>
473
+ </div></li></ul></div>
474
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
475
+
476
+ <div class="tsd-comment tsd-typography">
477
+ <div class="tsd-tag-example">
478
+ <h4 class="tsd-anchor-link" id="example-9">Example<a href="#example-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">await client.deleteEvent(123, &#39;CONVERSATION_ID&#39;);
479
+ </code><button type="button">Copy</button></pre>
480
+
481
+ </div></div><aside class="tsd-sources">
482
+ <p>Overrides vonage.CombinedClientJS.deleteEvent</p></aside></div></li></ul></section>
483
+ <section class="tsd-panel tsd-member">
484
+ <h3 class="tsd-anchor-link" id="getconversationevents"><span>get<wbr/>Conversation<wbr/>Events</span><a href="#getconversationevents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
485
+ <ul class="tsd-signatures">
486
+ <li class="">
487
+ <div class="tsd-signature tsd-anchor-link" id="getconversationevents-1"><span class="tsd-kind-call-signature">getConversationEvents</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GetConversationEventsParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationEventsParameters</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/EventsPage.html" class="tsd-signature-type tsd-kind-interface">EventsPage</a><span class="tsd-signature-symbol">&gt;</span><a href="#getconversationevents-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
488
+ <div class="tsd-description">
489
+ <div class="tsd-comment tsd-typography"><p>Get a Conversation's Events</p>
490
+ </div>
491
+ <div class="tsd-parameters">
492
+ <h4 class="tsd-parameters-title">Parameters</h4>
493
+ <ul class="tsd-parameter-list">
494
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
495
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
496
+ </div></li>
497
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GetConversationEventsParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationEventsParameters</a><span class="tsd-signature-symbol">&gt;</span></span>
498
+ <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>
499
+ </div></li></ul></div>
500
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/EventsPage.html" class="tsd-signature-type tsd-kind-interface">EventsPage</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a <a href="../interfaces/EventsPage.html" class="tsd-kind-interface">EventsPage</a> containing the events</p>
501
+
502
+ <div class="tsd-comment tsd-typography">
503
+ <div class="tsd-tag-example">
504
+ <h4 class="tsd-anchor-link" id="example-10">Example<a href="#example-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const { events, nextCursor, previousCursor } =
505
+ await client.getConversationEvents(&#39;CONVERSATION_ID&#39;, {
506
+ order: PresentingOrder.DESC,
507
+ pageSize: 10,
508
+ cursor: undefined,
509
+ eventFilter: [&#39;message&#39;, &#39;member:joined&#39;], // event filter query
510
+ includeDeletedEvents: false,
511
+ startId: 3 // start event id
512
+ });
513
+ </code><button type="button">Copy</button></pre>
514
+
515
+ </div></div><aside class="tsd-sources">
516
+ <p>Overrides vonage.CombinedClientJS.getConversationEvents</p></aside></div></li></ul></section>
517
+ <section class="tsd-panel tsd-member tsd-is-inherited">
518
+ <h3 class="tsd-anchor-link" id="getconversationmember"><span>get<wbr/>Conversation<wbr/>Member</span><a href="#getconversationmember" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
519
+ <ul class="tsd-signatures tsd-is-inherited">
520
+ <li class="tsd-is-inherited">
521
+ <div class="tsd-signature tsd-anchor-link" id="getconversationmember-1"><span class="tsd-kind-call-signature">getConversationMember</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">cid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">mid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Member.html" class="tsd-signature-type tsd-kind-interface">Member</a><span class="tsd-signature-symbol">&gt;</span><a href="#getconversationmember-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
522
+ <div class="tsd-description">
523
+ <div class="tsd-comment tsd-typography"><p>Get a Member of a Conversation</p>
524
+ </div>
525
+ <div class="tsd-parameters">
526
+ <h4 class="tsd-parameters-title">Parameters</h4>
527
+ <ul class="tsd-parameter-list">
528
+ <li><span><span class="tsd-kind-parameter">cid</span>: <span class="tsd-signature-type">string</span></span>
529
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
530
+ </div></li>
531
+ <li><span><span class="tsd-kind-parameter">mid</span>: <span class="tsd-signature-type">string</span></span>
532
+ <div class="tsd-comment tsd-typography"><p>the Member's id</p>
533
+ </div></li></ul></div>
534
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/Member.html" class="tsd-signature-type tsd-kind-interface">Member</a><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>Member</code></p>
535
+
536
+ <div class="tsd-comment tsd-typography">
537
+ <div class="tsd-tag-example">
538
+ <h4 class="tsd-anchor-link" id="example-11">Example<a href="#example-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const { id, state, channel } = await client.getConversationMember(
539
+ &#39;CONVERSATION_ID&#39;,
540
+ &#39;MEMBER_ID&#39;
541
+ );
542
+ console.log(
543
+ `Member ID: ${id}, State: ${state}, Channel Type: ${channel?.type}`
544
+ );
545
+ </code><button type="button">Copy</button></pre>
546
+
547
+ </div></div><aside class="tsd-sources">
548
+ <p>Inherited from vonage.CombinedClientJS.getConversationMember</p></aside></div></li></ul></section>
549
+ <section class="tsd-panel tsd-member">
550
+ <h3 class="tsd-anchor-link" id="getconversationmembers"><span>get<wbr/>Conversation<wbr/>Members</span><a href="#getconversationmembers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
551
+ <ul class="tsd-signatures">
552
+ <li class="">
553
+ <div class="tsd-signature tsd-anchor-link" id="getconversationmembers-1"><span class="tsd-kind-call-signature">getConversationMembers</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GetConversationMembersParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationMembersParameters</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/MembersPage.html" class="tsd-signature-type tsd-kind-interface">MembersPage</a><span class="tsd-signature-symbol">&gt;</span><a href="#getconversationmembers-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
554
+ <div class="tsd-description">
555
+ <div class="tsd-comment tsd-typography"><p>Get a Conversation's Members</p>
556
+ </div>
557
+ <div class="tsd-parameters">
558
+ <h4 class="tsd-parameters-title">Parameters</h4>
559
+ <ul class="tsd-parameter-list">
560
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
561
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
562
+ </div></li>
563
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GetConversationMembersParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationMembersParameters</a><span class="tsd-signature-symbol">&gt;</span></span>
564
+ <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>
565
+ </div></li></ul></div>
566
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/MembersPage.html" class="tsd-signature-type tsd-kind-interface">MembersPage</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>MembersPage</code> containing the members</p>
567
+
568
+ <div class="tsd-comment tsd-typography">
569
+ <div class="tsd-tag-example">
570
+ <h4 class="tsd-anchor-link" id="example-12">Example<a href="#example-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const { members, nextCursor, previousCursor } =
571
+ await client.getConversationMembers(&#39;CONVERSATION_ID&#39;, {
572
+ order: PresentingOrder.ASC,
573
+ pageSize: 10
574
+ });
575
+ </code><button type="button">Copy</button></pre>
576
+
577
+ </div></div><aside class="tsd-sources">
578
+ <p>Overrides vonage.CombinedClientJS.getConversationMembers</p></aside></div></li></ul></section>
579
+ <section class="tsd-panel tsd-member">
580
+ <h3 class="tsd-anchor-link" id="getconversations"><span>get<wbr/>Conversations</span><a href="#getconversations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
581
+ <ul class="tsd-signatures">
582
+ <li class="">
583
+ <div class="tsd-signature tsd-anchor-link" id="getconversations-1"><span class="tsd-kind-call-signature">getConversations</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GetConversationsParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationsParameters</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ConversationsPage.html" class="tsd-signature-type tsd-kind-interface">ConversationsPage</a><span class="tsd-signature-symbol">&gt;</span><a href="#getconversations-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
584
+ <div class="tsd-description">
585
+ <div class="tsd-comment tsd-typography"><p>Get a list of Conversations for the user.</p>
586
+ </div>
587
+ <div class="tsd-parameters">
588
+ <h4 class="tsd-parameters-title">Parameters</h4>
589
+ <ul class="tsd-parameter-list">
590
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GetConversationsParameters.html" class="tsd-signature-type tsd-kind-interface">GetConversationsParameters</a><span class="tsd-signature-symbol">&gt;</span></span>
591
+ <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>
592
+ </div></li></ul></div>
593
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ConversationsPage.html" class="tsd-signature-type tsd-kind-interface">ConversationsPage</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>ConversationsPage</code> containing the conversations</p>
594
+
595
+ <div class="tsd-comment tsd-typography">
596
+ <div class="tsd-tag-example">
597
+ <h4 class="tsd-anchor-link" id="example-13">Example<a href="#example-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const { conversations, nextCursor, previousCursor } =
598
+ await client.getConversations({
599
+ order: PresentingOrder.DESC,
600
+ pageSize: 10,
601
+ cursor: undefined,
602
+ includeCustomData: true,
603
+ orderBy: OrderBy.CUSTOM_SORT_KEY
604
+ });
605
+ </code><button type="button">Copy</button></pre>
606
+
607
+ </div></div><aside class="tsd-sources">
608
+ <p>Overrides vonage.CombinedClientJS.getConversations</p></aside></div></li></ul></section>
609
+ <section class="tsd-panel tsd-member">
610
+ <h3 class="tsd-anchor-link" id="invitetoconversation"><span>invite<wbr/>To<wbr/>Conversation</span><a href="#invitetoconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
611
+ <ul class="tsd-signatures">
612
+ <li class="">
613
+ <div class="tsd-signature tsd-anchor-link" id="invitetoconversation-1"><span class="tsd-kind-call-signature">inviteToConversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#invitetoconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
614
+ <div class="tsd-description">
615
+ <div class="tsd-comment tsd-typography"><p>Invite a user to a Conversation by user's <code>name</code></p>
616
+ </div>
617
+ <div class="tsd-parameters">
618
+ <h4 class="tsd-parameters-title">Parameters</h4>
619
+ <ul class="tsd-parameter-list">
620
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
621
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
622
+ </div></li>
623
+ <li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span>
624
+ <div class="tsd-comment tsd-typography"><p>the name of the user to invite</p>
625
+ </div></li></ul></div>
626
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>memberId</code> of the member</p>
627
+
628
+ <div class="tsd-comment tsd-typography">
629
+ <div class="tsd-tag-example">
630
+ <h4 class="tsd-anchor-link" id="example-14">Example<a href="#example-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const memberId = await client.inviteToConversation(
631
+ &#39;CONVERSATION_ID&#39;,
632
+ &#39;USERNAME&#39;
633
+ );
634
+ </code><button type="button">Copy</button></pre>
635
+
636
+ </div></div><aside class="tsd-sources">
637
+ <p>Overrides vonage.CombinedClientJS.inviteToConversation</p></aside></div></li></ul></section>
638
+ <section class="tsd-panel tsd-member">
639
+ <h3 class="tsd-anchor-link" id="joinconversation"><span>join<wbr/>Conversation</span><a href="#joinconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
640
+ <ul class="tsd-signatures">
641
+ <li class="">
642
+ <div class="tsd-signature tsd-anchor-link" id="joinconversation-1"><span class="tsd-kind-call-signature">joinConversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#joinconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
643
+ <div class="tsd-description">
644
+ <div class="tsd-comment tsd-typography"><p>Join a Conversation</p>
645
+ </div>
646
+ <div class="tsd-parameters">
647
+ <h4 class="tsd-parameters-title">Parameters</h4>
648
+ <ul class="tsd-parameter-list">
649
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
650
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
651
+ </div></li></ul></div>
652
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>memberId</code> of the member</p>
653
+
654
+ <div class="tsd-comment tsd-typography">
655
+ <div class="tsd-tag-example">
656
+ <h4 class="tsd-anchor-link" id="example-15">Example<a href="#example-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const memberId = await client.joinConversation(&#39;CONVERSATION_ID&#39;);
657
+ </code><button type="button">Copy</button></pre>
658
+
659
+ </div></div><aside class="tsd-sources">
660
+ <p>Overrides vonage.CombinedClientJS.joinConversation</p></aside></div></li></ul></section>
661
+ <section class="tsd-panel tsd-member">
662
+ <h3 class="tsd-anchor-link" id="leaveconversation"><span>leave<wbr/>Conversation</span><a href="#leaveconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
663
+ <ul class="tsd-signatures">
664
+ <li class="">
665
+ <div class="tsd-signature tsd-anchor-link" id="leaveconversation-1"><span class="tsd-kind-call-signature">leaveConversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#leaveconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
666
+ <div class="tsd-description">
667
+ <div class="tsd-comment tsd-typography"><p>Leave a Conversation</p>
668
+ </div>
669
+ <div class="tsd-parameters">
670
+ <h4 class="tsd-parameters-title">Parameters</h4>
671
+ <ul class="tsd-parameter-list">
672
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
673
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
674
+ </div></li></ul></div>
675
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
676
+
677
+ <div class="tsd-comment tsd-typography">
678
+ <div class="tsd-tag-example">
679
+ <h4 class="tsd-anchor-link" id="example-16">Example<a href="#example-16" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">await client.leaveConversation(&#39;CONVERSATION_ID&#39;);
680
+ </code><button type="button">Copy</button></pre>
681
+
682
+ </div></div><aside class="tsd-sources">
683
+ <p>Overrides vonage.CombinedClientJS.leaveConversation</p></aside></div></li></ul></section>
684
+ <section class="tsd-panel tsd-member">
685
+ <h3 class="tsd-anchor-link" id="sendcustomevent"><span>send<wbr/>Custom<wbr/>Event</span><a href="#sendcustomevent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
686
+ <ul class="tsd-signatures">
687
+ <li class="">
688
+ <div class="tsd-signature tsd-anchor-link" id="sendcustomevent-1"><span class="tsd-kind-call-signature">sendCustomEvent</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">:</span> <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendcustomevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
689
+ <div class="tsd-description">
690
+ <div class="tsd-comment tsd-typography"><p>Send a Custom event to a Conversation</p>
691
+ </div>
692
+ <div class="tsd-parameters">
693
+ <h4 class="tsd-parameters-title">Parameters</h4>
694
+ <ul class="tsd-parameter-list">
695
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
696
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
697
+ </div></li>
698
+ <li><span><span class="tsd-kind-parameter">eventType</span>: <span class="tsd-signature-type">string</span></span></li>
699
+ <li><span><span class="tsd-kind-parameter">customData</span>: <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a></span>
700
+ <div class="tsd-comment tsd-typography"><p>the body of the event</p>
701
+ </div></li></ul></div>
702
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
703
+
704
+ <div class="tsd-comment tsd-typography">
705
+ <div class="tsd-tag-example">
706
+ <h4 class="tsd-anchor-link" id="example-17">Example<a href="#example-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const customData = {
707
+ key1: &#39;val1&#39;,
708
+ key2: &#39;val2&#39;
709
+ };
710
+
711
+ const timestamp = await client.sendCustomEvent(
712
+ &#39;CONVERSATION_ID&#39;,
713
+ &#39;custom:test&#39;,
714
+ customData // or JSON.stringify(customData)
715
+ );
716
+ </code><button type="button">Copy</button></pre>
717
+
718
+ </div></div><aside class="tsd-sources">
719
+ <p>Overrides vonage.CombinedClientJS.sendCustomEvent</p></aside></div></li></ul></section>
720
+ <section class="tsd-panel tsd-member">
721
+ <h3 class="tsd-anchor-link" id="sendephemeralevent"><span>send<wbr/>Ephemeral<wbr/>Event</span><a href="#sendephemeralevent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
722
+ <ul class="tsd-signatures">
723
+ <li class="">
724
+ <div class="tsd-signature tsd-anchor-link" id="sendephemeralevent-1"><span class="tsd-kind-call-signature">sendEphemeralEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">:</span> <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendephemeralevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
725
+ <div class="tsd-description">
726
+ <div class="tsd-comment tsd-typography"><p>Send an ephemeral event to a Conversation</p>
727
+ </div>
728
+ <div class="tsd-parameters">
729
+ <h4 class="tsd-parameters-title">Parameters</h4>
730
+ <ul class="tsd-parameter-list">
731
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
732
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
733
+ </div></li>
734
+ <li><span><span class="tsd-kind-parameter">customData</span>: <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a></span>
735
+ <div class="tsd-comment tsd-typography"><p>the body of the event</p>
736
+ </div></li></ul></div>
737
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
738
+
739
+ <div class="tsd-comment tsd-typography">
740
+ <div class="tsd-tag-example">
741
+ <h4 class="tsd-anchor-link" id="example-18">Example<a href="#example-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const memberId = &#39;MEMBER_ID&#39;;
742
+ const readMessageEvent = {
743
+ type: `${memberId}:readUpdate`,
744
+ eventId: &#39;EVENT_ID&#39;,
745
+ timestamp: &#39;TIMESTAMP&#39;
746
+ };
747
+
748
+ const timestamp = await client.sendEphemeralEvent(
749
+ &#39;CONVERSATION_ID&#39;,
750
+ readMessageEvent // or JSON.stringify(readMessageEvent)
751
+ );
752
+ </code><button type="button">Copy</button></pre>
753
+
754
+ </div></div><aside class="tsd-sources">
755
+ <p>Overrides vonage.CombinedClientJS.sendEphemeralEvent</p></aside></div></li></ul></section>
756
+ <section class="tsd-panel tsd-member">
757
+ <h3 class="tsd-anchor-link" id="sendmessageaudioevent"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
758
+ <ul class="tsd-signatures">
759
+ <li class="">
760
+ <div class="tsd-signature tsd-anchor-link" id="sendmessageaudioevent-1"><span class="tsd-kind-call-signature">sendMessageAudioEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">audioUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">URL</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessageaudioevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
761
+ <div class="tsd-description">
762
+ <div class="tsd-comment tsd-typography"><p>Send a audio message to a Conversation.</p>
763
+ </div>
764
+ <div class="tsd-parameters">
765
+ <h4 class="tsd-parameters-title">Parameters</h4>
766
+ <ul class="tsd-parameter-list">
767
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
768
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
769
+ </div></li>
770
+ <li><span><span class="tsd-kind-parameter">audioUrl</span>: <span class="tsd-signature-type">URL</span></span>
771
+ <div class="tsd-comment tsd-typography"><p>the url of the audio resource.</p>
772
+ </div></li></ul></div>
773
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
774
+
775
+ <div class="tsd-comment tsd-typography">
776
+ <div class="tsd-tag-example">
777
+ <h4 class="tsd-anchor-link" id="example-19">Example<a href="#example-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const timestamp = await client.sendMessageAudioEvent(
778
+ &#39;CONVERSATION_ID&#39;,
779
+ audioURL
780
+ );
781
+ </code><button type="button">Copy</button></pre>
782
+
783
+ </div></div><aside class="tsd-sources">
784
+ <p>Overrides vonage.CombinedClientJS.sendMessageAudioEvent</p></aside></div></li></ul></section>
785
+ <section class="tsd-panel tsd-member">
786
+ <h3 class="tsd-anchor-link" id="sendmessagecustomevent"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
787
+ <ul class="tsd-signatures">
788
+ <li class="">
789
+ <div class="tsd-signature tsd-anchor-link" id="sendmessagecustomevent-1"><span class="tsd-kind-call-signature">sendMessageCustomEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">customData</span><span class="tsd-signature-symbol">:</span> <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessagecustomevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
790
+ <div class="tsd-description">
791
+ <div class="tsd-comment tsd-typography"><p>Send a custom message to a Conversation</p>
792
+ </div>
793
+ <div class="tsd-parameters">
794
+ <h4 class="tsd-parameters-title">Parameters</h4>
795
+ <ul class="tsd-parameter-list">
796
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
797
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
798
+ </div></li>
799
+ <li><span><span class="tsd-kind-parameter">customData</span>: <a href="../types/CustomData.html" class="tsd-signature-type tsd-kind-type-alias">CustomData</a></span>
800
+ <div class="tsd-comment tsd-typography"><p>the body of the message</p>
801
+ </div></li></ul></div>
802
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
803
+
804
+ <div class="tsd-comment tsd-typography">
805
+ <div class="tsd-tag-example">
806
+ <h4 class="tsd-anchor-link" id="example-20">Example<a href="#example-20" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const attachmentPayload = {
807
+ attachment: {
808
+ payload: {
809
+ buttons: [
810
+ {
811
+ payload: &#39;{&quot;&lt;cid&gt;&quot;: &quot;$&quot;,&quot;action&quot;: &quot;connect&quot;,&quot;mid&quot;: &quot;&lt;mid&gt;&quot;}&#39;,
812
+ title: &#39;Connect to an agent&#39;,
813
+ type: &#39;postback&#39;
814
+ }
815
+ ],
816
+ template_type: &#39;button&#39;,
817
+ text: &quot;Hi, My name is Chatbot, Welcome to my chatbot&#39;s corner. How can We help you&quot;
818
+ },
819
+ type: &#39;template&#39;
820
+ }
821
+ };
822
+
823
+ const timestamp = await client.sendMessageCustomEvent(
824
+ &#39;CONVERSATION_ID&#39;,
825
+ attachmentPayload // or JSON.stringify(attachmentPayload)
826
+ );
827
+ </code><button type="button">Copy</button></pre>
828
+
829
+ </div></div><aside class="tsd-sources">
830
+ <p>Overrides vonage.CombinedClientJS.sendMessageCustomEvent</p></aside></div></li></ul></section>
831
+ <section class="tsd-panel tsd-member">
832
+ <h3 class="tsd-anchor-link" id="sendmessagefileevent"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
833
+ <ul class="tsd-signatures">
834
+ <li class="">
835
+ <div class="tsd-signature tsd-anchor-link" id="sendmessagefileevent-1"><span class="tsd-kind-call-signature">sendMessageFileEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">fileUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">URL</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessagefileevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
836
+ <div class="tsd-description">
837
+ <div class="tsd-comment tsd-typography"><p>Send a file message to a Conversation.</p>
838
+ </div>
839
+ <div class="tsd-parameters">
840
+ <h4 class="tsd-parameters-title">Parameters</h4>
841
+ <ul class="tsd-parameter-list">
842
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
843
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
844
+ </div></li>
845
+ <li><span><span class="tsd-kind-parameter">fileUrl</span>: <span class="tsd-signature-type">URL</span></span>
846
+ <div class="tsd-comment tsd-typography"><p>the url of the file resource.</p>
847
+ </div></li></ul></div>
848
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
849
+
850
+ <div class="tsd-comment tsd-typography">
851
+ <div class="tsd-tag-example">
852
+ <h4 class="tsd-anchor-link" id="example-21">Example<a href="#example-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const timestamp = await client.sendMessageFileEvent(
853
+ &#39;CONVERSATION_ID&#39;,
854
+ fileURL
855
+ );
856
+ </code><button type="button">Copy</button></pre>
857
+
858
+ </div></div><aside class="tsd-sources">
859
+ <p>Overrides vonage.CombinedClientJS.sendMessageFileEvent</p></aside></div></li></ul></section>
860
+ <section class="tsd-panel tsd-member">
861
+ <h3 class="tsd-anchor-link" id="sendmessageimageevent"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
862
+ <ul class="tsd-signatures">
863
+ <li class="">
864
+ <div class="tsd-signature tsd-anchor-link" id="sendmessageimageevent-1"><span class="tsd-kind-call-signature">sendMessageImageEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">imageUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">URL</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessageimageevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
865
+ <div class="tsd-description">
866
+ <div class="tsd-comment tsd-typography"><p>Send a Image message to a Conversation.</p>
867
+ </div>
868
+ <div class="tsd-parameters">
869
+ <h4 class="tsd-parameters-title">Parameters</h4>
870
+ <ul class="tsd-parameter-list">
871
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
872
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
873
+ </div></li>
874
+ <li><span><span class="tsd-kind-parameter">imageUrl</span>: <span class="tsd-signature-type">URL</span></span>
875
+ <div class="tsd-comment tsd-typography"><p>the url of the image resource.</p>
876
+ </div></li></ul></div>
877
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
878
+
879
+ <div class="tsd-comment tsd-typography">
880
+ <div class="tsd-tag-example">
881
+ <h4 class="tsd-anchor-link" id="example-22">Example<a href="#example-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const timestamp = await client.sendMessageImageEvent(
882
+ &#39;CONVERSATION_ID&#39;,
883
+ imageUrl
884
+ );
885
+ </code><button type="button">Copy</button></pre>
886
+
887
+ </div></div><aside class="tsd-sources">
888
+ <p>Overrides vonage.CombinedClientJS.sendMessageImageEvent</p></aside></div></li></ul></section>
889
+ <section class="tsd-panel tsd-member">
890
+ <h3 class="tsd-anchor-link" id="sendmessagelocationevent"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
891
+ <ul class="tsd-signatures">
892
+ <li class="">
893
+ <div class="tsd-signature tsd-anchor-link" id="sendmessagelocationevent-1"><span class="tsd-kind-call-signature">sendMessageLocationEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">location</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Location.html" class="tsd-signature-type tsd-kind-interface">Location</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessagelocationevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
894
+ <div class="tsd-description">
895
+ <div class="tsd-comment tsd-typography"><p>Send a Location message to a Conversation.</p>
896
+ </div>
897
+ <div class="tsd-parameters">
898
+ <h4 class="tsd-parameters-title">Parameters</h4>
899
+ <ul class="tsd-parameter-list">
900
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
901
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
902
+ </div></li>
903
+ <li><span><span class="tsd-kind-parameter">location</span>: <a href="../interfaces/Location.html" class="tsd-signature-type tsd-kind-interface">Location</a></span>
904
+ <div class="tsd-comment tsd-typography"><p>the description of the location.</p>
905
+ </div></li></ul></div>
906
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
907
+
908
+ <div class="tsd-comment tsd-typography">
909
+ <div class="tsd-tag-example">
910
+ <h4 class="tsd-anchor-link" id="example-23">Example<a href="#example-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const timestamp = await client.sendMessageLocationEvent(&#39;CONVERSATION_ID&#39;, {
911
+ latitude: &#39;LATITUDE&#39;,
912
+ longitude: &#39;LONGITUDE&#39;,
913
+ name: &#39;Name&#39;, //optional
914
+ address: &#39;Address&#39; //optional
915
+ });
916
+ </code><button type="button">Copy</button></pre>
917
+
918
+ </div></div><aside class="tsd-sources">
919
+ <p>Overrides vonage.CombinedClientJS.sendMessageLocationEvent</p></aside></div></li></ul></section>
920
+ <section class="tsd-panel tsd-member">
921
+ <h3 class="tsd-anchor-link" id="sendmessageseenevent"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
922
+ <ul class="tsd-signatures">
923
+ <li class="">
924
+ <div class="tsd-signature tsd-anchor-link" id="sendmessageseenevent-1"><span class="tsd-kind-call-signature">sendMessageSeenEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">conversationId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessageseenevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
925
+ <div class="tsd-description">
926
+ <div class="tsd-comment tsd-typography"><p>Send a message seen event to a Conversation</p>
927
+ </div>
928
+ <div class="tsd-parameters">
929
+ <h4 class="tsd-parameters-title">Parameters</h4>
930
+ <ul class="tsd-parameter-list">
931
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">number</span></span>
932
+ <div class="tsd-comment tsd-typography"><p>the event id</p>
933
+ </div></li>
934
+ <li><span><span class="tsd-kind-parameter">conversationId</span>: <span class="tsd-signature-type">string</span></span>
935
+ <div class="tsd-comment tsd-typography"><p>the conversation id</p>
936
+ </div></li></ul></div>
937
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
938
+
939
+ <div class="tsd-comment tsd-typography">
940
+ <div class="tsd-tag-example">
941
+ <h4 class="tsd-anchor-link" id="example-24">Example<a href="#example-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const eventId = 0;
942
+
943
+ const timestamp = await client.sendMessageSeenEvent(
944
+ eventId,
945
+ &#39;conversation_id&#39;
946
+ );
947
+ </code><button type="button">Copy</button></pre>
948
+
949
+ </div></div><aside class="tsd-sources">
950
+ <p>Overrides vonage.CombinedClientJS.sendMessageSeenEvent</p></aside></div></li></ul></section>
951
+ <section class="tsd-panel tsd-member">
952
+ <h3 class="tsd-anchor-link" id="sendmessagetemplateevent"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
953
+ <ul class="tsd-signatures">
954
+ <li class="">
955
+ <div class="tsd-signature tsd-anchor-link" id="sendmessagetemplateevent-1"><span class="tsd-kind-call-signature">sendMessageTemplateEvent</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">templateObject</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Template.html" class="tsd-signature-type tsd-kind-interface">Template</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">whatsappObject</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Whatsapp.html" class="tsd-signature-type tsd-kind-interface">Whatsapp</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessagetemplateevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
956
+ <div class="tsd-description">
957
+ <div class="tsd-comment tsd-typography"><p>Send a template message to a Conversation.</p>
958
+ </div>
959
+ <div class="tsd-parameters">
960
+ <h4 class="tsd-parameters-title">Parameters</h4>
961
+ <ul class="tsd-parameter-list">
962
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
963
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
964
+ </div></li>
965
+ <li><span><span class="tsd-kind-parameter">templateObject</span>: <a href="../interfaces/Template.html" class="tsd-signature-type tsd-kind-interface">Template</a></span>
966
+ <div class="tsd-comment tsd-typography"><p>the description(name and paramters) of the template.</p>
967
+ </div></li>
968
+ <li><span><span class="tsd-kind-parameter">whatsappObject</span>: <a href="../interfaces/Whatsapp.html" class="tsd-signature-type tsd-kind-interface">Whatsapp</a></span>
969
+ <div class="tsd-comment tsd-typography"><p>the description(locale and policies of business account) of the location.</p>
970
+ </div></li></ul></div>
971
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
972
+
973
+ <div class="tsd-comment tsd-typography">
974
+ <div class="tsd-tag-example">
975
+ <h4 class="tsd-anchor-link" id="example-25">Example<a href="#example-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const timestamp = await client.sendMessageTemplateEvent(
976
+ &#39;CONVERSATION_ID&#39;,
977
+ {
978
+ name: &#39;name&#39;,
979
+ parameters: [&#39;Params1&#39;] // optional
980
+ },
981
+ {
982
+ policy: &#39;&#39;,
983
+ locale: &#39;&#39;
984
+ }
985
+ );
986
+ </code><button type="button">Copy</button></pre>
987
+
988
+ </div></div><aside class="tsd-sources">
989
+ <p>Overrides vonage.CombinedClientJS.sendMessageTemplateEvent</p></aside></div></li></ul></section>
990
+ <section class="tsd-panel tsd-member">
991
+ <h3 class="tsd-anchor-link" id="sendmessagetextevent"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
992
+ <ul class="tsd-signatures">
993
+ <li class="">
994
+ <div class="tsd-signature tsd-anchor-link" id="sendmessagetextevent-1"><span class="tsd-kind-call-signature">sendMessageTextEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">raw</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessagetextevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
995
+ <div class="tsd-description">
996
+ <div class="tsd-comment tsd-typography"><p>Send a text message to a Conversation</p>
997
+ </div>
998
+ <div class="tsd-parameters">
999
+ <h4 class="tsd-parameters-title">Parameters</h4>
1000
+ <ul class="tsd-parameter-list">
1001
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
1002
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
1003
+ </div></li>
1004
+ <li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span>
1005
+ <div class="tsd-comment tsd-typography"><p>the Body of the message</p>
1006
+ </div></li>
1007
+ <li><span><span class="tsd-kind-parameter">raw</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></span>
1008
+ <div class="tsd-comment tsd-typography"><p>whether to send the text as raw or not (default: false, not recommended)</p>
1009
+ </div></li></ul></div>
1010
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
1011
+
1012
+ <div class="tsd-comment tsd-typography">
1013
+ <div class="tsd-tag-example">
1014
+ <h4 class="tsd-anchor-link" id="example-26">Example<a href="#example-26" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const timestamp = await client.sendMessageTextEvent(
1015
+ &#39;CONVERSATION_ID&#39;,
1016
+ &#39;Hello World!&#39;
1017
+ );
1018
+ </code><button type="button">Copy</button></pre>
1019
+
1020
+ </div></div><aside class="tsd-sources">
1021
+ <p>Overrides vonage.CombinedClientJS.sendMessageTextEvent</p></aside></div></li></ul></section>
1022
+ <section class="tsd-panel tsd-member">
1023
+ <h3 class="tsd-anchor-link" id="sendmessagevcardevent"><span>send<wbr/>Message<wbr/>V<wbr/>Card<wbr/>Event</span><a href="#sendmessagevcardevent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1024
+ <ul class="tsd-signatures">
1025
+ <li class="">
1026
+ <div class="tsd-signature tsd-anchor-link" id="sendmessagevcardevent-1"><span class="tsd-kind-call-signature">sendMessageVCardEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">vCardUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">URL</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessagevcardevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1027
+ <div class="tsd-description">
1028
+ <div class="tsd-comment tsd-typography"><p>Send a vcard message to a Conversation.</p>
1029
+ </div>
1030
+ <div class="tsd-parameters">
1031
+ <h4 class="tsd-parameters-title">Parameters</h4>
1032
+ <ul class="tsd-parameter-list">
1033
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
1034
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
1035
+ </div></li>
1036
+ <li><span><span class="tsd-kind-parameter">vCardUrl</span>: <span class="tsd-signature-type">URL</span></span>
1037
+ <div class="tsd-comment tsd-typography"><p>the url of the vCardUrl resource.</p>
1038
+ </div></li></ul></div>
1039
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
1040
+
1041
+ <div class="tsd-comment tsd-typography">
1042
+ <div class="tsd-tag-example">
1043
+ <h4 class="tsd-anchor-link" id="example-27">Example<a href="#example-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const timestamp = await client.sendMessageVCardEvent(
1044
+ &#39;CONVERSATION_ID&#39;,
1045
+ vCardUrl
1046
+ );
1047
+ </code><button type="button">Copy</button></pre>
1048
+
1049
+ </div></div><aside class="tsd-sources">
1050
+ <p>Overrides vonage.CombinedClientJS.sendMessageVCardEvent</p></aside></div></li></ul></section>
1051
+ <section class="tsd-panel tsd-member">
1052
+ <h3 class="tsd-anchor-link" id="sendmessagevideoevent"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1053
+ <ul class="tsd-signatures">
1054
+ <li class="">
1055
+ <div class="tsd-signature tsd-anchor-link" id="sendmessagevideoevent-1"><span class="tsd-kind-call-signature">sendMessageVideoEvent</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">videoUrl</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">URL</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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendmessagevideoevent-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1056
+ <div class="tsd-description">
1057
+ <div class="tsd-comment tsd-typography"><p>Send a Vidoe message to a Conversation.</p>
1058
+ </div>
1059
+ <div class="tsd-parameters">
1060
+ <h4 class="tsd-parameters-title">Parameters</h4>
1061
+ <ul class="tsd-parameter-list">
1062
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
1063
+ <div class="tsd-comment tsd-typography"><p>the Conversation's id</p>
1064
+ </div></li>
1065
+ <li><span><span class="tsd-kind-parameter">videoUrl</span>: <span class="tsd-signature-type">URL</span></span>
1066
+ <div class="tsd-comment tsd-typography"><p>the url of the video resource.</p>
1067
+ </div></li></ul></div>
1068
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>timestamp</code> of the message</p>
1069
+
1070
+ <div class="tsd-comment tsd-typography">
1071
+ <div class="tsd-tag-example">
1072
+ <h4 class="tsd-anchor-link" id="example-28">Example<a href="#example-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const timestamp = await client.sendMessageVideoEvent(
1073
+ &#39;CONVERSATION_ID&#39;,
1074
+ videoURL
1075
+ );
1076
+ </code><button type="button">Copy</button></pre>
1077
+
1078
+ </div></div><aside class="tsd-sources">
1079
+ <p>Overrides vonage.CombinedClientJS.sendMessageVideoEvent</p></aside></div></li></ul></section></section></details>
1080
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Emergency"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
1081
+ <h2 class="tsd-anchor-link" id="emergency-1">Emergency<a href="#emergency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
1082
+ <section>
1083
+ <section class="tsd-panel tsd-member">
1084
+ <h3 class="tsd-anchor-link" id="disableearmuffemergencycall"><span>disable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span><a href="#disableearmuffemergencycall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1085
+ <ul class="tsd-signatures">
1086
+ <li class="">
1087
+ <div class="tsd-signature tsd-anchor-link" id="disableearmuffemergencycall-1"><span class="tsd-kind-call-signature">disableEarmuffEmergencyCall</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableearmuffemergencycall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1088
+ <div class="tsd-description">
1089
+ <div class="tsd-comment tsd-typography"><p>Disable earmuff for an emergency call.</p>
1090
+ </div>
1091
+ <div class="tsd-parameters">
1092
+ <h4 class="tsd-parameters-title">Parameters</h4>
1093
+ <ul class="tsd-parameter-list">
1094
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1095
+ <div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to disable earmuff for</p>
1096
+ </div></li></ul></div>
1097
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1098
+ <aside class="tsd-sources">
1099
+ <p>Overrides vonage.CombinedClientJS.disableEarmuffEmergencyCall</p></aside></div></li></ul></section>
1100
+ <section class="tsd-panel tsd-member">
1101
+ <h3 class="tsd-anchor-link" id="emergencycall"><span>emergency<wbr/>Call</span><a href="#emergencycall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1102
+ <ul class="tsd-signatures">
1103
+ <li class="">
1104
+ <div class="tsd-signature tsd-anchor-link" id="emergencycall-1"><span class="tsd-kind-call-signature">emergencyCall</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">from</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">to</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">EmergencyCallOptionsJS</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">EmergencyCallDataJS</span><span class="tsd-signature-symbol">&gt;</span><a href="#emergencycall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1105
+ <div class="tsd-description">
1106
+ <div class="tsd-comment tsd-typography"><p>Starts an emergency call.</p>
1107
+ </div>
1108
+ <div class="tsd-parameters">
1109
+ <h4 class="tsd-parameters-title">Parameters</h4>
1110
+ <ul class="tsd-parameter-list">
1111
+ <li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></span></li>
1112
+ <li><span><span class="tsd-kind-parameter">from</span>: <span class="tsd-signature-type">string</span></span></li>
1113
+ <li><span><span class="tsd-kind-parameter">to</span>: <span class="tsd-signature-type">string</span></span></li>
1114
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">EmergencyCallOptionsJS</span><span class="tsd-signature-symbol">&gt;</span></span>
1115
+ <div class="tsd-comment tsd-typography"><p>Optional <a href="../interfaces/EmergencyCallOptions.html" class="tsd-kind-interface">EmergencyCallOptions</a> containing call options</p>
1116
+ </div></li></ul></div>
1117
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">EmergencyCallDataJS</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the result containing <code>callId</code> and <code>reconnectToken</code></p>
1118
+ <aside class="tsd-sources">
1119
+ <p>Overrides vonage.CombinedClientJS.emergencyCall</p></aside></div></li></ul></section>
1120
+ <section class="tsd-panel tsd-member">
1121
+ <h3 class="tsd-anchor-link" id="enableearmuffemergencycall"><span>enable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span><a href="#enableearmuffemergencycall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1122
+ <ul class="tsd-signatures">
1123
+ <li class="">
1124
+ <div class="tsd-signature tsd-anchor-link" id="enableearmuffemergencycall-1"><span class="tsd-kind-call-signature">enableEarmuffEmergencyCall</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableearmuffemergencycall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1125
+ <div class="tsd-description">
1126
+ <div class="tsd-comment tsd-typography"><p>Enable earmuff for an emergency call.</p>
1127
+ </div>
1128
+ <div class="tsd-parameters">
1129
+ <h4 class="tsd-parameters-title">Parameters</h4>
1130
+ <ul class="tsd-parameter-list">
1131
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1132
+ <div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to enable earmuff for</p>
1133
+ </div></li></ul></div>
1134
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1135
+ <aside class="tsd-sources">
1136
+ <p>Overrides vonage.CombinedClientJS.enableEarmuffEmergencyCall</p></aside></div></li></ul></section>
1137
+ <section class="tsd-panel tsd-member">
1138
+ <h3 class="tsd-anchor-link" id="hangupemergencycall"><span>hangup<wbr/>Emergency<wbr/>Call</span><a href="#hangupemergencycall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1139
+ <ul class="tsd-signatures">
1140
+ <li class="">
1141
+ <div class="tsd-signature tsd-anchor-link" id="hangupemergencycall-1"><span class="tsd-kind-call-signature">hangupEmergencyCall</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#hangupemergencycall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1142
+ <div class="tsd-description">
1143
+ <div class="tsd-comment tsd-typography"><p>Hangup an emergency call.</p>
1144
+ </div>
1145
+ <div class="tsd-parameters">
1146
+ <h4 class="tsd-parameters-title">Parameters</h4>
1147
+ <ul class="tsd-parameter-list">
1148
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1149
+ <div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to hangup</p>
1150
+ </div></li></ul></div>
1151
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1152
+ </div></li></ul></section>
1153
+ <section class="tsd-panel tsd-member">
1154
+ <h3 class="tsd-anchor-link" id="muteemergencycall"><span>mute<wbr/>Emergency<wbr/>Call</span><a href="#muteemergencycall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1155
+ <ul class="tsd-signatures">
1156
+ <li class="">
1157
+ <div class="tsd-signature tsd-anchor-link" id="muteemergencycall-1"><span class="tsd-kind-call-signature">muteEmergencyCall</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#muteemergencycall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1158
+ <div class="tsd-description">
1159
+ <div class="tsd-comment tsd-typography"><p>Mute an emergency call.</p>
1160
+ </div>
1161
+ <div class="tsd-parameters">
1162
+ <h4 class="tsd-parameters-title">Parameters</h4>
1163
+ <ul class="tsd-parameter-list">
1164
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1165
+ <div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to mute</p>
1166
+ </div></li></ul></div>
1167
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1168
+ <aside class="tsd-sources">
1169
+ <p>Overrides vonage.CombinedClientJS.muteEmergencyCall</p></aside></div></li></ul></section>
1170
+ <section class="tsd-panel tsd-member">
1171
+ <h3 class="tsd-anchor-link" id="reconnectemergencycall"><span>reconnect<wbr/>Emergency<wbr/>Call</span><a href="#reconnectemergencycall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1172
+ <ul class="tsd-signatures">
1173
+ <li class="">
1174
+ <div class="tsd-signature tsd-anchor-link" id="reconnectemergencycall-1"><span class="tsd-kind-call-signature">reconnectEmergencyCall</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">token</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">reconnectToken</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reconnectemergencycall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1175
+ <div class="tsd-description">
1176
+ <div class="tsd-comment tsd-typography"><p>Reconnects an existing emergency call.</p>
1177
+ </div>
1178
+ <div class="tsd-parameters">
1179
+ <h4 class="tsd-parameters-title">Parameters</h4>
1180
+ <ul class="tsd-parameter-list">
1181
+ <li><span><span class="tsd-kind-parameter">token</span>: <span class="tsd-signature-type">string</span></span></li>
1182
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span></li>
1183
+ <li><span><span class="tsd-kind-parameter">reconnectToken</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
1184
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1185
+ <aside class="tsd-sources">
1186
+ <p>Overrides vonage.CombinedClientJS.reconnectEmergencyCall</p></aside></div></li></ul></section>
1187
+ <section class="tsd-panel tsd-member">
1188
+ <h3 class="tsd-anchor-link" id="unmuteemergencycall"><span>unmute<wbr/>Emergency<wbr/>Call</span><a href="#unmuteemergencycall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1189
+ <ul class="tsd-signatures">
1190
+ <li class="">
1191
+ <div class="tsd-signature tsd-anchor-link" id="unmuteemergencycall-1"><span class="tsd-kind-call-signature">unmuteEmergencyCall</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#unmuteemergencycall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1192
+ <div class="tsd-description">
1193
+ <div class="tsd-comment tsd-typography"><p>Unmute an emergency call.</p>
1194
+ </div>
1195
+ <div class="tsd-parameters">
1196
+ <h4 class="tsd-parameters-title">Parameters</h4>
1197
+ <ul class="tsd-parameter-list">
1198
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1199
+ <div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to unmute</p>
1200
+ </div></li></ul></div>
1201
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1202
+ <aside class="tsd-sources">
1203
+ <p>Overrides vonage.CombinedClientJS.unmuteEmergencyCall</p></aside></div></li></ul></section></section></details>
1204
+ <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Voice"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
1205
+ <h2 class="tsd-anchor-link" id="voice-1">Voice<a href="#voice-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
1206
+ <section>
1207
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1208
+ <h3 class="tsd-anchor-link" id="answer"><span>answer</span><a href="#answer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1209
+ <ul class="tsd-signatures tsd-is-inherited">
1210
+ <li class="tsd-is-inherited">
1211
+ <div class="tsd-signature tsd-anchor-link" id="answer-1"><span class="tsd-kind-call-signature">answer</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#answer-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1212
+ <div class="tsd-description">
1213
+ <div class="tsd-comment tsd-typography"><p>Answer a call</p>
1214
+ </div>
1215
+ <div class="tsd-parameters">
1216
+ <h4 class="tsd-parameters-title">Parameters</h4>
1217
+ <ul class="tsd-parameter-list">
1218
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1219
+ <div class="tsd-comment tsd-typography"><p>Call ID</p>
1220
+ </div></li></ul></div>
1221
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1222
+
1223
+ <div class="tsd-comment tsd-typography">
1224
+ <div class="tsd-tag-example">
1225
+ <h4 class="tsd-anchor-link" id="example-29">Example<a href="#example-29" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const callId = &#39;callId&#39;;
1226
+ await client.answer(callId);
1227
+ </code><button type="button">Copy</button></pre>
1228
+
1229
+ </div></div><aside class="tsd-sources">
1230
+ <p>Inherited from vonage.CombinedClientJS.answer</p></aside></div></li></ul></section>
1231
+ <section class="tsd-panel tsd-member">
1232
+ <h3 class="tsd-anchor-link" id="disableautogaincontrol"><span>disable<wbr/>Auto<wbr/>Gain<wbr/>Control</span><a href="#disableautogaincontrol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1233
+ <ul class="tsd-signatures">
1234
+ <li class="">
1235
+ <div class="tsd-signature tsd-anchor-link" id="disableautogaincontrol-1"><span class="tsd-kind-call-signature">disableAutoGainControl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableautogaincontrol-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1236
+ <div class="tsd-description"><code class="tsd-tag">Experimental</code>
1237
+ <div class="tsd-comment tsd-typography"><p>Disable auto gain control on a call's audio track.</p>
1238
+ </div>
1239
+ <div class="tsd-parameters">
1240
+ <h4 class="tsd-parameters-title">Parameters</h4>
1241
+ <ul class="tsd-parameter-list">
1242
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
1243
+ <div class="tsd-comment tsd-typography"><p>The Call Id</p>
1244
+ </div></li></ul></div>
1245
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1246
+ <p>Overrides vonage.CombinedClientJS.disableAutoGainControl</p></aside></div></li></ul></section>
1247
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1248
+ <h3 class="tsd-anchor-link" id="disableearmuff"><span>disable<wbr/>Earmuff</span><a href="#disableearmuff" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1249
+ <ul class="tsd-signatures tsd-is-inherited">
1250
+ <li class="tsd-is-inherited">
1251
+ <div class="tsd-signature tsd-anchor-link" id="disableearmuff-1"><span class="tsd-kind-call-signature">disableEarmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableearmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1252
+ <div class="tsd-description">
1253
+ <div class="tsd-comment tsd-typography"><p>Unearmuff your leg of a call</p>
1254
+ </div>
1255
+ <div class="tsd-parameters">
1256
+ <h4 class="tsd-parameters-title">Parameters</h4>
1257
+ <ul class="tsd-parameter-list">
1258
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1259
+ <div class="tsd-comment tsd-typography"><p>Call ID</p>
1260
+ </div></li></ul></div>
1261
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1262
+
1263
+ <div class="tsd-comment tsd-typography">
1264
+ <div class="tsd-tag-example">
1265
+ <h4 class="tsd-anchor-link" id="example-30">Example<a href="#example-30" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const callId = &#39;callId&#39;;
1266
+ await client.disableEarmuff(callId);
1267
+ </code><button type="button">Copy</button></pre>
1268
+
1269
+ </div></div><aside class="tsd-sources">
1270
+ <p>Inherited from vonage.CombinedClientJS.disableEarmuff</p></aside></div></li></ul></section>
1271
+ <section class="tsd-panel tsd-member">
1272
+ <h3 class="tsd-anchor-link" id="disableechocancellation"><span>disable<wbr/>Echo<wbr/>Cancellation</span><a href="#disableechocancellation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1273
+ <ul class="tsd-signatures">
1274
+ <li class="">
1275
+ <div class="tsd-signature tsd-anchor-link" id="disableechocancellation-1"><span class="tsd-kind-call-signature">disableEchoCancellation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disableechocancellation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1276
+ <div class="tsd-description"><code class="tsd-tag">Experimental</code>
1277
+ <div class="tsd-comment tsd-typography"><p>Disable echo cancellation on a call's audio track.</p>
1278
+ </div>
1279
+ <div class="tsd-parameters">
1280
+ <h4 class="tsd-parameters-title">Parameters</h4>
1281
+ <ul class="tsd-parameter-list">
1282
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
1283
+ <div class="tsd-comment tsd-typography"><p>The Call Id</p>
1284
+ </div></li></ul></div>
1285
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1286
+ <p>Overrides vonage.CombinedClientJS.disableEchoCancellation</p></aside></div></li></ul></section>
1287
+ <section class="tsd-panel tsd-member">
1288
+ <h3 class="tsd-anchor-link" id="disablenoisesuppression"><span>disable<wbr/>Noise<wbr/>Suppression</span><a href="#disablenoisesuppression" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1289
+ <ul class="tsd-signatures">
1290
+ <li class="">
1291
+ <div class="tsd-signature tsd-anchor-link" id="disablenoisesuppression-1"><span class="tsd-kind-call-signature">disableNoiseSuppression</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#disablenoisesuppression-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1292
+ <div class="tsd-description"><code class="tsd-tag">Experimental</code>
1293
+ <div class="tsd-comment tsd-typography"><p>Disable noise suppression on a call's audio track.</p>
1294
+ </div>
1295
+ <div class="tsd-parameters">
1296
+ <h4 class="tsd-parameters-title">Parameters</h4>
1297
+ <ul class="tsd-parameter-list">
1298
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
1299
+ <div class="tsd-comment tsd-typography"><p>The Call Id</p>
1300
+ </div></li></ul></div>
1301
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1302
+ <p>Overrides vonage.CombinedClientJS.disableNoiseSuppression</p></aside></div></li></ul></section>
1303
+ <section class="tsd-panel tsd-member">
1304
+ <h3 class="tsd-anchor-link" id="enableautogaincontrol"><span>enable<wbr/>Auto<wbr/>Gain<wbr/>Control</span><a href="#enableautogaincontrol" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1305
+ <ul class="tsd-signatures">
1306
+ <li class="">
1307
+ <div class="tsd-signature tsd-anchor-link" id="enableautogaincontrol-1"><span class="tsd-kind-call-signature">enableAutoGainControl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableautogaincontrol-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1308
+ <div class="tsd-description"><code class="tsd-tag">Experimental</code>
1309
+ <div class="tsd-comment tsd-typography"><p>Enable auto gain control on a call's audio track.</p>
1310
+ </div>
1311
+ <div class="tsd-parameters">
1312
+ <h4 class="tsd-parameters-title">Parameters</h4>
1313
+ <ul class="tsd-parameter-list">
1314
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
1315
+ <div class="tsd-comment tsd-typography"><p>The Call Id</p>
1316
+ </div></li></ul></div>
1317
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1318
+ <p>Overrides vonage.CombinedClientJS.enableAutoGainControl</p></aside></div></li></ul></section>
1319
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1320
+ <h3 class="tsd-anchor-link" id="enableearmuff"><span>enable<wbr/>Earmuff</span><a href="#enableearmuff" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1321
+ <ul class="tsd-signatures tsd-is-inherited">
1322
+ <li class="tsd-is-inherited">
1323
+ <div class="tsd-signature tsd-anchor-link" id="enableearmuff-1"><span class="tsd-kind-call-signature">enableEarmuff</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableearmuff-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1324
+ <div class="tsd-description">
1325
+ <div class="tsd-comment tsd-typography"><p>Earmuff your leg of a call</p>
1326
+ </div>
1327
+ <div class="tsd-parameters">
1328
+ <h4 class="tsd-parameters-title">Parameters</h4>
1329
+ <ul class="tsd-parameter-list">
1330
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1331
+ <div class="tsd-comment tsd-typography"><p>Call ID</p>
1332
+ </div></li></ul></div>
1333
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1334
+
1335
+ <div class="tsd-comment tsd-typography">
1336
+ <div class="tsd-tag-example">
1337
+ <h4 class="tsd-anchor-link" id="example-31">Example<a href="#example-31" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const callId = &#39;callId&#39;;
1338
+ await client.enableEarmuff(callId);
1339
+ </code><button type="button">Copy</button></pre>
1340
+
1341
+ </div></div><aside class="tsd-sources">
1342
+ <p>Inherited from vonage.CombinedClientJS.enableEarmuff</p></aside></div></li></ul></section>
1343
+ <section class="tsd-panel tsd-member">
1344
+ <h3 class="tsd-anchor-link" id="enableechocancellation"><span>enable<wbr/>Echo<wbr/>Cancellation</span><a href="#enableechocancellation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1345
+ <ul class="tsd-signatures">
1346
+ <li class="">
1347
+ <div class="tsd-signature tsd-anchor-link" id="enableechocancellation-1"><span class="tsd-kind-call-signature">enableEchoCancellation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enableechocancellation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1348
+ <div class="tsd-description"><code class="tsd-tag">Experimental</code>
1349
+ <div class="tsd-comment tsd-typography"><p>Enable echo cancellation on a call's audio track.</p>
1350
+ </div>
1351
+ <div class="tsd-parameters">
1352
+ <h4 class="tsd-parameters-title">Parameters</h4>
1353
+ <ul class="tsd-parameter-list">
1354
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
1355
+ <div class="tsd-comment tsd-typography"><p>The Call Id</p>
1356
+ </div></li></ul></div>
1357
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1358
+ <p>Overrides vonage.CombinedClientJS.enableEchoCancellation</p></aside></div></li></ul></section>
1359
+ <section class="tsd-panel tsd-member">
1360
+ <h3 class="tsd-anchor-link" id="enablenoisesuppression"><span>enable<wbr/>Noise<wbr/>Suppression</span><a href="#enablenoisesuppression" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1361
+ <ul class="tsd-signatures">
1362
+ <li class="">
1363
+ <div class="tsd-signature tsd-anchor-link" id="enablenoisesuppression-1"><span class="tsd-kind-call-signature">enableNoiseSuppression</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#enablenoisesuppression-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1364
+ <div class="tsd-description"><code class="tsd-tag">Experimental</code>
1365
+ <div class="tsd-comment tsd-typography"><p>Enable noise suppression on a call's audio track.</p>
1366
+ </div>
1367
+ <div class="tsd-parameters">
1368
+ <h4 class="tsd-parameters-title">Parameters</h4>
1369
+ <ul class="tsd-parameter-list">
1370
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
1371
+ <div class="tsd-comment tsd-typography"><p>The Call Id</p>
1372
+ </div></li></ul></div>
1373
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1374
+ <p>Overrides vonage.CombinedClientJS.enableNoiseSuppression</p></aside></div></li></ul></section>
1375
+ <section class="tsd-panel tsd-member">
1376
+ <h3 class="tsd-anchor-link" id="getaudiooutputelement"><span>get<wbr/>Audio<wbr/>Output<wbr/>Element</span><a href="#getaudiooutputelement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1377
+ <ul class="tsd-signatures">
1378
+ <li class="">
1379
+ <div class="tsd-signature tsd-anchor-link" id="getaudiooutputelement-1"><span class="tsd-kind-call-signature">getAudioOutputElement</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">HTMLAudioElement</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#getaudiooutputelement-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1380
+ <div class="tsd-description"><code class="tsd-tag">Experimental</code>
1381
+ <div class="tsd-comment tsd-typography"><p>Get the HTML Audio Element for the SDK.
288
1382
  It can be used to route output to other devices.</p>
289
- </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.getAudioOutputElement</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="../assets/icons.svg#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">&lt;</span><a href="../interfaces/LegsPage.html" class="tsd-signature-type tsd-kind-interface">LegsPage</a><span class="tsd-signature-symbol">&gt;</span><a href="#getCallLegs.getCallLegs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get a Call&#39;s Legs</p>
290
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><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">&lt;</span><a href="../interfaces/GetCallLegsParameters.html" class="tsd-signature-type tsd-kind-interface">GetCallLegsParameters</a><span class="tsd-signature-symbol">&gt;</span></span><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>
291
- </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">&lt;</span><a href="../interfaces/LegsPage.html" class="tsd-signature-type tsd-kind-interface">LegsPage</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>LegsPage</code> containing the legs</p>
292
- <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>
293
- </code><button>Copy</button></pre>
294
- </div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getCallLegs</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getLeg" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Leg</span><a href="#getLeg" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getLeg.getLeg-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Leg</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">LegJS</span><span class="tsd-signature-symbol">&gt;</span><a href="#getLeg.getLeg-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get the Leg for a call</p>
295
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">legId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Leg Id</p>
296
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">LegJS</span><span class="tsd-signature-symbol">&gt;</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getLeg</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getPeerConnection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Peer<wbr/>Connection</span><a href="#getPeerConnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getPeerConnection.getPeerConnection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Peer<wbr/>Connection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RTCPeerConnection</span><a href="#getPeerConnection.getPeerConnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><code class="tsd-tag ts-flagExperimental">Experimental</code> <div class="tsd-comment tsd-typography"><p>Get the Peer Connection for a call</p>
297
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The Call Id</p>
298
- </div><div class="tsd-comment tsd-typography"></div></li></ul></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">RTCPeerConnection</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.getPeerConnection</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="hangup" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>hangup</span><a href="#hangup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="hangup.hangup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">hangup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">reasonText</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">reasonCode</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#hangup.hangup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Hangup a call.</p>
299
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to hangup</p>
300
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">reasonText</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>optional reason text to send to the other party</p>
301
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">reasonCode</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>optional reason code to send to the other party</p>
302
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
303
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_CallHangup</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
304
- </code><button>Copy</button></pre>
305
- </div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.hangup</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="mute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mute</span><a href="#mute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="mute.mute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#mute.mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Mute your leg of a call</p>
306
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Call ID</p>
307
- </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
308
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_Mute</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
309
- </code><button>Copy</button></pre>
310
- </div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.mute</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="reconnectCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reconnect<wbr/>Call</span><a href="#reconnectCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="reconnectCall.reconnectCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reconnect<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reconnectCall.reconnectCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reconnect a call</p>
311
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Call ID</p>
312
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
313
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_ReconnectCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
314
- </code><button>Copy</button></pre>
315
- </div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.reconnectCall</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="reject" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reject</span><a href="#reject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="reject.reject-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reject.reject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Reject a call</p>
316
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Call ID</p>
317
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
318
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_RejectCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
319
- </code><button>Copy</button></pre>
320
- </div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.reject</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="say" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>say</span><a href="#say" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="say.say-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">say</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#say.say-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a TTS message to the Call</p>
321
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to send the message to</p>
322
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the text to send</p>
323
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
324
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.say</p></aside></li><li class="tsd-signature tsd-anchor-link"><a id="say.say-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">say</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#say.say-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends a TTS message to the Call</p>
325
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to send the message to</p>
326
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">params</span>: <a href="../interfaces/CallSayParams.html" class="tsd-signature-type tsd-kind-interface">CallSayParams</a></span><div class="tsd-comment tsd-typography"><p>the <code>CallSayParams</code> to send</p>
327
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
328
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_Say</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
329
- </code><button>Copy</button></pre>
330
- </div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.say</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="sendDTMF" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>sendDTMF</span><a href="#sendDTMF" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="sendDTMF.sendDTMF-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">sendDTMF</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span>, <span class="tsd-kind-parameter">digits</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#sendDTMF.sendDTMF-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Send a string of digits to a call via DTMF</p>
331
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Call ID</p>
332
- </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">digits</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>DTMF digits</p>
333
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
334
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_Dtmf</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
335
- </code><button>Copy</button></pre>
336
- </div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.sendDTMF</p></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="serverCall" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>server<wbr/>Call</span><a href="#serverCall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="serverCall.serverCall-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">server<wbr/>Call</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#serverCall.serverCall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Make a server call to the Vonage API.
1383
+ </div>
1384
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">HTMLAudioElement</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
1385
+ <p>Overrides vonage.CombinedClientJS.getAudioOutputElement</p></aside></div></li></ul></section>
1386
+ <section class="tsd-panel tsd-member">
1387
+ <h3 class="tsd-anchor-link" id="getcalllegs"><span>get<wbr/>Call<wbr/>Legs</span><a href="#getcalllegs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1388
+ <ul class="tsd-signatures">
1389
+ <li class="">
1390
+ <div class="tsd-signature tsd-anchor-link" id="getcalllegs-1"><span class="tsd-kind-call-signature">getCallLegs</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">parameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GetCallLegsParameters.html" class="tsd-signature-type tsd-kind-interface">GetCallLegsParameters</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/LegsPage.html" class="tsd-signature-type tsd-kind-interface">LegsPage</a><span class="tsd-signature-symbol">&gt;</span><a href="#getcalllegs-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1391
+ <div class="tsd-description">
1392
+ <div class="tsd-comment tsd-typography"><p>Get a Call's Legs</p>
1393
+ </div>
1394
+ <div class="tsd-parameters">
1395
+ <h4 class="tsd-parameters-title">Parameters</h4>
1396
+ <ul class="tsd-parameter-list">
1397
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span></li>
1398
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">parameters</span>: <span class="tsd-signature-type">Nullable</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/GetCallLegsParameters.html" class="tsd-signature-type tsd-kind-interface">GetCallLegsParameters</a><span class="tsd-signature-symbol">&gt;</span></span>
1399
+ <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>
1400
+ </div></li></ul></div>
1401
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/LegsPage.html" class="tsd-signature-type tsd-kind-interface">LegsPage</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a <code>LegsPage</code> containing the legs</p>
1402
+
1403
+ <div class="tsd-comment tsd-typography">
1404
+ <div class="tsd-tag-example">
1405
+ <h4 class="tsd-anchor-link" id="example-32">Example<a href="#example-32" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const { legs, nextCursor, previousCursor } = await client.getCallLegs(
1406
+ &#39;callId&#39;,
1407
+ {
1408
+ order: PresentingOrder.DESC,
1409
+ pageSize: 10,
1410
+ cursor: undefined
1411
+ }
1412
+ );
1413
+ </code><button type="button">Copy</button></pre>
1414
+
1415
+ </div></div><aside class="tsd-sources">
1416
+ <p>Overrides vonage.CombinedClientJS.getCallLegs</p></aside></div></li></ul></section>
1417
+ <section class="tsd-panel tsd-member">
1418
+ <h3 class="tsd-anchor-link" id="getleg"><span>get<wbr/>Leg</span><a href="#getleg" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1419
+ <ul class="tsd-signatures">
1420
+ <li class="">
1421
+ <div class="tsd-signature tsd-anchor-link" id="getleg-1"><span class="tsd-kind-call-signature">getLeg</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">legId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">LegJS</span><span class="tsd-signature-symbol">&gt;</span><a href="#getleg-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1422
+ <div class="tsd-description">
1423
+ <div class="tsd-comment tsd-typography"><p>Get the Leg for a call</p>
1424
+ </div>
1425
+ <div class="tsd-parameters">
1426
+ <h4 class="tsd-parameters-title">Parameters</h4>
1427
+ <ul class="tsd-parameter-list">
1428
+ <li><span><span class="tsd-kind-parameter">legId</span>: <span class="tsd-signature-type">string</span></span>
1429
+ <div class="tsd-comment tsd-typography"><p>The Leg Id</p>
1430
+ </div></li></ul></div>
1431
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">LegJS</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
1432
+ <p>Overrides vonage.CombinedClientJS.getLeg</p></aside></div></li></ul></section>
1433
+ <section class="tsd-panel tsd-member">
1434
+ <h3 class="tsd-anchor-link" id="getpeerconnection"><span>get<wbr/>Peer<wbr/>Connection</span><a href="#getpeerconnection" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1435
+ <ul class="tsd-signatures">
1436
+ <li class="">
1437
+ <div class="tsd-signature tsd-anchor-link" id="getpeerconnection-1"><span class="tsd-kind-call-signature">getPeerConnection</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">RTCPeerConnection</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#getpeerconnection-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1438
+ <div class="tsd-description"><code class="tsd-tag">Experimental</code>
1439
+ <div class="tsd-comment tsd-typography"><p>Get the Peer Connection for a call</p>
1440
+ </div>
1441
+ <div class="tsd-parameters">
1442
+ <h4 class="tsd-parameters-title">Parameters</h4>
1443
+ <ul class="tsd-parameter-list">
1444
+ <li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span>
1445
+ <div class="tsd-comment tsd-typography"><p>The Call Id</p>
1446
+ </div></li></ul></div>
1447
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">RTCPeerConnection</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
1448
+ <p>Overrides vonage.CombinedClientJS.getPeerConnection</p></aside></div></li></ul></section>
1449
+ <section class="tsd-panel tsd-member">
1450
+ <h3 class="tsd-anchor-link" id="hangup"><span>hangup</span><a href="#hangup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1451
+ <ul class="tsd-signatures">
1452
+ <li class="">
1453
+ <div class="tsd-signature tsd-anchor-link" id="hangup-1"><span class="tsd-kind-call-signature">hangup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">reasonText</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">reasonCode</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#hangup-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1454
+ <div class="tsd-description">
1455
+ <div class="tsd-comment tsd-typography"><p>Hangup a call.</p>
1456
+ </div>
1457
+ <div class="tsd-parameters">
1458
+ <h4 class="tsd-parameters-title">Parameters</h4>
1459
+ <ul class="tsd-parameter-list">
1460
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1461
+ <div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to hangup</p>
1462
+ </div></li>
1463
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">reasonText</span>: <span class="tsd-signature-type">string</span></span>
1464
+ <div class="tsd-comment tsd-typography"><p>optional reason text to send to the other party</p>
1465
+ </div></li>
1466
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">reasonCode</span>: <span class="tsd-signature-type">string</span></span>
1467
+ <div class="tsd-comment tsd-typography"><p>optional reason code to send to the other party</p>
1468
+ </div></li></ul></div>
1469
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1470
+
1471
+ <div class="tsd-comment tsd-typography">
1472
+ <div class="tsd-tag-example">
1473
+ <h4 class="tsd-anchor-link" id="example-33">Example<a href="#example-33" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const callId = &#39;callId&#39;;
1474
+ await client.hangup(callId);
1475
+ </code><button type="button">Copy</button></pre>
1476
+
1477
+ </div></div><aside class="tsd-sources">
1478
+ <p>Overrides vonage.CombinedClientJS.hangup</p></aside></div></li></ul></section>
1479
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1480
+ <h3 class="tsd-anchor-link" id="mute"><span>mute</span><a href="#mute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1481
+ <ul class="tsd-signatures tsd-is-inherited">
1482
+ <li class="tsd-is-inherited">
1483
+ <div class="tsd-signature tsd-anchor-link" id="mute-1"><span class="tsd-kind-call-signature">mute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#mute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1484
+ <div class="tsd-description">
1485
+ <div class="tsd-comment tsd-typography"><p>Mute your leg of a call</p>
1486
+ </div>
1487
+ <div class="tsd-parameters">
1488
+ <h4 class="tsd-parameters-title">Parameters</h4>
1489
+ <ul class="tsd-parameter-list">
1490
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1491
+ <div class="tsd-comment tsd-typography"><p>Call ID</p>
1492
+ </div></li></ul></div>
1493
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1494
+
1495
+ <div class="tsd-comment tsd-typography">
1496
+ <div class="tsd-tag-example">
1497
+ <h4 class="tsd-anchor-link" id="example-34">Example<a href="#example-34" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const callId = &#39;callId&#39;;
1498
+ await client.mute(callId);
1499
+ </code><button type="button">Copy</button></pre>
1500
+
1501
+ </div></div><aside class="tsd-sources">
1502
+ <p>Inherited from vonage.CombinedClientJS.mute</p></aside></div></li></ul></section>
1503
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1504
+ <h3 class="tsd-anchor-link" id="reconnectcall"><span>reconnect<wbr/>Call</span><a href="#reconnectcall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1505
+ <ul class="tsd-signatures tsd-is-inherited">
1506
+ <li class="tsd-is-inherited">
1507
+ <div class="tsd-signature tsd-anchor-link" id="reconnectcall-1"><span class="tsd-kind-call-signature">reconnectCall</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reconnectcall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1508
+ <div class="tsd-description">
1509
+ <div class="tsd-comment tsd-typography"><p>Reconnect a call</p>
1510
+ </div>
1511
+ <div class="tsd-parameters">
1512
+ <h4 class="tsd-parameters-title">Parameters</h4>
1513
+ <ul class="tsd-parameter-list">
1514
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1515
+ <div class="tsd-comment tsd-typography"><p>Call ID</p>
1516
+ </div></li></ul></div>
1517
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1518
+
1519
+ <div class="tsd-comment tsd-typography">
1520
+ <div class="tsd-tag-example">
1521
+ <h4 class="tsd-anchor-link" id="example-35">Example<a href="#example-35" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const callId = &#39;callId&#39;;
1522
+ await client.reconnectCall(callId);
1523
+ </code><button type="button">Copy</button></pre>
1524
+
1525
+ </div></div><aside class="tsd-sources">
1526
+ <p>Inherited from vonage.CombinedClientJS.reconnectCall</p></aside></div></li></ul></section>
1527
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1528
+ <h3 class="tsd-anchor-link" id="reject"><span>reject</span><a href="#reject" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1529
+ <ul class="tsd-signatures tsd-is-inherited">
1530
+ <li class="tsd-is-inherited">
1531
+ <div class="tsd-signature tsd-anchor-link" id="reject-1"><span class="tsd-kind-call-signature">reject</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#reject-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1532
+ <div class="tsd-description">
1533
+ <div class="tsd-comment tsd-typography"><p>Reject a call</p>
1534
+ </div>
1535
+ <div class="tsd-parameters">
1536
+ <h4 class="tsd-parameters-title">Parameters</h4>
1537
+ <ul class="tsd-parameter-list">
1538
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1539
+ <div class="tsd-comment tsd-typography"><p>Call ID</p>
1540
+ </div></li></ul></div>
1541
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1542
+
1543
+ <div class="tsd-comment tsd-typography">
1544
+ <div class="tsd-tag-example">
1545
+ <h4 class="tsd-anchor-link" id="example-36">Example<a href="#example-36" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const callId = &#39;callId&#39;;
1546
+ await client.reject(callId);
1547
+ </code><button type="button">Copy</button></pre>
1548
+
1549
+ </div></div><aside class="tsd-sources">
1550
+ <p>Inherited from vonage.CombinedClientJS.reject</p></aside></div></li></ul></section>
1551
+ <section class="tsd-panel tsd-member">
1552
+ <h3 class="tsd-anchor-link" id="say"><span>say</span><a href="#say" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1553
+ <ul class="tsd-signatures">
1554
+ <li class="">
1555
+ <div class="tsd-signature tsd-anchor-link" id="say-1"><span class="tsd-kind-call-signature">say</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#say-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1556
+ <div class="tsd-description">
1557
+ <div class="tsd-comment tsd-typography"><p>Sends a TTS message to the Call</p>
1558
+ </div>
1559
+ <div class="tsd-parameters">
1560
+ <h4 class="tsd-parameters-title">Parameters</h4>
1561
+ <ul class="tsd-parameter-list">
1562
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1563
+ <div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to send the message to</p>
1564
+ </div></li>
1565
+ <li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span>
1566
+ <div class="tsd-comment tsd-typography"><p>the text to send</p>
1567
+ </div></li></ul></div>
1568
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1569
+ <aside class="tsd-sources">
1570
+ <p>Overrides vonage.CombinedClientJS.say</p></aside></div></li>
1571
+ <li class="">
1572
+ <div class="tsd-signature tsd-anchor-link" id="say-2"><span class="tsd-kind-call-signature">say</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CallSayParams.html" class="tsd-signature-type tsd-kind-interface">CallSayParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#say-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1573
+ <div class="tsd-description">
1574
+ <div class="tsd-comment tsd-typography"><p>Sends a TTS message to the Call</p>
1575
+ </div>
1576
+ <div class="tsd-parameters">
1577
+ <h4 class="tsd-parameters-title">Parameters</h4>
1578
+ <ul class="tsd-parameter-list">
1579
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1580
+ <div class="tsd-comment tsd-typography"><p>the <code>callId</code> of the call to send the message to</p>
1581
+ </div></li>
1582
+ <li><span><span class="tsd-kind-parameter">params</span>: <a href="../interfaces/CallSayParams.html" class="tsd-signature-type tsd-kind-interface">CallSayParams</a></span>
1583
+ <div class="tsd-comment tsd-typography"><p>the <code>CallSayParams</code> to send</p>
1584
+ </div></li></ul></div>
1585
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1586
+
1587
+ <div class="tsd-comment tsd-typography">
1588
+ <div class="tsd-tag-example">
1589
+ <h4 class="tsd-anchor-link" id="example-37">Example<a href="#example-37" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const callId = &#39;callId&#39;;
1590
+ await client.say(callId, &#39;Hello World&#39;);
1591
+ const ssmlExample =
1592
+ &#39;&lt;speak&gt;Hello World &lt;break strength=&quot;weak&quot;/&gt; I am using &lt;say-as interpret-as=&quot;character&quot;&gt;SSML&lt;/say-as&gt; &lt;break strength=&quot;weak&quot; /&gt; how cool is that? &lt;/speak&gt;&#39;;
1593
+ await client.say(callId, {
1594
+ text: ssmlExample,
1595
+ voiceName: &#39;Kimberly&#39;,
1596
+ ssml: true,
1597
+ level: 1,
1598
+ loop: 2
1599
+ });
1600
+ </code><button type="button">Copy</button></pre>
1601
+
1602
+ </div></div><aside class="tsd-sources">
1603
+ <p>Overrides vonage.CombinedClientJS.say</p></aside></div></li></ul></section>
1604
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1605
+ <h3 class="tsd-anchor-link" id="senddtmf"><span>send<wbr/>DTMF</span><a href="#senddtmf" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1606
+ <ul class="tsd-signatures tsd-is-inherited">
1607
+ <li class="tsd-is-inherited">
1608
+ <div class="tsd-signature tsd-anchor-link" id="senddtmf-1"><span class="tsd-kind-call-signature">sendDTMF</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">digits</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#senddtmf-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1609
+ <div class="tsd-description">
1610
+ <div class="tsd-comment tsd-typography"><p>Send a string of digits to a call via DTMF</p>
1611
+ </div>
1612
+ <div class="tsd-parameters">
1613
+ <h4 class="tsd-parameters-title">Parameters</h4>
1614
+ <ul class="tsd-parameter-list">
1615
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1616
+ <div class="tsd-comment tsd-typography"><p>Call ID</p>
1617
+ </div></li>
1618
+ <li><span><span class="tsd-kind-parameter">digits</span>: <span class="tsd-signature-type">string</span></span>
1619
+ <div class="tsd-comment tsd-typography"><p>DTMF digits</p>
1620
+ </div></li></ul></div>
1621
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1622
+
1623
+ <div class="tsd-comment tsd-typography">
1624
+ <div class="tsd-tag-example">
1625
+ <h4 class="tsd-anchor-link" id="example-38">Example<a href="#example-38" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const callId = &#39;callId&#39;;
1626
+ await client.sendDTMF(callId, &#39;1234&#39;);
1627
+ </code><button type="button">Copy</button></pre>
1628
+
1629
+ </div></div><aside class="tsd-sources">
1630
+ <p>Inherited from vonage.CombinedClientJS.sendDTMF</p></aside></div></li></ul></section>
1631
+ <section class="tsd-panel tsd-member">
1632
+ <h3 class="tsd-anchor-link" id="servercall"><span>server<wbr/>Call</span><a href="#servercall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1633
+ <ul class="tsd-signatures">
1634
+ <li class="">
1635
+ <div class="tsd-signature tsd-anchor-link" id="servercall-1"><span class="tsd-kind-call-signature">serverCall</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Json.html" class="tsd-signature-type tsd-kind-type-alias">Json</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span><a href="#servercall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1636
+ <div class="tsd-description">
1637
+ <div class="tsd-comment tsd-typography"><p>Make a server call to the Vonage API.
337
1638
  This is used to initiate a call using the Voice API and NCCO.</p>
338
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">context</span>: <a href="../types/Json.html" class="tsd-signature-type tsd-kind-type-alias">Json</a></span><div class="tsd-comment tsd-typography"><p>the context to send to the server passed as Custom data to the voice answer webhook</p>
339
- </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">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>callId</code> of the call</p>
340
- <div class="tsd-comment tsd-typography"><h4>Example</h4><pre><code class="language-ts"><span class="hl-1">[[</span><span class="hl-4">include</span><span class="hl-1">: </span><span class="hl-4">snippet_OutboundCall</span><span class="hl-1">.</span><span class="hl-4">txt</span><span class="hl-1">]]</span>
341
- </code><button>Copy</button></pre>
342
- </div><aside class="tsd-sources"><p>Overrides vonage.CombinedClientJS.serverCall</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="unmute" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unmute</span><a href="#unmute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited"><li class="tsd-signature tsd-anchor-link"><a id="unmute.unmute-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#unmute.unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Unmute your leg of a call</p>
343
- </div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Call ID</p>
344
- </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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
345
- <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from vonage.CombinedClientJS.unmute</p></aside></li></ul></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-alpha" name="alpha" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Alpha</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-beta" name="beta" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Beta</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#emergencyCore" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>emergency<wbr/>Core</span></a><a href="#clearCallbacks" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Callbacks</span></a><a href="#createSession" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Session</span></a><a href="#getConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation</span></a><a href="#off" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a><a href="#on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#setConfig" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Config</span></a><a href="#updateConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Conversation</span></a><a href="#createConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Conversation</span></a><a href="#deleteConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Conversation</span></a><a href="#deleteEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Event</span></a><a href="#getConversationEvents" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Events</span></a><a href="#getConversationMember" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Member</span></a><a href="#getConversationMembers" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Members</span></a><a href="#getConversations" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversations</span></a><a href="#inviteToConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>invite<wbr/>To<wbr/>Conversation</span></a><a href="#joinConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>join<wbr/>Conversation</span></a><a href="#leaveConversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Conversation</span></a><a href="#sendCustomEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Custom<wbr/>Event</span></a><a href="#sendEphemeralEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Ephemeral<wbr/>Event</span></a><a href="#sendMessageAudioEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Audio<wbr/>Event</span></a><a href="#sendMessageCustomEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Custom<wbr/>Event</span></a><a href="#sendMessageFileEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>File<wbr/>Event</span></a><a href="#sendMessageImageEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Image<wbr/>Event</span></a><a href="#sendMessageLocationEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Location<wbr/>Event</span></a><a href="#sendMessageSeenEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Seen<wbr/>Event</span></a><a href="#sendMessageTemplateEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Template<wbr/>Event</span></a><a href="#sendMessageTextEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Text<wbr/>Event</span></a><a href="#sendMessageVCardEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>MessageVCard<wbr/>Event</span></a><a href="#sendMessageVideoEvent" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Video<wbr/>Event</span></a><a href="#disableEarmuffEmergencyCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span></a><a href="#emergencyCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emergency<wbr/>Call</span></a><a href="#enableEarmuffEmergencyCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span></a><a href="#hangupEmergencyCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hangup<wbr/>Emergency<wbr/>Call</span></a><a href="#muteEmergencyCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute<wbr/>Emergency<wbr/>Call</span></a><a href="#reconnectEmergencyCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconnect<wbr/>Emergency<wbr/>Call</span></a><a href="#unmuteEmergencyCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute<wbr/>Emergency<wbr/>Call</span></a><a href="#answer" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>answer</span></a><a href="#disableAutoGainControl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Auto<wbr/>Gain<wbr/>Control</span></a><a href="#disableEarmuff" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Earmuff</span></a><a href="#disableEchoCancellation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Echo<wbr/>Cancellation</span></a><a href="#disableNoiseSuppression" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Noise<wbr/>Suppression</span></a><a href="#enableAutoGainControl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Auto<wbr/>Gain<wbr/>Control</span></a><a href="#enableEarmuff" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Earmuff</span></a><a href="#enableEchoCancellation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Echo<wbr/>Cancellation</span></a><a href="#enableNoiseSuppression" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Noise<wbr/>Suppression</span></a><a href="#getAudioOutputElement" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Audio<wbr/>Output<wbr/>Element</span></a><a href="#getCallLegs" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Call<wbr/>Legs</span></a><a href="#getLeg" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Leg</span></a><a href="#getPeerConnection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peer<wbr/>Connection</span></a><a href="#hangup" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hangup</span></a><a href="#mute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute</span></a><a href="#reconnectCall" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconnect<wbr/>Call</span></a><a href="#reject" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reject</span></a><a href="#say" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>say</span></a><a href="#sendDTMF" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>sendDTMF</span></a><a href="#serverCall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>server<wbr/>Call</span></a><a href="#unmute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@vonage/client-sdk - v0.0.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>
1639
+ </div>
1640
+ <div class="tsd-parameters">
1641
+ <h4 class="tsd-parameters-title">Parameters</h4>
1642
+ <ul class="tsd-parameter-list">
1643
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <a href="../types/Json.html" class="tsd-signature-type tsd-kind-type-alias">Json</a></span>
1644
+ <div class="tsd-comment tsd-typography"><p>the context to send to the server passed as Custom data to the voice answer webhook</p>
1645
+ </div></li></ul></div>
1646
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4><p>the <code>callId</code> of the call</p>
1647
+
1648
+ <div class="tsd-comment tsd-typography">
1649
+ <div class="tsd-tag-example">
1650
+ <h4 class="tsd-anchor-link" id="example-39">Example<a href="#example-39" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="txt">const context = {
1651
+ callee: &#39;user1&#39;
1652
+ };
1653
+
1654
+ const callId = await client.serverCall(context);
1655
+ </code><button type="button">Copy</button></pre>
1656
+
1657
+ </div></div><aside class="tsd-sources">
1658
+ <p>Overrides vonage.CombinedClientJS.serverCall</p></aside></div></li></ul></section>
1659
+ <section class="tsd-panel tsd-member tsd-is-inherited">
1660
+ <h3 class="tsd-anchor-link" id="unmute"><span>unmute</span><a href="#unmute" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
1661
+ <ul class="tsd-signatures tsd-is-inherited">
1662
+ <li class="tsd-is-inherited">
1663
+ <div class="tsd-signature tsd-anchor-link" id="unmute-1"><span class="tsd-kind-call-signature">unmute</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">callId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span><a href="#unmute-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
1664
+ <div class="tsd-description">
1665
+ <div class="tsd-comment tsd-typography"><p>Unmute your leg of a call</p>
1666
+ </div>
1667
+ <div class="tsd-parameters">
1668
+ <h4 class="tsd-parameters-title">Parameters</h4>
1669
+ <ul class="tsd-parameter-list">
1670
+ <li><span><span class="tsd-kind-parameter">callId</span>: <span class="tsd-signature-type">string</span></span>
1671
+ <div class="tsd-comment tsd-typography"><p>Call ID</p>
1672
+ </div></li></ul></div>
1673
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><p>void</p>
1674
+ <aside class="tsd-sources">
1675
+ <p>Inherited from vonage.CombinedClientJS.unmute</p></aside></div></li></ul></section></section></details></div>
1676
+ <div class="col-sidebar">
1677
+ <div class="page-menu">
1678
+ <div class="tsd-navigation settings">
1679
+ <details class="tsd-accordion"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
1680
+ <h3>Settings</h3></summary>
1681
+ <div class="tsd-accordion-details">
1682
+ <div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
1683
+ <ul id="tsd-filter-options">
1684
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li>
1685
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li>
1686
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li>
1687
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-alpha" name="alpha" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Alpha</span></label></li>
1688
+ <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-beta" name="beta" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Beta</span></label></li></ul></div>
1689
+ <div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div>
1690
+ <details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
1691
+ <h3>On This Page</h3></summary>
1692
+ <div class="tsd-accordion-details">
1693
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary>
1694
+ <div><a href="#emergencycore" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>emergency<wbr/>Core</span></a></div></details>
1695
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
1696
+ <div><a href="#clearcallbacks"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>clear<wbr/>Callbacks</span></a><a href="#createsession"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Session</span></a><a href="#getconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation</span></a><a href="#off"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>off</span></a><a href="#on"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#setconfig"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Config</span></a><a href="#updateconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>update<wbr/>Conversation</span></a></div></details>
1697
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Chat"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Chat</summary>
1698
+ <div><a href="#createconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Conversation</span></a><a href="#deleteconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Conversation</span></a><a href="#deleteevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>delete<wbr/>Event</span></a><a href="#getconversationevents"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Events</span></a><a href="#getconversationmember" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Member</span></a><a href="#getconversationmembers"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversation<wbr/>Members</span></a><a href="#getconversations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Conversations</span></a><a href="#invitetoconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>invite<wbr/>To<wbr/>Conversation</span></a><a href="#joinconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>join<wbr/>Conversation</span></a><a href="#leaveconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Conversation</span></a><a href="#sendcustomevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Custom<wbr/>Event</span></a><a href="#sendephemeralevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Ephemeral<wbr/>Event</span></a><a href="#sendmessageaudioevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Audio<wbr/>Event</span></a><a href="#sendmessagecustomevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Custom<wbr/>Event</span></a><a href="#sendmessagefileevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>File<wbr/>Event</span></a><a href="#sendmessageimageevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Image<wbr/>Event</span></a><a href="#sendmessagelocationevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Location<wbr/>Event</span></a><a href="#sendmessageseenevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Seen<wbr/>Event</span></a><a href="#sendmessagetemplateevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Template<wbr/>Event</span></a><a href="#sendmessagetextevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Text<wbr/>Event</span></a><a href="#sendmessagevcardevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>V<wbr/>Card<wbr/>Event</span></a><a href="#sendmessagevideoevent"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Message<wbr/>Video<wbr/>Event</span></a></div></details>
1699
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Emergency"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Emergency</summary>
1700
+ <div><a href="#disableearmuffemergencycall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span></a><a href="#emergencycall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emergency<wbr/>Call</span></a><a href="#enableearmuffemergencycall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Earmuff<wbr/>Emergency<wbr/>Call</span></a><a href="#hangupemergencycall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hangup<wbr/>Emergency<wbr/>Call</span></a><a href="#muteemergencycall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute<wbr/>Emergency<wbr/>Call</span></a><a href="#reconnectemergencycall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconnect<wbr/>Emergency<wbr/>Call</span></a><a href="#unmuteemergencycall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute<wbr/>Emergency<wbr/>Call</span></a></div></details>
1701
+ <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Voice"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Voice</summary>
1702
+ <div><a href="#answer" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>answer</span></a><a href="#disableautogaincontrol"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Auto<wbr/>Gain<wbr/>Control</span></a><a href="#disableearmuff" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Earmuff</span></a><a href="#disableechocancellation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Echo<wbr/>Cancellation</span></a><a href="#disablenoisesuppression"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disable<wbr/>Noise<wbr/>Suppression</span></a><a href="#enableautogaincontrol"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Auto<wbr/>Gain<wbr/>Control</span></a><a href="#enableearmuff" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Earmuff</span></a><a href="#enableechocancellation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Echo<wbr/>Cancellation</span></a><a href="#enablenoisesuppression"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>enable<wbr/>Noise<wbr/>Suppression</span></a><a href="#getaudiooutputelement"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Audio<wbr/>Output<wbr/>Element</span></a><a href="#getcalllegs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Call<wbr/>Legs</span></a><a href="#getleg"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Leg</span></a><a href="#getpeerconnection"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Peer<wbr/>Connection</span></a><a href="#hangup"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>hangup</span></a><a href="#mute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute</span></a><a href="#reconnectcall" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reconnect<wbr/>Call</span></a><a href="#reject" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reject</span></a><a href="#say"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>say</span></a><a href="#senddtmf" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>DTMF</span></a><a href="#servercall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>server<wbr/>Call</span></a><a href="#unmute" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute</span></a></div></details></div></details></div>
1703
+ <div class="site-menu">
1704
+ <nav class="tsd-navigation"><a href="../modules.html">@vonage/client-sdk - v0.0.0</a>
1705
+ <ul class="tsd-small-nested-navigation" id="tsd-nav-container">
1706
+ <li>Loading...</li></ul></nav></div></div></div><footer></footer>
1707
+ <div class="overlay"></div></body></html>