@zelloptt/react-native-zello-sdk 0.1.1 → 0.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +113 -2
- package/lib/commonjs/docs/assets/highlight.css +11 -4
- package/lib/commonjs/docs/assets/icons.js +7 -7
- package/lib/commonjs/docs/assets/icons.js.map +1 -1
- package/lib/commonjs/docs/assets/main.js +216 -216
- package/lib/commonjs/docs/assets/main.js.map +1 -1
- package/lib/commonjs/docs/assets/navigation.js +1 -1
- package/lib/commonjs/docs/assets/navigation.js.map +1 -1
- package/lib/commonjs/docs/assets/search.js +1 -1
- package/lib/commonjs/docs/assets/search.js.map +1 -1
- package/lib/commonjs/docs/classes/sdk.Zello.html +40 -40
- package/lib/commonjs/docs/classes/types.ZelloAlertMessage.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloChannel.html +9 -9
- package/lib/commonjs/docs/classes/types.ZelloChannelUser.html +3 -3
- package/lib/commonjs/docs/classes/types.ZelloHistoryAlertMessage.html +9 -9
- package/lib/commonjs/docs/classes/types.ZelloHistoryImageMessage.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloHistoryLocationMessage.html +12 -12
- package/lib/commonjs/docs/classes/types.ZelloHistoryTextMessage.html +9 -9
- package/lib/commonjs/docs/classes/types.ZelloHistoryVoiceMessage.html +9 -9
- package/lib/commonjs/docs/classes/types.ZelloImageMessage.html +9 -9
- package/lib/commonjs/docs/classes/types.ZelloIncomingEmergency.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloIncomingVoiceMessage.html +7 -7
- package/lib/commonjs/docs/classes/types.ZelloLocationMessage.html +11 -11
- package/lib/commonjs/docs/classes/types.ZelloOutgoingEmergency.html +6 -6
- package/lib/commonjs/docs/classes/types.ZelloOutgoingVoiceMessage.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloRecentEntry.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloTextMessage.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloUser.html +9 -9
- package/lib/commonjs/docs/enums/events.ZelloEvent.html +34 -34
- package/lib/commonjs/docs/enums/types.ZelloAccountStatus.html +4 -4
- package/lib/commonjs/docs/enums/types.ZelloChannelAlertLevel.html +4 -4
- package/lib/commonjs/docs/enums/types.ZelloChannelConnectionStatus.html +3 -3
- package/lib/commonjs/docs/enums/types.ZelloConnectionError.html +3 -3
- package/lib/commonjs/docs/enums/types.ZelloConnectionState.html +3 -3
- package/lib/commonjs/docs/enums/types.ZelloContactType.html +3 -3
- package/lib/commonjs/docs/enums/types.ZelloOutgoingVoiceMessageError.html +3 -3
- package/lib/commonjs/docs/enums/types.ZelloOutgoingVoiceMessageState.html +3 -3
- package/lib/commonjs/docs/enums/types.ZelloRecentEntryType.html +3 -3
- package/lib/commonjs/docs/enums/types.ZelloUserStatus.html +6 -6
- package/lib/commonjs/docs/index.html +74 -3
- package/lib/commonjs/docs/modules/events.html +2 -2
- package/lib/commonjs/docs/modules/index.html +2 -2
- package/lib/commonjs/docs/modules/sdk.html +2 -2
- package/lib/commonjs/docs/modules/types.html +2 -2
- package/lib/commonjs/docs/types/types.ZelloChannelOptions.html +2 -2
- package/lib/commonjs/docs/types/types.ZelloConfig.html +2 -2
- package/lib/commonjs/docs/types/types.ZelloContact.html +2 -2
- package/lib/commonjs/docs/types/types.ZelloCredentials.html +2 -2
- package/lib/commonjs/docs/types/types.ZelloHistoryMessage.html +2 -2
- package/lib/commonjs/docs/types/types.ZelloMessage.html +2 -2
- package/lib/module/docs/assets/highlight.css +11 -4
- package/lib/module/docs/assets/icons.js +7 -7
- package/lib/module/docs/assets/icons.js.map +1 -1
- package/lib/module/docs/assets/main.js +216 -216
- package/lib/module/docs/assets/main.js.map +1 -1
- package/lib/module/docs/assets/navigation.js +1 -1
- package/lib/module/docs/assets/navigation.js.map +1 -1
- package/lib/module/docs/assets/search.js +1 -1
- package/lib/module/docs/assets/search.js.map +1 -1
- package/lib/module/docs/classes/sdk.Zello.html +40 -40
- package/lib/module/docs/classes/types.ZelloAlertMessage.html +8 -8
- package/lib/module/docs/classes/types.ZelloChannel.html +9 -9
- package/lib/module/docs/classes/types.ZelloChannelUser.html +3 -3
- package/lib/module/docs/classes/types.ZelloHistoryAlertMessage.html +9 -9
- package/lib/module/docs/classes/types.ZelloHistoryImageMessage.html +8 -8
- package/lib/module/docs/classes/types.ZelloHistoryLocationMessage.html +12 -12
- package/lib/module/docs/classes/types.ZelloHistoryTextMessage.html +9 -9
- package/lib/module/docs/classes/types.ZelloHistoryVoiceMessage.html +9 -9
- package/lib/module/docs/classes/types.ZelloImageMessage.html +9 -9
- package/lib/module/docs/classes/types.ZelloIncomingEmergency.html +8 -8
- package/lib/module/docs/classes/types.ZelloIncomingVoiceMessage.html +7 -7
- package/lib/module/docs/classes/types.ZelloLocationMessage.html +11 -11
- package/lib/module/docs/classes/types.ZelloOutgoingEmergency.html +6 -6
- package/lib/module/docs/classes/types.ZelloOutgoingVoiceMessage.html +8 -8
- package/lib/module/docs/classes/types.ZelloRecentEntry.html +8 -8
- package/lib/module/docs/classes/types.ZelloTextMessage.html +8 -8
- package/lib/module/docs/classes/types.ZelloUser.html +9 -9
- package/lib/module/docs/enums/events.ZelloEvent.html +34 -34
- package/lib/module/docs/enums/types.ZelloAccountStatus.html +4 -4
- package/lib/module/docs/enums/types.ZelloChannelAlertLevel.html +4 -4
- package/lib/module/docs/enums/types.ZelloChannelConnectionStatus.html +3 -3
- package/lib/module/docs/enums/types.ZelloConnectionError.html +3 -3
- package/lib/module/docs/enums/types.ZelloConnectionState.html +3 -3
- package/lib/module/docs/enums/types.ZelloContactType.html +3 -3
- package/lib/module/docs/enums/types.ZelloOutgoingVoiceMessageError.html +3 -3
- package/lib/module/docs/enums/types.ZelloOutgoingVoiceMessageState.html +3 -3
- package/lib/module/docs/enums/types.ZelloRecentEntryType.html +3 -3
- package/lib/module/docs/enums/types.ZelloUserStatus.html +6 -6
- package/lib/module/docs/index.html +74 -3
- package/lib/module/docs/modules/events.html +2 -2
- package/lib/module/docs/modules/index.html +2 -2
- package/lib/module/docs/modules/sdk.html +2 -2
- package/lib/module/docs/modules/types.html +2 -2
- package/lib/module/docs/types/types.ZelloChannelOptions.html +2 -2
- package/lib/module/docs/types/types.ZelloConfig.html +2 -2
- package/lib/module/docs/types/types.ZelloContact.html +2 -2
- package/lib/module/docs/types/types.ZelloCredentials.html +2 -2
- package/lib/module/docs/types/types.ZelloHistoryMessage.html +2 -2
- package/lib/module/docs/types/types.ZelloMessage.html +2 -2
- package/package.json +3 -8
- package/react-native-zello-sdk.podspec +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Zello | react-native-zello-sdk</title><meta name="description" content="Documentation for react-native-zello-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"
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Zello | @zelloptt/react-native-zello-sdk</title><meta name="description" content="Documentation for @zelloptt/react-native-zello-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">@zelloptt/react-native-zello-sdk</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="../index.html">@zelloptt/react-native-zello-sdk</a></li><li><a href="../modules/sdk.html">sdk</a></li><li><a href="sdk.Zello.html">Zello</a></li></ul><h1>Class Zello</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Zello SDK.
|
|
2
2
|
This class is a singleton, and can be accessed via <a href="sdk.Zello.html#getInstance" class="tsd-kind-method">Zello.getInstance</a>.</p>
|
|
3
|
-
</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">default</span><ul class="tsd-hierarchy"><li><span class="target">Zello</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
3
|
+
</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">default</span><ul class="tsd-hierarchy"><li><span class="target">Zello</span></li></ul></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L49">src/sdk/index.ts:49</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-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">Properties</h3><div class="tsd-index-list"><a href="sdk.Zello.html#accountStatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>account<wbr/>Status</span></a>
|
|
4
4
|
<a href="sdk.Zello.html#channels" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>channels</span></a>
|
|
5
5
|
<a href="sdk.Zello.html#emergencyChannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emergency<wbr/>Channel</span></a>
|
|
6
6
|
<a href="sdk.Zello.html#historyVoiceMessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>history<wbr/>Voice<wbr/>Message</span></a>
|
|
@@ -43,19 +43,19 @@ This class is a singleton, and can be accessed via <a href="sdk.Zello.html#getIn
|
|
|
43
43
|
<a href="sdk.Zello.html#unmuteContact" 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/>Contact</span></a>
|
|
44
44
|
<a href="sdk.Zello.html#getInstance" 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/>Instance</span></a>
|
|
45
45
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="accountStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>account<wbr/>Status</span><a href="#accountStatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">account<wbr/>Status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../enums/types.ZelloAccountStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloAccountStatus</a></div><div class="tsd-comment tsd-typography"><p>The current account status. undefined when <a href="sdk.Zello.html#state" class="tsd-kind-property">state</a> is not <a href="../enums/types.ZelloConnectionState.html#Connected" class="tsd-kind-enum-member">ZelloConnectionState.Connected</a>.</p>
|
|
46
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
47
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
48
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
49
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
46
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L81">src/sdk/index.ts:81</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="channels" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>channels</span><a href="#channels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">channels</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloChannel.html" class="tsd-signature-type tsd-kind-class">ZelloChannel</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>The list of <a href="types.ZelloChannel.html" class="tsd-kind-class">ZelloChannel</a> in the contact list. Sorted by name, ascending.</p>
|
|
47
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L76">src/sdk/index.ts:76</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="emergencyChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emergency<wbr/>Channel</span><a href="#emergencyChannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">emergency<wbr/>Channel</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="types.ZelloChannel.html" class="tsd-signature-type tsd-kind-class">ZelloChannel</a></div><div class="tsd-comment tsd-typography"><p>The configured emergency channel.</p>
|
|
48
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L95">src/sdk/index.ts:95</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="historyVoiceMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>history<wbr/>Voice<wbr/>Message</span><a href="#historyVoiceMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">history<wbr/>Voice<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="types.ZelloHistoryVoiceMessage.html" class="tsd-signature-type tsd-kind-class">ZelloHistoryVoiceMessage</a></div><div class="tsd-comment tsd-typography"><p>The currently playing history voice message.</p>
|
|
49
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L114">src/sdk/index.ts:114</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="incomingEmergencies" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>incoming<wbr/>Emergencies</span><a href="#incomingEmergencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">incoming<wbr/>Emergencies</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloIncomingEmergency.html" class="tsd-signature-type tsd-kind-class">ZelloIncomingEmergency</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>The list of incoming emergencies. There can be multiple emergencies on the emergency channel at once.
|
|
50
50
|
Sorted by start timestamp, ascending.</p>
|
|
51
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
52
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
53
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
54
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
55
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
56
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
57
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
58
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
51
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L100">src/sdk/index.ts:100</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="incomingVoiceMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>incoming<wbr/>Voice<wbr/>Message</span><a href="#incomingVoiceMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">incoming<wbr/>Voice<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="types.ZelloIncomingVoiceMessage.html" class="tsd-signature-type tsd-kind-class">ZelloIncomingVoiceMessage</a></div><div class="tsd-comment tsd-typography"><p>The current incoming voice message.</p>
|
|
52
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L86">src/sdk/index.ts:86</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="outgoingEmergency" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>outgoing<wbr/>Emergency</span><a href="#outgoingEmergency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">outgoing<wbr/>Emergency</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="types.ZelloOutgoingEmergency.html" class="tsd-signature-type tsd-kind-class">ZelloOutgoingEmergency</a></div><div class="tsd-comment tsd-typography"><p>The current outgoing emergency.</p>
|
|
53
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L104">src/sdk/index.ts:104</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="outgoingVoiceMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>outgoing<wbr/>Voice<wbr/>Message</span><a href="#outgoingVoiceMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">outgoing<wbr/>Voice<wbr/>Message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="types.ZelloOutgoingVoiceMessage.html" class="tsd-signature-type tsd-kind-class">ZelloOutgoingVoiceMessage</a></div><div class="tsd-comment tsd-typography"><p>The current outgoing voice message.</p>
|
|
54
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L90">src/sdk/index.ts:90</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="recents" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>recents</span><a href="#recents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">recents</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloRecentEntry.html" class="tsd-signature-type tsd-kind-class">ZelloRecentEntry</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>The list of recent entries. Sorted by timestamp, descending.</p>
|
|
55
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L109">src/sdk/index.ts:109</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="selectedContact" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>selected<wbr/>Contact</span><a href="#selectedContact" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">selected<wbr/>Contact</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></div><div class="tsd-comment tsd-typography"><p>The currently selected contact.</p>
|
|
56
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L67">src/sdk/index.ts:67</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="state" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">state</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloConnectionState.html" class="tsd-signature-type tsd-kind-enum">ZelloConnectionState</a><span class="tsd-signature-symbol"> = ZelloConnectionState.Disconnected</span></div><div class="tsd-comment tsd-typography"><p>The current connection state of the SDK.</p>
|
|
57
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L62">src/sdk/index.ts:62</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="users" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>users</span><a href="#users" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">users</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloUser.html" class="tsd-signature-type tsd-kind-class">ZelloUser</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div><div class="tsd-comment tsd-typography"><p>The list of <a href="types.ZelloUser.html" class="tsd-kind-class">ZelloUser</a> in the contact list. Sorted by name, ascending.</p>
|
|
58
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L72">src/sdk/index.ts:72</a></li></ul></aside></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="addListener" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Listener</span><a href="#addListener" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="addListener.addListener-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Listener</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span>, <span class="tsd-kind-parameter">listener</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">EmitterSubscription</span><a href="#addListener.addListener-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>Adds a listener to be invoked when events of the specified type are
|
|
59
59
|
emitted. An optional calling context may be provided. The data arguments
|
|
60
60
|
emitted will be passed to the listener function.</p>
|
|
61
61
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Name of the event to listen to</p>
|
|
@@ -66,51 +66,51 @@ listener</p>
|
|
|
66
66
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EmitterSubscription</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from EventEmitter.addListener</p><ul><li>Defined in example/node_modules/react-native/Libraries/vendor/emitter/EventEmitter.d.ts:126</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="configure" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>configure</span><a href="#configure" 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="configure.configure-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">configure</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="#configure.configure-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>Sets configuration variables for the SDK.</p>
|
|
67
67
|
<p>At the moment, this is only functional on Android.</p>
|
|
68
68
|
</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/types.ZelloConfig.html" class="tsd-signature-type tsd-kind-type-alias">ZelloConfig</a></span><div class="tsd-comment tsd-typography"><p>The configuration to set.</p>
|
|
69
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
69
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L139">src/sdk/index.ts:139</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="connect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connect</span><a href="#connect" 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="connect.connect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connect</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">credentials</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#connect.connect-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>Signs into to the Zello Work network using the provided credentials.
|
|
70
70
|
This will typically trigger the <a href="../enums/events.ZelloEvent.html#CONNECT_STARTED" class="tsd-kind-enum-member">ZelloEvent.CONNECT_STARTED</a> event, followed by either <a href="../enums/events.ZelloEvent.html#CONNECT_SUCCEEDED" class="tsd-kind-enum-member">ZelloEvent.CONNECT_SUCCEEDED</a> or <a href="../enums/events.ZelloEvent.html#CONNECT_FAILED" class="tsd-kind-enum-member">ZelloEvent.CONNECT_FAILED</a>.
|
|
71
71
|
However, if the state is incorrect, <a href="../enums/events.ZelloEvent.html#CONNECT_FAILED" class="tsd-kind-enum-member">ZelloEvent.CONNECT_FAILED</a> will be triggered immediately.</p>
|
|
72
72
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">credentials</span>: <a href="../types/types.ZelloCredentials.html" class="tsd-signature-type tsd-kind-type-alias">ZelloCredentials</a></span><div class="tsd-comment tsd-typography"><p>The credentials to use for signing in.</p>
|
|
73
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
73
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L165">src/sdk/index.ts:165</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="connectChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>connect<wbr/>Channel</span><a href="#connectChannel" 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="connectChannel.connectChannel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">connect<wbr/>Channel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#connectChannel.connectChannel-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>Connects to the given channel.
|
|
74
74
|
Once connected, the user will be able to send and receive messages from the channel.
|
|
75
75
|
This will trigger the <a href="../enums/events.ZelloEvent.html#CONTACT_LIST_UPDATED" class="tsd-kind-enum-member">ZelloEvent.CONTACT_LIST_UPDATED</a> event.</p>
|
|
76
76
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">channel</span>: <a href="types.ZelloChannel.html" class="tsd-signature-type tsd-kind-class">ZelloChannel</a></span><div class="tsd-comment tsd-typography"><p>The channel to connect to.</p>
|
|
77
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
77
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L245">src/sdk/index.ts:245</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" 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="destroy.destroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#destroy.destroy-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>Destroys the SDK instance and cleans up resources.
|
|
78
78
|
Call this when you are done using the SDK instance for good (application quit).</p>
|
|
79
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
79
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L154">src/sdk/index.ts:154</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="disconnect" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disconnect</span><a href="#disconnect" 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="disconnect.disconnect-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disconnect</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#disconnect.disconnect-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>Signs out of the Zello Work network.
|
|
80
80
|
This will trigger the <a href="../enums/events.ZelloEvent.html#DISCONNECTED" class="tsd-kind-enum-member">ZelloEvent.DISCONNECTED</a> event.</p>
|
|
81
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
81
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L185">src/sdk/index.ts:185</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="disconnectChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>disconnect<wbr/>Channel</span><a href="#disconnectChannel" 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="disconnectChannel.disconnectChannel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disconnect<wbr/>Channel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#disconnectChannel.disconnectChannel-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>Disconnects from the given channel.
|
|
82
82
|
Once disconnected, the user will no longer be able to send or receive messages from the channel.
|
|
83
83
|
This will trigger the <a href="../enums/events.ZelloEvent.html#CONTACT_LIST_UPDATED" class="tsd-kind-enum-member">ZelloEvent.CONTACT_LIST_UPDATED</a> event.</p>
|
|
84
84
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">channel</span>: <a href="types.ZelloChannel.html" class="tsd-signature-type tsd-kind-class">ZelloChannel</a></span><div class="tsd-comment tsd-typography"><p>The channel to disconnect from.</p>
|
|
85
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
85
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L259">src/sdk/index.ts:259</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="emit" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>emit</span><a href="#emit" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="emit.emit-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">emit</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span>, <span class="tsd-signature-symbol">...</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">void</span><a href="#emit.emit-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>Emits an event of the given type with the given data. All handlers of that
|
|
86
86
|
particular type will be notified.</p>
|
|
87
87
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Name of the event to emit</p>
|
|
88
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">emitter</span><span class="hl-1">.</span><span class="hl-0">addListener</span><span class="hl-1">(</span><span class="hl-2">'someEvent'</span><span class="hl-1">, </span><span class="hl-
|
|
88
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Rest</code><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><h4 class="tsd-anchor-link"><a id="Example" class="tsd-anchor"></a>Example<a href="#Example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="ts"><span class="hl-3">emitter</span><span class="hl-1">.</span><span class="hl-0">addListener</span><span class="hl-1">(</span><span class="hl-2">'someEvent'</span><span class="hl-1">, </span><span class="hl-6">function</span><span class="hl-1">(</span><span class="hl-3">message</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-3">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-3">message</span><span class="hl-1">);</span><br/><span class="hl-1"> });</span><br/><br/><span class="hl-1"> </span><span class="hl-3">emitter</span><span class="hl-1">.</span><span class="hl-0">emit</span><span class="hl-1">(</span><span class="hl-2">'someEvent'</span><span class="hl-1">, </span><span class="hl-2">'abc'</span><span class="hl-1">); </span><span class="hl-4">// logs 'abc'</span>
|
|
89
89
|
</code><button type="button">Copy</button></pre>
|
|
90
90
|
|
|
91
91
|
</div><aside class="tsd-sources"><p>Inherited from EventEmitter.emit</p><ul><li>Defined in example/node_modules/react-native/Libraries/vendor/emitter/EventEmitter.d.ts:163</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getChannel" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Channel</span><a href="#getChannel" 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="getChannel.getChannel-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Channel</span><span class="tsd-signature-symbol">(</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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="types.ZelloChannel.html" class="tsd-signature-type tsd-kind-class">ZelloChannel</a><a href="#getChannel.getChannel-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>Returns the channel with the given name. Case-insensitive.</p>
|
|
92
92
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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 channel to search for.</p>
|
|
93
93
|
</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><a href="types.ZelloChannel.html" class="tsd-signature-type tsd-kind-class">ZelloChannel</a></h4><p>The channel with the given name, or null if no channel with that name exists.</p>
|
|
94
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
94
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L207">src/sdk/index.ts:207</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getHistory" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>History</span><a href="#getHistory" 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="getHistory.getHistory-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>History</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span>, <span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/types.ZelloHistoryMessage.html" class="tsd-signature-type tsd-kind-type-alias">ZelloHistoryMessage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#getHistory.getHistory-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>Returns the history messages for the given contact.</p>
|
|
95
95
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contact</span>: <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></span><div class="tsd-comment tsd-typography"><p>The contact to get the history for.</p>
|
|
96
96
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">size</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>Optional; The number of history items to retrieve. Defaults to 50.</p>
|
|
97
97
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/types.ZelloHistoryMessage.html" class="tsd-signature-type tsd-kind-type-alias">ZelloHistoryMessage</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>The history items for the given contact.</p>
|
|
98
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
98
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L429">src/sdk/index.ts:429</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getImageDataForHistoryImageMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Image<wbr/>Data<wbr/>For<wbr/>History<wbr/>Image<wbr/>Message</span><a href="#getImageDataForHistoryImageMessage" 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="getImageDataForHistoryImageMessage.getImageDataForHistoryImageMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Image<wbr/>Data<wbr/>For<wbr/>History<wbr/>Image<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span><a href="#getImageDataForHistoryImageMessage.getImageDataForHistoryImageMessage-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>Returns the image data for the given history image message.</p>
|
|
99
99
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <a href="types.ZelloHistoryImageMessage.html" class="tsd-signature-type tsd-kind-class">ZelloHistoryImageMessage</a></span><div class="tsd-comment tsd-typography"><p>The history image message to get the image data for.</p>
|
|
100
100
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4><p>The image data for the given history image message.</p>
|
|
101
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
101
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L503">src/sdk/index.ts:503</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getUser" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>User</span><a href="#getUser" 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="getUser.getUser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>User</span><span class="tsd-signature-symbol">(</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">undefined</span><span class="tsd-signature-symbol"> | </span><a href="types.ZelloUser.html" class="tsd-signature-type tsd-kind-class">ZelloUser</a><a href="#getUser.getUser-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>Returns the user with the given name. Case-insensitive.</p>
|
|
102
102
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><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 search for.</p>
|
|
103
103
|
</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><a href="types.ZelloUser.html" class="tsd-signature-type tsd-kind-class">ZelloUser</a></h4><p>The user with the given name, or null if no user with that name exists.</p>
|
|
104
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
104
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L198">src/sdk/index.ts:198</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="listenerCount" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>listener<wbr/>Count</span><a href="#listenerCount" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="listenerCount.listenerCount-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">listener<wbr/>Count</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#listenerCount.listenerCount-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>Returns the number of listeners that are currently registered for the given
|
|
105
105
|
event.</p>
|
|
106
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">eventType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Name of the event to query</p>
|
|
107
107
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><p>Inherited from EventEmitter.listenerCount</p><ul><li>Defined in example/node_modules/react-native/Libraries/vendor/emitter/EventEmitter.d.ts:147</li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="muteContact" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>mute<wbr/>Contact</span><a href="#muteContact" 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="muteContact.muteContact-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">mute<wbr/>Contact</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#muteContact.muteContact-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>Mutes the given contact. When muted, incoming messages from this contact will not play live, but will still appear in the history.
|
|
108
108
|
This will trigger the <a href="../enums/events.ZelloEvent.html#CONTACT_LIST_UPDATED" class="tsd-kind-enum-member">ZelloEvent.CONTACT_LIST_UPDATED</a> event.</p>
|
|
109
109
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contact</span>: <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></span><div class="tsd-comment tsd-typography"><p>The contact to mute.</p>
|
|
110
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
110
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L375">src/sdk/index.ts:375</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="playHistoryMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>play<wbr/>History<wbr/>Message</span><a href="#playHistoryMessage" 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="playHistoryMessage.playHistoryMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">play<wbr/>History<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#playHistoryMessage.playHistoryMessage-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>Plays the given history message.
|
|
111
111
|
This will trigger the <a href="../enums/events.ZelloEvent.html#HISTORY_PLAYBACK_STARTED" class="tsd-kind-enum-member">ZelloEvent.HISTORY_PLAYBACK_STARTED</a> event.</p>
|
|
112
112
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <a href="types.ZelloHistoryVoiceMessage.html" class="tsd-signature-type tsd-kind-class">ZelloHistoryVoiceMessage</a></span><div class="tsd-comment tsd-typography"><p>The history message to play.</p>
|
|
113
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
113
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L469">src/sdk/index.ts:469</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="removeAllListeners" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removeAllListeners" 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 tsd-is-external"><li class="tsd-signature tsd-anchor-link"><a id="removeAllListeners.removeAllListeners-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">remove<wbr/>All<wbr/>Listeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#removeAllListeners.removeAllListeners-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>Removes all of the registered listeners, including those registered as
|
|
114
114
|
listener maps.</p>
|
|
115
115
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">eventType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Optional name of the event whose registered
|
|
116
116
|
listeners to remove</p>
|
|
@@ -119,40 +119,40 @@ This will trigger the <a href="../enums/events.ZelloEvent.html#OUTGOING_ALERT_ME
|
|
|
119
119
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contact</span>: <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></span><div class="tsd-comment tsd-typography"><p>The contact to send the alert to.</p>
|
|
120
120
|
</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>
|
|
121
121
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">level</span>: <a href="../enums/types.ZelloChannelAlertLevel.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelAlertLevel</a></span><div class="tsd-comment tsd-typography"><p>Optional; The alert level to send. Only applicable for channels.</p>
|
|
122
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
122
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L345">src/sdk/index.ts:345</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendImage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Image</span><a href="#sendImage" 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="sendImage.sendImage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Image</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span>, <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendImage.sendImage-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 the image message data to the given contact.
|
|
123
123
|
This will trigger the <a href="../enums/events.ZelloEvent.html#OUTGOING_IMAGE_MESSAGE_SENT" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_IMAGE_MESSAGE_SENT</a> or <a href="../enums/events.ZelloEvent.html#OUTGOING_IMAGE_MESSAGE_SEND_FAILED" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_IMAGE_MESSAGE_SEND_FAILED</a> event.</p>
|
|
124
124
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contact</span>: <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></span><div class="tsd-comment tsd-typography"><p>The contact to send the image to.</p>
|
|
125
125
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The image data to send.</p>
|
|
126
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
126
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L300">src/sdk/index.ts:300</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendLocation" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Location</span><a href="#sendLocation" 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="sendLocation.sendLocation-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Location</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#sendLocation.sendLocation-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 the alert message to the given contact.
|
|
127
127
|
This will trigger the <a href="../enums/events.ZelloEvent.html#OUTGOING_ALERT_MESSAGE_SENT" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_ALERT_MESSAGE_SENT</a> or <a href="../enums/events.ZelloEvent.html#OUTGOING_ALERT_MESSAGE_SEND_FAILED" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_ALERT_MESSAGE_SEND_FAILED</a> event.</p>
|
|
128
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">contact</span>: <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></span><div class="tsd-comment tsd-typography"><p>The contact to send the alert to.</p>
|
|
129
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
129
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L314">src/sdk/index.ts:314</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="sendText" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>send<wbr/>Text</span><a href="#sendText" 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="sendText.sendText-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">send<wbr/>Text</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</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">void</span><a href="#sendText.sendText-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 the text message to the given contact.
|
|
130
130
|
This will trigger the <a href="../enums/events.ZelloEvent.html#OUTGOING_TEXT_MESSAGE_SENT" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_TEXT_MESSAGE_SENT</a> or <a href="../enums/events.ZelloEvent.html#OUTGOING_TEXT_MESSAGE_SEND_FAILED" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_TEXT_MESSAGE_SEND_FAILED</a> event.</p>
|
|
131
131
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contact</span>: <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></span><div class="tsd-comment tsd-typography"><p>The contact to send the text to.</p>
|
|
132
132
|
</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>
|
|
133
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
133
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L329">src/sdk/index.ts:329</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setAccountStatus" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Account<wbr/>Status</span><a href="#setAccountStatus" 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="setAccountStatus.setAccountStatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Account<wbr/>Status</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setAccountStatus.setAccountStatus-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>Sets the user's online account status.
|
|
134
134
|
This will trigger the <a href="../enums/events.ZelloEvent.html#ACCOUNT_STATUS_CHANGED" class="tsd-kind-enum-member">ZelloEvent.ACCOUNT_STATUS_CHANGED</a> event.</p>
|
|
135
135
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">status</span>: <a href="../enums/types.ZelloAccountStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloAccountStatus</a></span><div class="tsd-comment tsd-typography"><p>The account status to set.</p>
|
|
136
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
136
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L231">src/sdk/index.ts:231</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="setSelectedContact" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Selected<wbr/>Contact</span><a href="#setSelectedContact" 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="setSelectedContact.setSelectedContact-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">set<wbr/>Selected<wbr/>Contact</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#setSelectedContact.setSelectedContact-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>Sets the selected contact.
|
|
137
137
|
While optional, this is typically used for tracking the contact that the user is currently interacting with.
|
|
138
138
|
This will trigger the <a href="../enums/events.ZelloEvent.html#SELECTED_CONTACT_CHANGED" class="tsd-kind-enum-member">ZelloEvent.SELECTED_CONTACT_CHANGED</a> event.</p>
|
|
139
139
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contact</span>: <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></span><div class="tsd-comment tsd-typography"><p>The contact to set as selected.</p>
|
|
140
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
140
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L217">src/sdk/index.ts:217</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="startEmergency" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Emergency</span><a href="#startEmergency" 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="startEmergency.startEmergency-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start<wbr/>Emergency</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#startEmergency.startEmergency-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 outgoing emergency to the emergency channel.
|
|
141
141
|
Upon starting, the user's location will be sent, an alert message will be sent, and a 10-second-long voice message will start recording.
|
|
142
142
|
This will trigger the <a href="../enums/events.ZelloEvent.html#OUTGOING_EMERGENCY_STARTED" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_EMERGENCY_STARTED</a> event.</p>
|
|
143
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
143
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L403">src/sdk/index.ts:403</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="startVoiceMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>start<wbr/>Voice<wbr/>Message</span><a href="#startVoiceMessage" 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="startVoiceMessage.startVoiceMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">start<wbr/>Voice<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#startVoiceMessage.startVoiceMessage-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 a voice message with the given contact.
|
|
144
144
|
This will trigger the <a href="../enums/events.ZelloEvent.html#OUTGOING_VOICE_MESSAGE_CONNECTING" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_VOICE_MESSAGE_CONNECTING</a> event, followed by the <a href="../enums/events.ZelloEvent.html#OUTGOING_VOICE_MESSAGE_STARTED" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_VOICE_MESSAGE_STARTED</a> event.
|
|
145
145
|
If there is an error, the <a href="../enums/events.ZelloEvent.html#OUTGOING_VOICE_MESSAGE_STOPPED" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_VOICE_MESSAGE_STOPPED</a> event will be triggered.</p>
|
|
146
146
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">contact</span>: <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></span><div class="tsd-comment tsd-typography"><p>The contact to start the voice message with.</p>
|
|
147
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
147
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L273">src/sdk/index.ts:273</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="stopEmergency" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stop<wbr/>Emergency</span><a href="#stopEmergency" 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="stopEmergency.stopEmergency-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stop<wbr/>Emergency</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#stopEmergency.stopEmergency-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>Stops the outgoing emergency.
|
|
148
148
|
This will trigger the <a href="../enums/events.ZelloEvent.html#OUTGOING_EMERGENCY_STOPPED" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_EMERGENCY_STOPPED</a> event.</p>
|
|
149
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
149
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L415">src/sdk/index.ts:415</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="stopHistoryMessagePlayback" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stop<wbr/>History<wbr/>Message<wbr/>Playback</span><a href="#stopHistoryMessagePlayback" 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="stopHistoryMessagePlayback.stopHistoryMessagePlayback-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stop<wbr/>History<wbr/>Message<wbr/>Playback</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#stopHistoryMessagePlayback.stopHistoryMessagePlayback-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>Stops the current history message playback.
|
|
150
150
|
This will trigger the <a href="../enums/events.ZelloEvent.html#HISTORY_PLAYBACK_STOPPED" class="tsd-kind-enum-member">ZelloEvent.HISTORY_PLAYBACK_STOPPED</a> event.</p>
|
|
151
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
151
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L490">src/sdk/index.ts:490</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="stopVoiceMessage" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>stop<wbr/>Voice<wbr/>Message</span><a href="#stopVoiceMessage" 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="stopVoiceMessage.stopVoiceMessage-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">stop<wbr/>Voice<wbr/>Message</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#stopVoiceMessage.stopVoiceMessage-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>Stops the current outgoing voice message.
|
|
152
152
|
This will trigger the <a href="../enums/events.ZelloEvent.html#OUTGOING_VOICE_MESSAGE_STOPPED" class="tsd-kind-enum-member">ZelloEvent.OUTGOING_VOICE_MESSAGE_STOPPED</a> event.</p>
|
|
153
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
153
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L286">src/sdk/index.ts:286</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="submitProblemReport" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>submit<wbr/>Problem<wbr/>Report</span><a href="#submitProblemReport" 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="submitProblemReport.submitProblemReport-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">submit<wbr/>Problem<wbr/>Report</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#submitProblemReport.submitProblemReport-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>Submits a problem report to Zello.
|
|
154
154
|
Additionally, please contact us to provide more information on what happened.</p>
|
|
155
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
155
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L362">src/sdk/index.ts:362</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="unmuteContact" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>unmute<wbr/>Contact</span><a href="#unmuteContact" 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="unmuteContact.unmuteContact-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">unmute<wbr/>Contact</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#unmuteContact.unmuteContact-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>Unmutes a previously muted contact. When unmuted, incoming messages from this contact will play live.
|
|
156
156
|
This will trigger the <a href="../enums/events.ZelloEvent.html#CONTACT_LIST_UPDATED" class="tsd-kind-enum-member">ZelloEvent.CONTACT_LIST_UPDATED</a> event.</p>
|
|
157
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">contact</span>: <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></span><div class="tsd-comment tsd-typography"><p>The contact to unmute.</p>
|
|
158
|
-
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/745a00d36dc9eb6b1684c701636785da02c16428/src/sdk/index.ts#L389">src/sdk/index.ts:389</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getInstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>get<wbr/>Instance</span><a href="#getInstance" 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="getInstance.getInstance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Instance</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sdk.Zello.html" class="tsd-signature-type tsd-kind-class">Zello</a><a href="#getInstance.getInstance-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"><h4 class="tsd-returns-title">Returns <a href="sdk.Zello.html" class="tsd-signature-type tsd-kind-class">Zello</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/745a00d36dc9eb6b1684c701636785da02c16428/src/sdk/index.ts#L52">src/sdk/index.ts:52</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><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-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"/><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></ul></div><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><details open class="tsd-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"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#accountStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>account<wbr/>Status</span></a><a href="#channels" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>channels</span></a><a href="#emergencyChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emergency<wbr/>Channel</span></a><a href="#historyVoiceMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>history<wbr/>Voice<wbr/>Message</span></a><a href="#incomingEmergencies" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>incoming<wbr/>Emergencies</span></a><a href="#incomingVoiceMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>incoming<wbr/>Voice<wbr/>Message</span></a><a href="#outgoingEmergency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outgoing<wbr/>Emergency</span></a><a href="#outgoingVoiceMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outgoing<wbr/>Voice<wbr/>Message</span></a><a href="#recents" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>recents</span></a><a href="#selectedContact" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected<wbr/>Contact</span></a><a href="#state" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a><a href="#users" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>users</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a><a href="#configure" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure</span></a><a href="#connect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect</span></a><a href="#connectChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect<wbr/>Channel</span></a><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a><a href="#disconnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disconnect</span></a><a href="#disconnectChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disconnect<wbr/>Channel</span></a><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a><a href="#getChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel</span></a><a href="#getHistory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>History</span></a><a href="#getImageDataForHistoryImageMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Image<wbr/>Data<wbr/>For<wbr/>History<wbr/>Image<wbr/>Message</span></a><a href="#getUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User</span></a><a href="#listenerCount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a><a href="#muteContact" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute<wbr/>Contact</span></a><a href="#playHistoryMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play<wbr/>History<wbr/>Message</span></a><a href="#removeAllListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a><a href="#sendAlert" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Alert</span></a><a href="#sendImage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Image</span></a><a href="#sendLocation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Location</span></a><a href="#sendText" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Text</span></a><a href="#setAccountStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Account<wbr/>Status</span></a><a href="#setSelectedContact" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Selected<wbr/>Contact</span></a><a href="#startEmergency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Emergency</span></a><a href="#startVoiceMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Voice<wbr/>Message</span></a><a href="#stopEmergency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Emergency</span></a><a href="#stopHistoryMessagePlayback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>History<wbr/>Message<wbr/>Playback</span></a><a href="#stopVoiceMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Voice<wbr/>Message</span></a><a href="#submitProblemReport" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Problem<wbr/>Report</span></a><a href="#unmuteContact" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute<wbr/>Contact</span></a><a href="#getInstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Instance</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>react-native-zello-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
158
|
+
</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><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L389">src/sdk/index.ts:389</a></li></ul></aside></li></ul></section><section class="tsd-panel tsd-member"><a id="getInstance" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Static</code><span>get<wbr/>Instance</span><a href="#getInstance" 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="getInstance.getInstance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Instance</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="sdk.Zello.html" class="tsd-signature-type tsd-kind-class">Zello</a><a href="#getInstance.getInstance-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"><h4 class="tsd-returns-title">Returns <a href="sdk.Zello.html" class="tsd-signature-type tsd-kind-class">Zello</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/0da3a0f72e680f207edd5a246087349d6b320d6c/src/sdk/index.ts#L52">src/sdk/index.ts:52</a></li></ul></aside></li></ul></section></section></details></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-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"><span class="settings-label">Member Visibility</span><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-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"/><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></ul></div><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><details open class="tsd-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"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#accountStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>account<wbr/>Status</span></a><a href="#channels" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>channels</span></a><a href="#emergencyChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emergency<wbr/>Channel</span></a><a href="#historyVoiceMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>history<wbr/>Voice<wbr/>Message</span></a><a href="#incomingEmergencies" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>incoming<wbr/>Emergencies</span></a><a href="#incomingVoiceMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>incoming<wbr/>Voice<wbr/>Message</span></a><a href="#outgoingEmergency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outgoing<wbr/>Emergency</span></a><a href="#outgoingVoiceMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outgoing<wbr/>Voice<wbr/>Message</span></a><a href="#recents" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>recents</span></a><a href="#selectedContact" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected<wbr/>Contact</span></a><a href="#state" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a><a href="#users" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>users</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addListener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a><a href="#configure" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure</span></a><a href="#connect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect</span></a><a href="#connectChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect<wbr/>Channel</span></a><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a><a href="#disconnect" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disconnect</span></a><a href="#disconnectChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disconnect<wbr/>Channel</span></a><a href="#emit" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a><a href="#getChannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel</span></a><a href="#getHistory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>History</span></a><a href="#getImageDataForHistoryImageMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Image<wbr/>Data<wbr/>For<wbr/>History<wbr/>Image<wbr/>Message</span></a><a href="#getUser" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User</span></a><a href="#listenerCount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a><a href="#muteContact" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute<wbr/>Contact</span></a><a href="#playHistoryMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play<wbr/>History<wbr/>Message</span></a><a href="#removeAllListeners" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a><a href="#sendAlert" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Alert</span></a><a href="#sendImage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Image</span></a><a href="#sendLocation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Location</span></a><a href="#sendText" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Text</span></a><a href="#setAccountStatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Account<wbr/>Status</span></a><a href="#setSelectedContact" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Selected<wbr/>Contact</span></a><a href="#startEmergency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Emergency</span></a><a href="#startVoiceMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Voice<wbr/>Message</span></a><a href="#stopEmergency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Emergency</span></a><a href="#stopHistoryMessagePlayback" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>History<wbr/>Message<wbr/>Playback</span></a><a href="#stopVoiceMessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Voice<wbr/>Message</span></a><a href="#submitProblemReport" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Problem<wbr/>Report</span></a><a href="#unmuteContact" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute<wbr/>Contact</span></a><a href="#getInstance" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Instance</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@zelloptt/react-native-zello-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|