@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.
- package/api_docs/ts/assets/hierarchy.js +1 -0
- package/api_docs/ts/assets/highlight.css +1 -1
- package/api_docs/ts/assets/icons.js +17 -14
- package/api_docs/ts/assets/icons.svg +1 -1
- package/api_docs/ts/assets/main.js +5 -4
- package/api_docs/ts/assets/navigation.js +1 -1
- package/api_docs/ts/assets/search.js +1 -1
- package/api_docs/ts/assets/style.css +1460 -1224
- package/api_docs/ts/classes/ClientConfig.html +207 -16
- package/api_docs/ts/classes/ClientInitConfig.html +130 -14
- package/api_docs/ts/classes/VonageClient.html +1697 -335
- package/api_docs/ts/enums/CallDisconnectReason.html +54 -3
- package/api_docs/ts/enums/CancelReason.html +66 -6
- package/api_docs/ts/enums/HangupReason.html +70 -7
- package/api_docs/ts/enums/LegStatus.html +62 -5
- package/api_docs/ts/enums/LoggingLevel.html +74 -8
- package/api_docs/ts/enums/MemberChannelType.html +94 -13
- package/api_docs/ts/enums/OrderBy.html +58 -2
- package/api_docs/ts/enums/PresentingOrder.html +62 -8
- package/api_docs/ts/enums/SessionErrorReason.html +62 -5
- package/api_docs/ts/enums/VoiceChannelType.html +66 -6
- package/api_docs/ts/enums/VonageErrorType.html +70 -7
- package/api_docs/ts/functions/none.html +42 -2
- package/api_docs/ts/functions/some.html +48 -3
- package/api_docs/ts/hierarchy.html +30 -0
- package/api_docs/ts/index.html +102 -26
- package/api_docs/ts/interfaces/CallSayParams.html +75 -8
- package/api_docs/ts/interfaces/Channel.html +67 -6
- package/api_docs/ts/interfaces/Conversation.html +127 -20
- package/api_docs/ts/interfaces/ConversationProperties.html +75 -8
- package/api_docs/ts/interfaces/ConversationTimestamp.html +75 -5
- package/api_docs/ts/interfaces/ConversationsPage.html +81 -8
- package/api_docs/ts/interfaces/CreateConversationParameters.html +88 -15
- package/api_docs/ts/interfaces/EmergencyCallData.html +67 -6
- package/api_docs/ts/interfaces/EmergencyCallOptions.html +57 -4
- package/api_docs/ts/interfaces/EphemeralConversationEvent.html +81 -12
- package/api_docs/ts/interfaces/EventsPage.html +81 -8
- package/api_docs/ts/interfaces/GetCallLegsParameters.html +69 -8
- package/api_docs/ts/interfaces/GetConversationEventsParameters.html +87 -14
- package/api_docs/ts/interfaces/GetConversationMembersParameters.html +69 -8
- package/api_docs/ts/interfaces/GetConversationsParameters.html +81 -12
- package/api_docs/ts/interfaces/Leg.html +131 -21
- package/api_docs/ts/interfaces/LegChannel.html +75 -8
- package/api_docs/ts/interfaces/LegsPage.html +81 -8
- package/api_docs/ts/interfaces/Location.html +67 -6
- package/api_docs/ts/interfaces/Member.html +81 -12
- package/api_docs/ts/interfaces/MemberChannel.html +69 -8
- package/api_docs/ts/interfaces/MemberEventBody.html +75 -7
- package/api_docs/ts/interfaces/MemberTimestamp.html +75 -5
- package/api_docs/ts/interfaces/MembersPage.html +81 -8
- package/api_docs/ts/interfaces/MessageAudioEventBody.html +67 -5
- package/api_docs/ts/interfaces/MessageCustomEventBody.html +67 -5
- package/api_docs/ts/interfaces/MessageFileEventBody.html +67 -6
- package/api_docs/ts/interfaces/MessageImageEventBody.html +67 -6
- package/api_docs/ts/interfaces/MessageLocationEventBody.html +67 -6
- package/api_docs/ts/interfaces/MessageTemplateEventBody.html +93 -9
- package/api_docs/ts/interfaces/MessageTextEventBody.html +67 -6
- package/api_docs/ts/interfaces/MessageVCardEventBody.html +67 -6
- package/api_docs/ts/interfaces/MessageVideoEventBody.html +67 -6
- package/api_docs/ts/interfaces/RTCQuality.html +123 -11
- package/api_docs/ts/interfaces/RtcStats.html +179 -18
- package/api_docs/ts/interfaces/Template.html +59 -4
- package/api_docs/ts/interfaces/UpdateConversationParameters.html +87 -14
- package/api_docs/ts/interfaces/User.html +107 -16
- package/api_docs/ts/interfaces/UserChannels.html +139 -13
- package/api_docs/ts/interfaces/UserTimestamp.html +75 -5
- package/api_docs/ts/interfaces/VonageError.html +89 -12
- package/api_docs/ts/interfaces/VonageEvent.html +131 -22
- package/api_docs/ts/interfaces/Whatsapp.html +59 -4
- package/api_docs/ts/modules.html +69 -74
- package/api_docs/ts/types/ClientConfigObject.html +52 -5
- package/api_docs/ts/types/ClientInitConfigObject.html +59 -4
- package/api_docs/ts/types/ConfigRegion.html +34 -2
- package/api_docs/ts/types/ConversationEvent.html +34 -2
- package/api_docs/ts/types/CustomData.html +34 -2
- package/api_docs/ts/types/Json.html +34 -2
- package/api_docs/ts/types/JsonValue.html +34 -2
- package/api_docs/ts/types/MemberStatus.html +34 -2
- package/api_docs/ts/types/Option.html +38 -2
- package/api_docs/ts/types/PersistentConversationEvent.html +34 -2
- package/api_docs/ts/types/Topics.html +34 -2
- package/api_docs/ts/types/VonageLogger.html +59 -4
- package/api_docs/ts/variables/Topics.html +34 -0
- package/api_docs/ts/variables/VonageError.html +38 -0
- package/dist/client/VonageClient.d.ts +704 -704
- package/dist/client/index.cjs +45072 -36319
- package/dist/client/index.d.ts +2 -2
- package/dist/client/index.mjs +44700 -35947
- package/dist/coreExtend.d.ts +107 -107
- package/dist/kotlin/JsUnions.d.ts +443 -443
- package/dist/kotlin/clientsdk-clientcore_js.d.ts +724 -145
- package/dist/utils/ClientConfig.d.ts +104 -104
- package/dist/utils/ConversationEventBodies.d.ts +125 -125
- package/dist/utils/ConversationModels.d.ts +170 -170
- package/dist/utils/Enums.d.ts +56 -56
- package/dist/utils/ErrorModels.d.ts +23 -23
- package/dist/utils/JsonUtils.d.ts +15 -15
- package/dist/utils/Option.d.ts +19 -19
- package/dist/utils/RequestParameterModels.d.ts +134 -134
- package/dist/utils/index.d.ts +10 -10
- package/dist/utils/jsEnumToVonageObject.d.ts +10 -10
- package/dist/utils/logging.d.ts +53 -53
- package/dist/utils/vonage.d.ts +2 -2
- package/dist/vonageClientSDK.js +44299 -35558
- package/dist/vonageClientSDK.min.js +25 -25
- package/dist/vonageClientSDK.min.mjs +26 -26
- package/dist/vonageClientSDK.mjs +44299 -35558
- package/package.json +6 -6
- package/typedoc.json +3 -0
- package/api_docs/ts/variables/Topics-1.html +0 -2
- package/api_docs/ts/variables/VonageError-1.html +0 -3
|
@@ -1,16 +1,207 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
2
|
-
|
|
3
|
-
<
|
|
4
|
-
<
|
|
5
|
-
<
|
|
6
|
-
<a href="
|
|
7
|
-
<
|
|
8
|
-
<
|
|
9
|
-
<
|
|
10
|
-
<
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="ClientConfig.html" class="tsd-signature-type tsd-kind-class">ClientConfig</a></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Overrides vonage.CoreClientConfigJS.constructor</p></aside></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Accessors</h2><section class="tsd-panel tsd-member tsd-is-inherited"><a id="apiUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>api<wbr/>Url</span><a href="#apiUrl" 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="apiUrl.apiUrl-1"><span class="tsd-signature-keyword">get</span> apiUrl<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.apiUrl</p></aside></li><li class="tsd-signature" id="apiUrl.apiUrl-2"><span class="tsd-signature-keyword">set</span> apiUrl<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.apiUrl</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="autoReconnectMedia" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>auto<wbr/>Reconnect<wbr/>Media</span><a href="#autoReconnectMedia" 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="autoReconnectMedia.autoReconnectMedia-1"><span class="tsd-signature-keyword">get</span> autoReconnectMedia<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.autoReconnectMedia</p></aside></li><li class="tsd-signature" id="autoReconnectMedia.autoReconnectMedia-2"><span class="tsd-signature-keyword">set</span> autoReconnectMedia<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.autoReconnectMedia</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="emergencyPrimaryRegion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emergency<wbr/>Primary<wbr/>Region</span><a href="#emergencyPrimaryRegion" 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="emergencyPrimaryRegion.emergencyPrimaryRegion-1"><span class="tsd-signature-keyword">get</span> emergencyPrimaryRegion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.emergencyPrimaryRegion</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="emergencySecondaryRegion" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emergency<wbr/>Secondary<wbr/>Region</span><a href="#emergencySecondaryRegion" 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="emergencySecondaryRegion.emergencySecondaryRegion-1"><span class="tsd-signature-keyword">get</span> emergencySecondaryRegion<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.emergencySecondaryRegion</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="noiseSuppression" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>noise<wbr/>Suppression</span><a href="#noiseSuppression" 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="noiseSuppression.noiseSuppression-1"><span class="tsd-signature-keyword">get</span> noiseSuppression<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.noiseSuppression</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="region" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>region</span><a href="#region" 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="region.region-1"><span class="tsd-signature-keyword">get</span> region<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">CoreClientConfigRegionJS</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CoreClientConfigRegionJS</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.region</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="rtcStatsTelemetry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>rtc<wbr/>Stats<wbr/>Telemetry</span><a href="#rtcStatsTelemetry" 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="rtcStatsTelemetry.rtcStatsTelemetry-1"><span class="tsd-signature-keyword">get</span> rtcStatsTelemetry<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.rtcStatsTelemetry</p></aside></li><li class="tsd-signature" id="rtcStatsTelemetry.rtcStatsTelemetry-2"><span class="tsd-signature-keyword">set</span> rtcStatsTelemetry<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.rtcStatsTelemetry</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="websocketPath" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>websocket<wbr/>Path</span><a href="#websocketPath" 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="websocketPath.websocketPath-1"><span class="tsd-signature-keyword">get</span> websocketPath<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.websocketPath</p></aside></li><li class="tsd-signature" id="websocketPath.websocketPath-2"><span class="tsd-signature-keyword">set</span> websocketPath<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.websocketPath</p></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited"><a id="websocketUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>websocket<wbr/>Url</span><a href="#websocketUrl" 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="websocketUrl.websocketUrl-1"><span class="tsd-signature-keyword">get</span> websocketUrl<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.websocketUrl</p></aside></li><li class="tsd-signature" id="websocketUrl.websocketUrl-2"><span class="tsd-signature-keyword">set</span> websocketUrl<span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from vonage.CoreClientConfigJS.websocketUrl</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="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a><a href="#apiUrl" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>api<wbr/>Url</span></a><a href="#autoReconnectMedia" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>auto<wbr/>Reconnect<wbr/>Media</span></a><a href="#emergencyPrimaryRegion" 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/>Primary<wbr/>Region</span></a><a href="#emergencySecondaryRegion" 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/>Secondary<wbr/>Region</span></a><a href="#noiseSuppression" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>noise<wbr/>Suppression</span></a><a href="#region" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>region</span></a><a href="#rtcStatsTelemetry" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>rtc<wbr/>Stats<wbr/>Telemetry</span></a><a href="#websocketPath" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>websocket<wbr/>Path</span></a><a href="#websocketUrl" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-262144"></use></svg><span>websocket<wbr/>Url</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>
|
|
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>ClientConfig | @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">ClientConfig</a></li></ul>
|
|
12
|
+
<h1>Class ClientConfig</h1></div>
|
|
13
|
+
<section class="tsd-panel tsd-hierarchy" data-refl="972">
|
|
14
|
+
<h4>Hierarchy</h4>
|
|
15
|
+
<ul class="tsd-hierarchy">
|
|
16
|
+
<li class="tsd-hierarchy-item"><span class="tsd-signature-type">CoreClientConfigJS</span>
|
|
17
|
+
<ul class="tsd-hierarchy">
|
|
18
|
+
<li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ClientConfig</span></li></ul></li></ul></section>
|
|
19
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
20
|
+
<section class="tsd-panel tsd-index-panel">
|
|
21
|
+
<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>
|
|
22
|
+
<h5 class="tsd-index-heading uppercase">Index</h5></summary>
|
|
23
|
+
<div class="tsd-accordion-details">
|
|
24
|
+
<section class="tsd-index-section">
|
|
25
|
+
<h3 class="tsd-index-heading tsd-anchor-link" id="constructors">Constructors<a href="#constructors" 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>
|
|
26
|
+
<div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
27
|
+
</div></section>
|
|
28
|
+
<section class="tsd-index-section">
|
|
29
|
+
<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>
|
|
30
|
+
<div class="tsd-index-list"><a href="#apiurl" 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>api<wbr/>Url</span></a>
|
|
31
|
+
<a href="#autoreconnectmedia" 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>auto<wbr/>Reconnect<wbr/>Media</span></a>
|
|
32
|
+
<a href="#emergencyprimaryregion" 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/>Primary<wbr/>Region</span></a>
|
|
33
|
+
<a href="#emergencysecondaryregion" 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/>Secondary<wbr/>Region</span></a>
|
|
34
|
+
<a href="#noisesuppression" 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>noise<wbr/>Suppression</span></a>
|
|
35
|
+
<a href="#region" 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>region</span></a>
|
|
36
|
+
<a href="#rtcstatstelemetry" 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>rtc<wbr/>Stats<wbr/>Telemetry</span></a>
|
|
37
|
+
<a href="#websocketpath" 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>websocket<wbr/>Path</span></a>
|
|
38
|
+
<a href="#websocketurl" 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>websocket<wbr/>Url</span></a>
|
|
39
|
+
</div></section></div></details></section></section>
|
|
40
|
+
<details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
|
|
41
|
+
<h2 class="tsd-anchor-link" id="constructors-1">Constructors<a href="#constructors-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>
|
|
42
|
+
<section>
|
|
43
|
+
<section class="tsd-panel tsd-member">
|
|
44
|
+
<h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" 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>
|
|
45
|
+
<ul class="tsd-signatures">
|
|
46
|
+
<li class="">
|
|
47
|
+
<div class="tsd-signature tsd-anchor-link" id="constructorclientconfig"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ClientConfig</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">region</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ConfigRegion.html" class="tsd-signature-type tsd-kind-type-alias">ConfigRegion</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ClientConfig</a><a href="#constructorclientconfig" 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>
|
|
48
|
+
<div class="tsd-description">
|
|
49
|
+
<div class="tsd-comment tsd-typography"><p>Constructs a new instance of the class.</p>
|
|
50
|
+
</div>
|
|
51
|
+
<div class="tsd-parameters">
|
|
52
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
53
|
+
<ul class="tsd-parameter-list">
|
|
54
|
+
<li><span><span class="tsd-kind-parameter">region</span>: <a href="../types/ConfigRegion.html" class="tsd-signature-type tsd-kind-type-alias">ConfigRegion</a><span class="tsd-signature-symbol"> = vonage.DEFAULT_REGION</span></span>
|
|
55
|
+
<div class="tsd-comment tsd-typography"><p>The region where the API and WebSocket URLs should be configured.
|
|
56
|
+
Valid values are "EU" (Europe), "US" (United States), or "AP" (Asia Pacific).
|
|
57
|
+
The URLs will be automatically set based on the selected region.
|
|
58
|
+
Defaults to "US" if no region is specified.</p>
|
|
59
|
+
</div></li></ul></div>
|
|
60
|
+
<h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ClientConfig</a></h4><aside class="tsd-sources">
|
|
61
|
+
<p>Overrides vonage.CoreClientConfigJS.constructor</p></aside></div></li></ul></section></section></details>
|
|
62
|
+
<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>
|
|
63
|
+
<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>
|
|
64
|
+
<section>
|
|
65
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
66
|
+
<h3 class="tsd-anchor-link" id="apiurl"><span>api<wbr/>Url</span><a href="#apiurl" 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>
|
|
67
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
68
|
+
<li>
|
|
69
|
+
<div class="tsd-signature" id="apiurlapiurl"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">apiUrl</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
70
|
+
<div class="tsd-description">
|
|
71
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
72
|
+
<p>Inherited from vonage.CoreClientConfigJS.apiUrl</p></aside></div></li>
|
|
73
|
+
<li>
|
|
74
|
+
<div class="tsd-signature" id="apiurlapiurl-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">apiUrl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">void</span></div>
|
|
75
|
+
<div class="tsd-description">
|
|
76
|
+
<div class="tsd-parameters">
|
|
77
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
78
|
+
<ul class="tsd-parameter-list">
|
|
79
|
+
<li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
|
|
80
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
81
|
+
<p>Inherited from vonage.CoreClientConfigJS.apiUrl</p></aside></div></li></ul></section>
|
|
82
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
83
|
+
<h3 class="tsd-anchor-link" id="autoreconnectmedia"><span>auto<wbr/>Reconnect<wbr/>Media</span><a href="#autoreconnectmedia" 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>
|
|
84
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
85
|
+
<li>
|
|
86
|
+
<div class="tsd-signature" id="autoreconnectmediaautoreconnectmedia"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">autoReconnectMedia</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
87
|
+
<div class="tsd-description">
|
|
88
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
89
|
+
<p>Inherited from vonage.CoreClientConfigJS.autoReconnectMedia</p></aside></div></li>
|
|
90
|
+
<li>
|
|
91
|
+
<div class="tsd-signature" id="autoreconnectmediaautoreconnectmedia-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">autoReconnectMedia</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">void</span></div>
|
|
92
|
+
<div class="tsd-description">
|
|
93
|
+
<div class="tsd-parameters">
|
|
94
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
95
|
+
<ul class="tsd-parameter-list">
|
|
96
|
+
<li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
|
|
97
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
98
|
+
<p>Inherited from vonage.CoreClientConfigJS.autoReconnectMedia</p></aside></div></li></ul></section>
|
|
99
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
100
|
+
<h3 class="tsd-anchor-link" id="emergencyprimaryregion"><span>emergency<wbr/>Primary<wbr/>Region</span><a href="#emergencyprimaryregion" 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>
|
|
101
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
102
|
+
<li>
|
|
103
|
+
<div class="tsd-signature" id="emergencyprimaryregionemergencyprimaryregion"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">emergencyPrimaryRegion</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
104
|
+
<div class="tsd-description">
|
|
105
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
106
|
+
<p>Inherited from vonage.CoreClientConfigJS.emergencyPrimaryRegion</p></aside></div></li></ul></section>
|
|
107
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
108
|
+
<h3 class="tsd-anchor-link" id="emergencysecondaryregion"><span>emergency<wbr/>Secondary<wbr/>Region</span><a href="#emergencysecondaryregion" 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>
|
|
109
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
110
|
+
<li>
|
|
111
|
+
<div class="tsd-signature" id="emergencysecondaryregionemergencysecondaryregion"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">emergencySecondaryRegion</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
112
|
+
<div class="tsd-description">
|
|
113
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
114
|
+
<p>Inherited from vonage.CoreClientConfigJS.emergencySecondaryRegion</p></aside></div></li></ul></section>
|
|
115
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
116
|
+
<h3 class="tsd-anchor-link" id="noisesuppression"><span>noise<wbr/>Suppression</span><a href="#noisesuppression" 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>
|
|
117
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
118
|
+
<li>
|
|
119
|
+
<div class="tsd-signature" id="noisesuppressionnoisesuppression"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">noiseSuppression</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
120
|
+
<div class="tsd-description">
|
|
121
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
122
|
+
<p>Inherited from vonage.CoreClientConfigJS.noiseSuppression</p></aside></div></li></ul></section>
|
|
123
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
124
|
+
<h3 class="tsd-anchor-link" id="region"><span>region</span><a href="#region" 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>
|
|
125
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
126
|
+
<li>
|
|
127
|
+
<div class="tsd-signature" id="regionregion"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">region</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">CoreClientConfigRegionJS</span></div>
|
|
128
|
+
<div class="tsd-description">
|
|
129
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">CoreClientConfigRegionJS</span></h4><aside class="tsd-sources">
|
|
130
|
+
<p>Inherited from vonage.CoreClientConfigJS.region</p></aside></div></li></ul></section>
|
|
131
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
132
|
+
<h3 class="tsd-anchor-link" id="rtcstatstelemetry"><span>rtc<wbr/>Stats<wbr/>Telemetry</span><a href="#rtcstatstelemetry" 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>
|
|
133
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
134
|
+
<li>
|
|
135
|
+
<div class="tsd-signature" id="rtcstatstelemetryrtcstatstelemetry"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">rtcStatsTelemetry</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
136
|
+
<div class="tsd-description">
|
|
137
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
|
|
138
|
+
<p>Inherited from vonage.CoreClientConfigJS.rtcStatsTelemetry</p></aside></div></li>
|
|
139
|
+
<li>
|
|
140
|
+
<div class="tsd-signature" id="rtcstatstelemetryrtcstatstelemetry-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">rtcStatsTelemetry</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">void</span></div>
|
|
141
|
+
<div class="tsd-description">
|
|
142
|
+
<div class="tsd-parameters">
|
|
143
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
144
|
+
<ul class="tsd-parameter-list">
|
|
145
|
+
<li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div>
|
|
146
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
147
|
+
<p>Inherited from vonage.CoreClientConfigJS.rtcStatsTelemetry</p></aside></div></li></ul></section>
|
|
148
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
149
|
+
<h3 class="tsd-anchor-link" id="websocketpath"><span>websocket<wbr/>Path</span><a href="#websocketpath" 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>
|
|
150
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
151
|
+
<li>
|
|
152
|
+
<div class="tsd-signature" id="websocketpathwebsocketpath"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">websocketPath</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
153
|
+
<div class="tsd-description">
|
|
154
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
155
|
+
<p>Inherited from vonage.CoreClientConfigJS.websocketPath</p></aside></div></li>
|
|
156
|
+
<li>
|
|
157
|
+
<div class="tsd-signature" id="websocketpathwebsocketpath-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">websocketPath</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">void</span></div>
|
|
158
|
+
<div class="tsd-description">
|
|
159
|
+
<div class="tsd-parameters">
|
|
160
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
161
|
+
<ul class="tsd-parameter-list">
|
|
162
|
+
<li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
|
|
163
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
164
|
+
<p>Inherited from vonage.CoreClientConfigJS.websocketPath</p></aside></div></li></ul></section>
|
|
165
|
+
<section class="tsd-panel tsd-member tsd-is-inherited">
|
|
166
|
+
<h3 class="tsd-anchor-link" id="websocketurl"><span>websocket<wbr/>Url</span><a href="#websocketurl" 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>
|
|
167
|
+
<ul class="tsd-signatures tsd-is-inherited">
|
|
168
|
+
<li>
|
|
169
|
+
<div class="tsd-signature" id="websocketurlwebsocketurl"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">websocketUrl</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
170
|
+
<div class="tsd-description">
|
|
171
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
172
|
+
<p>Inherited from vonage.CoreClientConfigJS.websocketUrl</p></aside></div></li>
|
|
173
|
+
<li>
|
|
174
|
+
<div class="tsd-signature" id="websocketurlwebsocketurl-1"><span class="tsd-signature-keyword">set</span> <span class="tsd-kind-set-signature">websocketUrl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">value</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">void</span></div>
|
|
175
|
+
<div class="tsd-description">
|
|
176
|
+
<div class="tsd-parameters">
|
|
177
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
178
|
+
<ul class="tsd-parameter-list">
|
|
179
|
+
<li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
|
|
180
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
181
|
+
<p>Inherited from vonage.CoreClientConfigJS.websocketUrl</p></aside></div></li></ul></section></section></details></div>
|
|
182
|
+
<div class="col-sidebar">
|
|
183
|
+
<div class="page-menu">
|
|
184
|
+
<div class="tsd-navigation settings">
|
|
185
|
+
<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>
|
|
186
|
+
<h3>Settings</h3></summary>
|
|
187
|
+
<div class="tsd-accordion-details">
|
|
188
|
+
<div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span>
|
|
189
|
+
<ul id="tsd-filter-options">
|
|
190
|
+
<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>
|
|
191
|
+
<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>
|
|
192
|
+
<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>
|
|
193
|
+
<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>
|
|
194
|
+
<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>
|
|
195
|
+
<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>
|
|
196
|
+
<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>
|
|
197
|
+
<h3>On This Page</h3></summary>
|
|
198
|
+
<div class="tsd-accordion-details">
|
|
199
|
+
<details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
|
|
200
|
+
<div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
|
|
201
|
+
<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>
|
|
202
|
+
<div><a href="#apiurl" 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>api<wbr/>Url</span></a><a href="#autoreconnectmedia" 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>auto<wbr/>Reconnect<wbr/>Media</span></a><a href="#emergencyprimaryregion" 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/>Primary<wbr/>Region</span></a><a href="#emergencysecondaryregion" 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/>Secondary<wbr/>Region</span></a><a href="#noisesuppression" 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>noise<wbr/>Suppression</span></a><a href="#region" 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>region</span></a><a href="#rtcstatstelemetry" 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>rtc<wbr/>Stats<wbr/>Telemetry</span></a><a href="#websocketpath" 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>websocket<wbr/>Path</span></a><a href="#websocketurl" 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>websocket<wbr/>Url</span></a></div></details></div></details></div>
|
|
203
|
+
<div class="site-menu">
|
|
204
|
+
<nav class="tsd-navigation"><a href="../modules.html">@vonage/client-sdk - v0.0.0</a>
|
|
205
|
+
<ul class="tsd-small-nested-navigation" id="tsd-nav-container">
|
|
206
|
+
<li>Loading...</li></ul></nav></div></div></div><footer></footer>
|
|
207
|
+
<div class="overlay"></div></body></html>
|