@zelloptt/react-native-zello-sdk 1.0.3 → 2.0.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/android/build.gradle +1 -1
- package/lib/commonjs/docs/assets/main.js +571 -440
- package/lib/commonjs/docs/assets/main.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/assets/style.css +251 -229
- package/lib/commonjs/docs/classes/sdk.Zello.html +120 -120
- package/lib/commonjs/docs/classes/types.ZelloAlertMessage.html +13 -13
- package/lib/commonjs/docs/classes/types.ZelloChannel.html +15 -15
- package/lib/commonjs/docs/classes/types.ZelloChannelUser.html +5 -5
- package/lib/commonjs/docs/classes/types.ZelloDispatchCall.html +7 -7
- package/lib/commonjs/docs/classes/types.ZelloDispatchChannel.html +17 -17
- package/lib/commonjs/docs/classes/types.ZelloGroupConversation.html +22 -22
- package/lib/commonjs/docs/classes/types.ZelloHistoryAlertMessage.html +15 -15
- package/lib/commonjs/docs/classes/types.ZelloHistoryImageMessage.html +13 -13
- package/lib/commonjs/docs/classes/types.ZelloHistoryLocationMessage.html +21 -21
- package/lib/commonjs/docs/classes/types.ZelloHistoryTextMessage.html +15 -15
- package/lib/commonjs/docs/classes/types.ZelloHistoryVoiceMessage.html +15 -15
- package/lib/commonjs/docs/classes/types.ZelloImageMessage.html +15 -15
- package/lib/commonjs/docs/classes/types.ZelloIncomingEmergency.html +13 -13
- package/lib/commonjs/docs/classes/types.ZelloIncomingVoiceMessage.html +11 -11
- package/lib/commonjs/docs/classes/types.ZelloLocationMessage.html +19 -19
- package/lib/commonjs/docs/classes/types.ZelloOutgoingEmergency.html +9 -9
- package/lib/commonjs/docs/classes/types.ZelloOutgoingVoiceMessage.html +13 -13
- package/lib/commonjs/docs/classes/types.ZelloRecentEntry.html +13 -13
- package/lib/commonjs/docs/classes/types.ZelloTextMessage.html +13 -13
- package/lib/commonjs/docs/classes/types.ZelloUser.html +18 -18
- package/lib/commonjs/docs/classes/types.ZelloUserSupportedFeatures.html +5 -5
- package/lib/commonjs/docs/enums/events.ZelloEvent.html +138 -138
- package/lib/commonjs/docs/enums/types.ZelloAccountStatus.html +6 -6
- package/lib/commonjs/docs/enums/types.ZelloChannelAlertLevel.html +6 -6
- package/lib/commonjs/docs/enums/types.ZelloChannelConnectionStatus.html +5 -5
- package/lib/commonjs/docs/enums/types.ZelloConnectionError.html +5 -5
- package/lib/commonjs/docs/enums/types.ZelloConnectionState.html +6 -6
- package/lib/commonjs/docs/enums/types.ZelloContactType.html +6 -6
- package/lib/commonjs/docs/enums/types.ZelloDispatchCallStatus.html +6 -6
- package/lib/commonjs/docs/enums/types.ZelloOutgoingVoiceMessageError.html +4 -4
- package/lib/commonjs/docs/enums/types.ZelloOutgoingVoiceMessageState.html +7 -7
- package/lib/commonjs/docs/enums/types.ZelloRecentEntryType.html +7 -7
- package/lib/commonjs/docs/enums/types.ZelloUserStatus.html +10 -10
- package/lib/commonjs/docs/hierarchy.html +1 -0
- package/lib/commonjs/docs/index.html +11 -11
- package/lib/commonjs/docs/modules/events.html +1 -1
- package/lib/commonjs/docs/modules/index.html +1 -1
- package/lib/commonjs/docs/modules/sdk.html +1 -1
- package/lib/commonjs/docs/modules/types.html +1 -1
- package/lib/commonjs/docs/modules.html +1 -1
- package/lib/commonjs/docs/types/types.ZelloChannelOptions.html +14 -8
- package/lib/commonjs/docs/types/types.ZelloConfig.html +8 -6
- package/lib/commonjs/docs/types/types.ZelloConsoleSettings.html +14 -8
- package/lib/commonjs/docs/types/types.ZelloContact.html +8 -5
- package/lib/commonjs/docs/types/types.ZelloCredentials.html +8 -5
- package/lib/commonjs/docs/types/types.ZelloHistoryMessage.html +12 -7
- package/lib/commonjs/docs/types/types.ZelloMessage.html +10 -6
- package/lib/commonjs/sdk/index.js +1 -1
- package/lib/commonjs/sdk/index.js.map +1 -1
- package/lib/module/docs/assets/main.js +571 -440
- package/lib/module/docs/assets/main.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/assets/style.css +251 -229
- package/lib/module/docs/classes/sdk.Zello.html +120 -120
- package/lib/module/docs/classes/types.ZelloAlertMessage.html +13 -13
- package/lib/module/docs/classes/types.ZelloChannel.html +15 -15
- package/lib/module/docs/classes/types.ZelloChannelUser.html +5 -5
- package/lib/module/docs/classes/types.ZelloDispatchCall.html +7 -7
- package/lib/module/docs/classes/types.ZelloDispatchChannel.html +17 -17
- package/lib/module/docs/classes/types.ZelloGroupConversation.html +22 -22
- package/lib/module/docs/classes/types.ZelloHistoryAlertMessage.html +15 -15
- package/lib/module/docs/classes/types.ZelloHistoryImageMessage.html +13 -13
- package/lib/module/docs/classes/types.ZelloHistoryLocationMessage.html +21 -21
- package/lib/module/docs/classes/types.ZelloHistoryTextMessage.html +15 -15
- package/lib/module/docs/classes/types.ZelloHistoryVoiceMessage.html +15 -15
- package/lib/module/docs/classes/types.ZelloImageMessage.html +15 -15
- package/lib/module/docs/classes/types.ZelloIncomingEmergency.html +13 -13
- package/lib/module/docs/classes/types.ZelloIncomingVoiceMessage.html +11 -11
- package/lib/module/docs/classes/types.ZelloLocationMessage.html +19 -19
- package/lib/module/docs/classes/types.ZelloOutgoingEmergency.html +9 -9
- package/lib/module/docs/classes/types.ZelloOutgoingVoiceMessage.html +13 -13
- package/lib/module/docs/classes/types.ZelloRecentEntry.html +13 -13
- package/lib/module/docs/classes/types.ZelloTextMessage.html +13 -13
- package/lib/module/docs/classes/types.ZelloUser.html +18 -18
- package/lib/module/docs/classes/types.ZelloUserSupportedFeatures.html +5 -5
- package/lib/module/docs/enums/events.ZelloEvent.html +138 -138
- package/lib/module/docs/enums/types.ZelloAccountStatus.html +6 -6
- package/lib/module/docs/enums/types.ZelloChannelAlertLevel.html +6 -6
- package/lib/module/docs/enums/types.ZelloChannelConnectionStatus.html +5 -5
- package/lib/module/docs/enums/types.ZelloConnectionError.html +5 -5
- package/lib/module/docs/enums/types.ZelloConnectionState.html +6 -6
- package/lib/module/docs/enums/types.ZelloContactType.html +6 -6
- package/lib/module/docs/enums/types.ZelloDispatchCallStatus.html +6 -6
- package/lib/module/docs/enums/types.ZelloOutgoingVoiceMessageError.html +4 -4
- package/lib/module/docs/enums/types.ZelloOutgoingVoiceMessageState.html +7 -7
- package/lib/module/docs/enums/types.ZelloRecentEntryType.html +7 -7
- package/lib/module/docs/enums/types.ZelloUserStatus.html +10 -10
- package/lib/module/docs/hierarchy.html +1 -0
- package/lib/module/docs/index.html +11 -11
- package/lib/module/docs/modules/events.html +1 -1
- package/lib/module/docs/modules/index.html +1 -1
- package/lib/module/docs/modules/sdk.html +1 -1
- package/lib/module/docs/modules/types.html +1 -1
- package/lib/module/docs/modules.html +1 -1
- package/lib/module/docs/types/types.ZelloChannelOptions.html +14 -8
- package/lib/module/docs/types/types.ZelloConfig.html +8 -6
- package/lib/module/docs/types/types.ZelloConsoleSettings.html +14 -8
- package/lib/module/docs/types/types.ZelloContact.html +8 -5
- package/lib/module/docs/types/types.ZelloCredentials.html +8 -5
- package/lib/module/docs/types/types.ZelloHistoryMessage.html +12 -7
- package/lib/module/docs/types/types.ZelloMessage.html +10 -6
- package/lib/module/sdk/index.js +1 -1
- package/lib/module/sdk/index.js.map +1 -1
- package/package.json +1 -1
- package/react-native-zello-sdk.podspec +1 -1
- package/src/sdk/index.ts +1 -1
|
@@ -1,190 +1,190 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base="
|
|
2
|
-
This class is a singleton, and can be accessed via <a href="
|
|
3
|
-
</div
|
|
4
|
-
<a href="
|
|
5
|
-
<a href="
|
|
6
|
-
<a href="
|
|
7
|
-
<a href="
|
|
8
|
-
<a href="
|
|
9
|
-
<a href="
|
|
10
|
-
<a href="
|
|
11
|
-
<a href="
|
|
12
|
-
<a href="
|
|
13
|
-
<a href="
|
|
14
|
-
<a href="
|
|
15
|
-
<a href="
|
|
16
|
-
<a href="
|
|
17
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="
|
|
18
|
-
<a href="
|
|
19
|
-
<a href="
|
|
20
|
-
<a href="
|
|
21
|
-
<a href="
|
|
22
|
-
<a href="
|
|
23
|
-
<a href="
|
|
24
|
-
<a href="
|
|
25
|
-
<a href="
|
|
26
|
-
<a href="
|
|
27
|
-
<a href="
|
|
28
|
-
<a href="
|
|
29
|
-
<a href="
|
|
30
|
-
<a href="
|
|
31
|
-
<a href="
|
|
32
|
-
<a href="
|
|
33
|
-
<a href="
|
|
34
|
-
<a href="
|
|
35
|
-
<a href="
|
|
36
|
-
<a href="
|
|
37
|
-
<a href="
|
|
38
|
-
<a href="
|
|
39
|
-
<a href="
|
|
40
|
-
<a href="
|
|
41
|
-
<a href="
|
|
42
|
-
<a href="
|
|
43
|
-
<a href="
|
|
44
|
-
<a href="
|
|
45
|
-
<a href="
|
|
46
|
-
<a href="
|
|
47
|
-
<a href="
|
|
48
|
-
<a href="
|
|
49
|
-
<a href="
|
|
50
|
-
<a href="
|
|
51
|
-
<a href="
|
|
52
|
-
<a href="
|
|
53
|
-
</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"><
|
|
54
|
-
</div><
|
|
55
|
-
</div><
|
|
56
|
-
This is only expected to be valid when <a href="
|
|
57
|
-
</div><
|
|
58
|
-
</div><
|
|
59
|
-
</div><
|
|
60
|
-
</div><
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="../"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>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(() => window.app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">@zelloptt/react-native-zello-sdk</a><div id="tsd-toolbar-links"></div><button id="tsd-search-trigger" class="tsd-widget" aria-label="Search"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></button><dialog id="tsd-search" aria-label="Search"><input role="combobox" id="tsd-search-input" aria-controls="tsd-search-results" aria-autocomplete="list" aria-expanded="true" autocapitalize="off" autocomplete="off" placeholder="Search the docs" maxLength="100"/><ul role="listbox" id="tsd-search-results"></ul><div id="tsd-search-status" aria-live="polite" aria-atomic="true"><div>Preparing search index...</div></div></dialog><a href="#" class="tsd-widget menu" id="tsd-toolbar-menu-trigger" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb" aria-label="Breadcrumb"><li><a href="../modules/sdk.html">sdk</a></li><li><a href="" aria-current="page">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
|
+
This class is a singleton, and can be accessed via <a href="#getinstance" class="tsd-kind-method">Zello.getInstance</a>.</p>
|
|
3
|
+
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="49"><h4>Hierarchy</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-signature-type">default</span><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-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/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L58">src/sdk/index.ts:58</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h5 class="tsd-index-heading uppercase">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="#accountstatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>account<wbr/>Status</span></a>
|
|
4
|
+
<a href="#channels" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>channels</span></a>
|
|
5
|
+
<a href="#consolesettings" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>console<wbr/>Settings</span></a>
|
|
6
|
+
<a href="#emergencychannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emergency<wbr/>Channel</span></a>
|
|
7
|
+
<a href="#groupconversations" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>group<wbr/>Conversations</span></a>
|
|
8
|
+
<a href="#historyvoicemessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>history<wbr/>Voice<wbr/>Message</span></a>
|
|
9
|
+
<a href="#incomingemergencies" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>incoming<wbr/>Emergencies</span></a>
|
|
10
|
+
<a href="#incomingvoicemessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>incoming<wbr/>Voice<wbr/>Message</span></a>
|
|
11
|
+
<a href="#outgoingemergency" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outgoing<wbr/>Emergency</span></a>
|
|
12
|
+
<a href="#outgoingvoicemessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outgoing<wbr/>Voice<wbr/>Message</span></a>
|
|
13
|
+
<a href="#recents" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>recents</span></a>
|
|
14
|
+
<a href="#selectedcontact" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected<wbr/>Contact</span></a>
|
|
15
|
+
<a href="#state" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a>
|
|
16
|
+
<a href="#users" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>users</span></a>
|
|
17
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="#addlistener" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a>
|
|
18
|
+
<a href="#adduserstogroupconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Users<wbr/>To<wbr/>Group<wbr/>Conversation</span></a>
|
|
19
|
+
<a href="#configure" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure</span></a>
|
|
20
|
+
<a href="#connect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect</span></a>
|
|
21
|
+
<a href="#connectchannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect<wbr/>Channel</span></a>
|
|
22
|
+
<a href="#creategroupconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Group<wbr/>Conversation</span></a>
|
|
23
|
+
<a href="#destroy" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a>
|
|
24
|
+
<a href="#disconnect" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disconnect</span></a>
|
|
25
|
+
<a href="#disconnectchannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disconnect<wbr/>Channel</span></a>
|
|
26
|
+
<a href="#emit" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a>
|
|
27
|
+
<a href="#enddispatchcall" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end<wbr/>Dispatch<wbr/>Call</span></a>
|
|
28
|
+
<a href="#getchannel" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel</span></a>
|
|
29
|
+
<a href="#getgroupconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Group<wbr/>Conversation</span></a>
|
|
30
|
+
<a href="#gethistory" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>History</span></a>
|
|
31
|
+
<a href="#getimagedataforhistoryimagemessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Image<wbr/>Data<wbr/>For<wbr/>History<wbr/>Image<wbr/>Message</span></a>
|
|
32
|
+
<a href="#getuser" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User</span></a>
|
|
33
|
+
<a href="#leavegroupconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Group<wbr/>Conversation</span></a>
|
|
34
|
+
<a href="#listenercount" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a>
|
|
35
|
+
<a href="#mutecontact" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute<wbr/>Contact</span></a>
|
|
36
|
+
<a href="#playhistorymessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>play<wbr/>History<wbr/>Message</span></a>
|
|
37
|
+
<a href="#removealllisteners" class="tsd-index-link tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a>
|
|
38
|
+
<a href="#renamegroupconversation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rename<wbr/>Group<wbr/>Conversation</span></a>
|
|
39
|
+
<a href="#sendalert" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Alert</span></a>
|
|
40
|
+
<a href="#sendimage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Image</span></a>
|
|
41
|
+
<a href="#sendlocation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Location</span></a>
|
|
42
|
+
<a href="#sendtext" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Text</span></a>
|
|
43
|
+
<a href="#setaccountstatus" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Account<wbr/>Status</span></a>
|
|
44
|
+
<a href="#setselectedcontact" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Selected<wbr/>Contact</span></a>
|
|
45
|
+
<a href="#startemergency" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Emergency</span></a>
|
|
46
|
+
<a href="#startvoicemessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Voice<wbr/>Message</span></a>
|
|
47
|
+
<a href="#stopemergency" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Emergency</span></a>
|
|
48
|
+
<a href="#stophistorymessageplayback" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>History<wbr/>Message<wbr/>Playback</span></a>
|
|
49
|
+
<a href="#stopvoicemessage" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Voice<wbr/>Message</span></a>
|
|
50
|
+
<a href="#submitproblemreport" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Problem<wbr/>Report</span></a>
|
|
51
|
+
<a href="#unmutecontact" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute<wbr/>Contact</span></a>
|
|
52
|
+
<a href="#getinstance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Instance</span></a>
|
|
53
|
+
</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="accountstatus"><span>account<wbr/>Status</span><a href="#accountstatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">accountStatus</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloAccountStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloAccountStatus</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>The current account status. undefined when <a href="#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>
|
|
54
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L94">src/sdk/index.ts:94</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="channels"><span>channels</span><a href="#channels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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>
|
|
55
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L85">src/sdk/index.ts:85</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="consolesettings"><span>console<wbr/>Settings</span><a href="#consolesettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">consoleSettings</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloConsoleSettings.html" class="tsd-signature-type tsd-kind-type-alias">ZelloConsoleSettings</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>The console settings for the network.
|
|
56
|
+
This is only expected to be valid when <a href="#state" class="tsd-kind-property">state</a> is <a href="../enums/types.ZelloConnectionState.html#connected" class="tsd-kind-enum-member">ZelloConnectionState.Connected</a>.</p>
|
|
57
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L133">src/sdk/index.ts:133</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="emergencychannel"><span>emergency<wbr/>Channel</span><a href="#emergencychannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">emergencyChannel</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-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>The configured emergency channel.</p>
|
|
58
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L108">src/sdk/index.ts:108</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="groupconversations"><span>group<wbr/>Conversations</span><a href="#groupconversations" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">groupConversations</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloGroupConversation.html" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</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.ZelloGroupConversation.html" class="tsd-kind-class">ZelloGroupConversation</a> in the contact list. Sorted by name, ascending.</p>
|
|
59
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L89">src/sdk/index.ts:89</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="historyvoicemessage"><span>history<wbr/>Voice<wbr/>Message</span><a href="#historyvoicemessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">historyVoiceMessage</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloHistoryVoiceMessage.html" class="tsd-signature-type tsd-kind-class">ZelloHistoryVoiceMessage</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>The currently playing history voice message.</p>
|
|
60
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L127">src/sdk/index.ts:127</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="incomingemergencies"><span>incoming<wbr/>Emergencies</span><a href="#incomingemergencies" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">incomingEmergencies</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.
|
|
61
61
|
Sorted by start timestamp, ascending.</p>
|
|
62
|
-
</div><
|
|
63
|
-
</div><
|
|
64
|
-
</div><
|
|
65
|
-
</div><
|
|
66
|
-
</div><
|
|
67
|
-
</div><
|
|
68
|
-
</div><
|
|
69
|
-
</div><
|
|
62
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L113">src/sdk/index.ts:113</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="incomingvoicemessage"><span>incoming<wbr/>Voice<wbr/>Message</span><a href="#incomingvoicemessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">incomingVoiceMessage</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloIncomingVoiceMessage.html" class="tsd-signature-type tsd-kind-class">ZelloIncomingVoiceMessage</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>The current incoming voice message.</p>
|
|
63
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L99">src/sdk/index.ts:99</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="outgoingemergency"><span>outgoing<wbr/>Emergency</span><a href="#outgoingemergency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">outgoingEmergency</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloOutgoingEmergency.html" class="tsd-signature-type tsd-kind-class">ZelloOutgoingEmergency</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>The current outgoing emergency.</p>
|
|
64
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L117">src/sdk/index.ts:117</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="outgoingvoicemessage"><span>outgoing<wbr/>Voice<wbr/>Message</span><a href="#outgoingvoicemessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">outgoingVoiceMessage</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloOutgoingVoiceMessage.html" class="tsd-signature-type tsd-kind-class">ZelloOutgoingVoiceMessage</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>The current outgoing voice message.</p>
|
|
65
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L103">src/sdk/index.ts:103</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="recents"><span>recents</span><a href="#recents" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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>
|
|
66
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L122">src/sdk/index.ts:122</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="selectedcontact"><span>selected<wbr/>Contact</span><a href="#selectedcontact" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">selectedContact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>The currently selected contact.</p>
|
|
67
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L76">src/sdk/index.ts:76</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="state"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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>
|
|
68
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L71">src/sdk/index.ts:71</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="users"><span>users</span><a href="#users" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><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>
|
|
69
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L81">src/sdk/index.ts:81</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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Methods</h2></summary><section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="addlistener"><span>add<wbr/>Listener</span><a href="#addlistener" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="addlistener-1"><span class="tsd-kind-call-signature">addListener</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">listener</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">context</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EmitterSubscription</span><a href="#addlistener-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a listener to be invoked when events of the specified type are
|
|
70
70
|
emitted. An optional calling context may be provided. The data arguments
|
|
71
71
|
emitted will be passed to the listener function.</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">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>
|
|
73
|
-
</div
|
|
73
|
+
</div></li><li><span><span class="tsd-kind-parameter">listener</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Function to invoke when the specified event is
|
|
74
74
|
emitted</p>
|
|
75
|
-
</div
|
|
75
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">context</span>: <span class="tsd-signature-type">any</span></span><div class="tsd-comment tsd-typography"><p>Optional context object to use when invoking the
|
|
76
76
|
listener</p>
|
|
77
|
-
</div
|
|
77
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EmitterSubscription</span></h4><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></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="adduserstogroupconversation"><span>add<wbr/>Users<wbr/>To<wbr/>Group<wbr/>Conversation</span><a href="#adduserstogroupconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="adduserstogroupconversation-1"><span class="tsd-kind-call-signature">addUsersToGroupConversation</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">groupConversation</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloGroupConversation.html" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">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><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#adduserstogroupconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds users to the given group conversation.
|
|
78
78
|
This will trigger the <a href="../enums/events.ZelloEvent.html#group_conversation_users_added" class="tsd-kind-enum-member">ZelloEvent.GROUP_CONVERSATION_USERS_ADDED</a> and <a href="../enums/events.ZelloEvent.html#contact_list_updated" class="tsd-kind-enum-member">ZelloEvent.CONTACT_LIST_UPDATED</a> events.</p>
|
|
79
79
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">groupConversation</span>: <a href="types.ZelloGroupConversation.html" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a></span><div class="tsd-comment tsd-typography"><p>The group conversation to add users to.</p>
|
|
80
|
-
</div
|
|
81
|
-
</div
|
|
80
|
+
</div></li><li><span><span class="tsd-kind-parameter">users</span>: <a href="types.ZelloUser.html" class="tsd-signature-type tsd-kind-class">ZelloUser</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The users to add to the group conversation.</p>
|
|
81
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L595">src/sdk/index.ts:595</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="configure"><span>configure</span><a href="#configure" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="configure-1"><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> <a href="../types/types.ZelloConfig.html" class="tsd-signature-type tsd-kind-type-alias">ZelloConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#configure-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets configuration variables for the SDK.</p>
|
|
82
82
|
</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>
|
|
83
|
-
</div
|
|
83
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L155">src/sdk/index.ts:155</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="connect"><span>connect</span><a href="#connect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="connect-1"><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> <a href="../types/types.ZelloCredentials.html" class="tsd-signature-type tsd-kind-type-alias">ZelloCredentials</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#connect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Signs into to the Zello Work network using the provided credentials.
|
|
84
84
|
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>.
|
|
85
85
|
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>
|
|
86
86
|
</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>
|
|
87
|
-
</div
|
|
87
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L181">src/sdk/index.ts:181</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="connectchannel"><span>connect<wbr/>Channel</span><a href="#connectchannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="connectchannel-1"><span class="tsd-kind-call-signature">connectChannel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</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> <span class="tsd-signature-type">void</span><a href="#connectchannel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Connects to the given channel.
|
|
88
88
|
Once connected, the user will be able to send and receive messages from the channel.
|
|
89
89
|
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>
|
|
90
90
|
</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>
|
|
91
|
-
</div
|
|
91
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L271">src/sdk/index.ts:271</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="creategroupconversation"><span>create<wbr/>Group<wbr/>Conversation</span><a href="#creategroupconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="creategroupconversation-1"><span class="tsd-kind-call-signature">createGroupConversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">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> <span class="tsd-kind-parameter">displayName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#creategroupconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new group conversation with the given users.
|
|
92
92
|
This will trigger the <a href="../enums/events.ZelloEvent.html#group_conversation_created" class="tsd-kind-enum-member">ZelloEvent.GROUP_CONVERSATION_CREATED</a> and <a href="../enums/events.ZelloEvent.html#contact_list_updated" class="tsd-kind-enum-member">ZelloEvent.CONTACT_LIST_UPDATED</a> events.</p>
|
|
93
93
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">users</span>: <a href="types.ZelloUser.html" class="tsd-signature-type tsd-kind-class">ZelloUser</a><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The users to create the group conversation with.</p>
|
|
94
|
-
</div
|
|
95
|
-
</div
|
|
94
|
+
</div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">displayName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Optional; The display name of the group conversation. The conversation can be renamed later by using <a href="#renamegroupconversation" class="tsd-kind-method">renameGroupConversation</a>.</p>
|
|
95
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L572">src/sdk/index.ts:572</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="destroy"><span>destroy</span><a href="#destroy" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="destroy-1"><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#destroy-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Destroys the SDK instance and cleans up resources.
|
|
96
96
|
Call this when you are done using the SDK instance for good (application quit).</p>
|
|
97
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><
|
|
97
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L170">src/sdk/index.ts:170</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="disconnect"><span>disconnect</span><a href="#disconnect" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="disconnect-1"><span class="tsd-kind-call-signature">disconnect</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#disconnect-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Signs out of the Zello Work network.
|
|
98
98
|
This will trigger the <a href="../enums/events.ZelloEvent.html#disconnected" class="tsd-kind-enum-member">ZelloEvent.DISCONNECTED</a> event.</p>
|
|
99
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><
|
|
99
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L201">src/sdk/index.ts:201</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="disconnectchannel"><span>disconnect<wbr/>Channel</span><a href="#disconnectchannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="disconnectchannel-1"><span class="tsd-kind-call-signature">disconnectChannel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</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> <span class="tsd-signature-type">void</span><a href="#disconnectchannel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Disconnects from the given channel.
|
|
100
100
|
Once disconnected, the user will no longer be able to send or receive messages from the channel.
|
|
101
101
|
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>
|
|
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">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>
|
|
103
|
-
</div
|
|
103
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L289">src/sdk/index.ts:289</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="emit"><span>emit</span><a href="#emit" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="emit-1"><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-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</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="#emit-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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
|
|
104
104
|
particular type will be notified.</p>
|
|
105
105
|
</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>
|
|
106
|
-
</div
|
|
106
|
+
</div></li><li><span><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"><div class="tsd-tag-example"><h4 class="tsd-anchor-link" id="example">Example<a href="#example" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="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-5">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-7">// logs 'abc'</span>
|
|
107
107
|
</code><button type="button">Copy</button></pre>
|
|
108
108
|
|
|
109
|
-
</div></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></div></li></ul></section><section class="tsd-panel tsd-member"><
|
|
109
|
+
</div></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></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="enddispatchcall"><span>end<wbr/>Dispatch<wbr/>Call</span><a href="#enddispatchcall" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="enddispatchcall-1"><span class="tsd-kind-call-signature">endDispatchCall</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">channel</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloDispatchChannel.html" class="tsd-signature-type tsd-kind-class">ZelloDispatchChannel</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#enddispatchcall-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Ends the dispatch call for the given dispatch channel.
|
|
110
110
|
This will trigger the <a href="../enums/events.ZelloEvent.html#dispatch_call_ended" class="tsd-kind-enum-member">ZelloEvent.DISPATCH_CALL_ENDED</a> event.</p>
|
|
111
|
-
<p>If <a href="
|
|
111
|
+
<p>If <a href="#consolesettings" class="tsd-kind-property">ZelloConsoleSettings.allowNonDispatchersToEndCalls</a> is false, this method will do nothing.</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">channel</span>: <a href="types.ZelloDispatchChannel.html" class="tsd-signature-type tsd-kind-class">ZelloDispatchChannel</a></span><div class="tsd-comment tsd-typography"><p>The dispatch channel to end the call for.</p>
|
|
113
|
-
</div
|
|
113
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L558">src/sdk/index.ts:558</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getchannel"><span>get<wbr/>Channel</span><a href="#getchannel" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getchannel-1"><span class="tsd-kind-call-signature">getChannel</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloChannel.html" class="tsd-signature-type tsd-kind-class">ZelloChannel</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#getchannel-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the channel with the given name. Case-insensitive.</p>
|
|
114
114
|
</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>
|
|
115
|
-
</div
|
|
116
|
-
<
|
|
115
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.ZelloChannel.html" class="tsd-signature-type tsd-kind-class">ZelloChannel</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>The channel with the given name, or null if no channel with that name exists.</p>
|
|
116
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L223">src/sdk/index.ts:223</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getgroupconversation"><span>get<wbr/>Group<wbr/>Conversation</span><a href="#getgroupconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getgroupconversation-1"><span class="tsd-kind-call-signature">getGroupConversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloGroupConversation.html" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#getgroupconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the group conversation with the given name. Case-insensitive.</p>
|
|
117
117
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The name of the group conversation to search for.</p>
|
|
118
|
-
</div
|
|
119
|
-
<
|
|
118
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.ZelloGroupConversation.html" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>The group conversation with the given name, or null if no group conversation with that name exists.</p>
|
|
119
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L232">src/sdk/index.ts:232</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="gethistory"><span>get<wbr/>History</span><a href="#gethistory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="gethistory-1"><span class="tsd-kind-call-signature">getHistory</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">size</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the history messages for the given contact.</p>
|
|
120
120
|
</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>
|
|
121
|
-
</div
|
|
122
|
-
</div
|
|
123
|
-
<
|
|
121
|
+
</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>
|
|
122
|
+
</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>
|
|
123
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L456">src/sdk/index.ts:456</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getimagedataforhistoryimagemessage"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getimagedataforhistoryimagemessage-1"><span class="tsd-kind-call-signature">getImageDataForHistoryImageMessage</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloHistoryImageMessage.html" class="tsd-signature-type tsd-kind-class">ZelloHistoryImageMessage</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span><a href="#getimagedataforhistoryimagemessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the image data for the given history image message.</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">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>
|
|
125
|
-
</div
|
|
126
|
-
<
|
|
125
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">></span></h4><p>The image data for the given history image message.</p>
|
|
126
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L528">src/sdk/index.ts:528</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getuser"><span>get<wbr/>User</span><a href="#getuser" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getuser-1"><span class="tsd-kind-call-signature">getUser</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloUser.html" class="tsd-signature-type tsd-kind-class">ZelloUser</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><a href="#getuser-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the user with the given name. Case-insensitive.</p>
|
|
127
127
|
</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>
|
|
128
|
-
</div
|
|
129
|
-
<
|
|
128
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.ZelloUser.html" class="tsd-signature-type tsd-kind-class">ZelloUser</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><p>The user with the given name, or null if no user with that name exists.</p>
|
|
129
|
+
<aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L214">src/sdk/index.ts:214</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="leavegroupconversation"><span>leave<wbr/>Group<wbr/>Conversation</span><a href="#leavegroupconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="leavegroupconversation-1"><span class="tsd-kind-call-signature">leaveGroupConversation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupConversation</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloGroupConversation.html" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#leavegroupconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes the user from the group conversation.
|
|
130
130
|
This will trigger the <a href="../enums/events.ZelloEvent.html#group_conversation_left" class="tsd-kind-enum-member">ZelloEvent.GROUP_CONVERSATION_LEFT</a> and <a href="../enums/events.ZelloEvent.html#contact_list_updated" class="tsd-kind-enum-member">ZelloEvent.CONTACT_LIST_UPDATED</a> events.</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">groupConversation</span>: <a href="types.ZelloGroupConversation.html" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a></span><div class="tsd-comment tsd-typography"><p>The group conversation to leave.</p>
|
|
132
|
-
</div
|
|
132
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L620">src/sdk/index.ts:620</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="listenercount"><span>listener<wbr/>Count</span><a href="#listenercount" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="listenercount-1"><span class="tsd-kind-call-signature">listenerCount</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><a href="#listenercount-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Returns the number of listeners that are currently registered for the given
|
|
133
133
|
event.</p>
|
|
134
134
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">eventType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Name of the event to query</p>
|
|
135
|
-
</div
|
|
135
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><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></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="mutecontact"><span>mute<wbr/>Contact</span><a href="#mutecontact" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="mutecontact-1"><span class="tsd-kind-call-signature">muteContact</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#mutecontact-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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.
|
|
136
136
|
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>
|
|
137
137
|
</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>
|
|
138
|
-
</div
|
|
138
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L404">src/sdk/index.ts:404</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="playhistorymessage"><span>play<wbr/>History<wbr/>Message</span><a href="#playhistorymessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="playhistorymessage-1"><span class="tsd-kind-call-signature">playHistoryMessage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloHistoryVoiceMessage.html" class="tsd-signature-type tsd-kind-class">ZelloHistoryVoiceMessage</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#playhistorymessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Plays the given history message.
|
|
139
139
|
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>
|
|
140
140
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">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>
|
|
141
|
-
</div
|
|
141
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L495">src/sdk/index.ts:495</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><h3 class="tsd-anchor-link" id="removealllisteners"><span>remove<wbr/>All<wbr/>Listeners</span><a href="#removealllisteners" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-inherited tsd-is-external"><li class="tsd-is-inherited tsd-is-external"><div class="tsd-signature tsd-anchor-link" id="removealllisteners-1"><span class="tsd-kind-call-signature">removeAllListeners</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">eventType</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#removealllisteners-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Removes all of the registered listeners, including those registered as
|
|
142
142
|
listener maps.</p>
|
|
143
143
|
</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
|
|
144
144
|
listeners to remove</p>
|
|
145
|
-
</div
|
|
145
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><p>Inherited from EventEmitter.removeAllListeners</p><ul><li>Defined in example/node_modules/react-native/Libraries/vendor/emitter/EventEmitter.d.ts:139</li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="renamegroupconversation"><span>rename<wbr/>Group<wbr/>Conversation</span><a href="#renamegroupconversation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="renamegroupconversation-1"><span class="tsd-kind-call-signature">renameGroupConversation</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">groupConversation</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloGroupConversation.html" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#renamegroupconversation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Renames the group conversation.
|
|
146
146
|
This will trigger the <a href="../enums/events.ZelloEvent.html#group_conversation_renamed" class="tsd-kind-enum-member">ZelloEvent.GROUP_CONVERSATION_RENAMED</a> and <a href="../enums/events.ZelloEvent.html#contact_list_updated" class="tsd-kind-enum-member">ZelloEvent.CONTACT_LIST_UPDATED</a> events.</p>
|
|
147
147
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">groupConversation</span>: <a href="types.ZelloGroupConversation.html" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a></span><div class="tsd-comment tsd-typography"><p>The group conversation to rename.</p>
|
|
148
|
-
</div
|
|
149
|
-
</div
|
|
148
|
+
</div></li><li><span><span class="tsd-kind-parameter">name</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The new name for the group conversation.</p>
|
|
149
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L637">src/sdk/index.ts:637</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sendalert"><span>send<wbr/>Alert</span><a href="#sendalert" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="sendalert-1"><span class="tsd-kind-call-signature">sendAlert</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">level</span><span class="tsd-signature-symbol">?:</span> <a href="../enums/types.ZelloChannelAlertLevel.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelAlertLevel</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#sendalert-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends the alert message to the given contact.
|
|
150
150
|
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>
|
|
151
151
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">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>
|
|
152
|
-
</div
|
|
153
|
-
</div
|
|
154
|
-
</div
|
|
152
|
+
</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>
|
|
153
|
+
</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>
|
|
154
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L375">src/sdk/index.ts:375</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sendimage"><span>send<wbr/>Image</span><a href="#sendimage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="sendimage-1"><span class="tsd-kind-call-signature">sendImage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">data</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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="#sendimage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends the image message data to the given contact.
|
|
155
155
|
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>
|
|
156
156
|
</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>
|
|
157
|
-
</div
|
|
158
|
-
</div
|
|
157
|
+
</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>
|
|
158
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L333">src/sdk/index.ts:333</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sendlocation"><span>send<wbr/>Location</span><a href="#sendlocation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="sendlocation-1"><span class="tsd-kind-call-signature">sendLocation</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#sendlocation-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends the alert message to the given contact.
|
|
159
159
|
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>
|
|
160
160
|
</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>
|
|
161
|
-
</div
|
|
161
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L346">src/sdk/index.ts:346</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="sendtext"><span>send<wbr/>Text</span><a href="#sendtext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="sendtext-1"><span class="tsd-kind-call-signature">sendText</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#sendtext-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sends the text message to the given contact.
|
|
162
162
|
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>
|
|
163
163
|
</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>
|
|
164
|
-
</div
|
|
165
|
-
</div
|
|
164
|
+
</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>
|
|
165
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L360">src/sdk/index.ts:360</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setaccountstatus"><span>set<wbr/>Account<wbr/>Status</span><a href="#setaccountstatus" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setaccountstatus-1"><span class="tsd-kind-call-signature">setAccountStatus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloAccountStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloAccountStatus</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setaccountstatus-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the user's online account status.
|
|
166
166
|
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>
|
|
167
167
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">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>
|
|
168
|
-
</div
|
|
168
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L257">src/sdk/index.ts:257</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="setselectedcontact"><span>set<wbr/>Selected<wbr/>Contact</span><a href="#setselectedcontact" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="setselectedcontact-1"><span class="tsd-kind-call-signature">setSelectedContact</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setselectedcontact-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Sets the selected contact.
|
|
169
169
|
While optional, this is typically used for tracking the contact that the user is currently interacting with.
|
|
170
170
|
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>
|
|
171
171
|
</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>
|
|
172
|
-
</div
|
|
172
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L244">src/sdk/index.ts:244</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="startemergency"><span>start<wbr/>Emergency</span><a href="#startemergency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="startemergency-1"><span class="tsd-kind-call-signature">startEmergency</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#startemergency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Starts an outgoing emergency to the emergency channel.
|
|
173
173
|
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.
|
|
174
174
|
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>
|
|
175
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><
|
|
175
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L430">src/sdk/index.ts:430</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="startvoicemessage"><span>start<wbr/>Voice<wbr/>Message</span><a href="#startvoicemessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="startvoicemessage-1"><span class="tsd-kind-call-signature">startVoiceMessage</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#startvoicemessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Starts a voice message with the given contact.
|
|
176
176
|
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.
|
|
177
177
|
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>
|
|
178
178
|
</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>
|
|
179
|
-
</div
|
|
179
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L307">src/sdk/index.ts:307</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stopemergency"><span>stop<wbr/>Emergency</span><a href="#stopemergency" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="stopemergency-1"><span class="tsd-kind-call-signature">stopEmergency</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#stopemergency-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Stops the outgoing emergency.
|
|
180
180
|
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>
|
|
181
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><
|
|
181
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L442">src/sdk/index.ts:442</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stophistorymessageplayback"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="stophistorymessageplayback-1"><span class="tsd-kind-call-signature">stopHistoryMessagePlayback</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#stophistorymessageplayback-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Stops the current history message playback.
|
|
182
182
|
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>
|
|
183
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><
|
|
183
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L515">src/sdk/index.ts:515</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="stopvoicemessage"><span>stop<wbr/>Voice<wbr/>Message</span><a href="#stopvoicemessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="stopvoicemessage-1"><span class="tsd-kind-call-signature">stopVoiceMessage</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#stopvoicemessage-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Stops the current outgoing voice message.
|
|
184
184
|
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>
|
|
185
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><
|
|
185
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L319">src/sdk/index.ts:319</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="submitproblemreport"><span>submit<wbr/>Problem<wbr/>Report</span><a href="#submitproblemreport" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="submitproblemreport-1"><span class="tsd-kind-call-signature">submitProblemReport</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#submitproblemreport-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Submits a problem report to Zello.
|
|
186
186
|
Additionally, please contact us to provide more information on what happened.</p>
|
|
187
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><
|
|
187
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L391">src/sdk/index.ts:391</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="unmutecontact"><span>unmute<wbr/>Contact</span><a href="#unmutecontact" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="unmutecontact-1"><span class="tsd-kind-call-signature">unmuteContact</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">contact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#unmutecontact-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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.
|
|
188
188
|
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>
|
|
189
189
|
</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>
|
|
190
|
-
</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/e355ab73e131513fdb622f5ec9adfd3c78728d3a/src/sdk/index.ts#L417">src/sdk/index.ts:417</a></li></ul></aside></div></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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getinstance-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getInstance</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-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div 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/e355ab73e131513fdb622f5ec9adfd3c78728d3a/src/sdk/index.ts#L61">src/sdk/index.ts:61</a></li></ul></aside></div></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" aria-hidden="true"><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" aria-hidden="true"><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="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><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" aria-label="Property"><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" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>channels</span></a><a href="#consolesettings" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>console<wbr/>Settings</span></a><a href="#emergencychannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emergency<wbr/>Channel</span></a><a href="#groupconversations" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>group<wbr/>Conversations</span></a><a href="#historyvoicemessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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" aria-label="Property"><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="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addlistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a><a href="#adduserstogroupconversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Users<wbr/>To<wbr/>Group<wbr/>Conversation</span></a><a href="#configure" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect<wbr/>Channel</span></a><a href="#creategroupconversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Group<wbr/>Conversation</span></a><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a><a href="#enddispatchcall" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end<wbr/>Dispatch<wbr/>Call</span></a><a href="#getchannel" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel</span></a><a href="#getgroupconversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Group<wbr/>Conversation</span></a><a href="#gethistory" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>History</span></a><a href="#getimagedataforhistoryimagemessage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User</span></a><a href="#leavegroupconversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Group<wbr/>Conversation</span></a><a href="#listenercount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a><a href="#renamegroupconversation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rename<wbr/>Group<wbr/>Conversation</span></a><a href="#sendalert" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Alert</span></a><a href="#sendimage" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Image</span></a><a href="#sendlocation" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Location</span></a><a href="#sendtext" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Text</span></a><a href="#setaccountstatus" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Account<wbr/>Status</span></a><a href="#setselectedcontact" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Selected<wbr/>Contact</span></a><a href="#startemergency" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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" aria-label="Method"><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="../modules.html">@zelloptt/react-native-zello-sdk</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
|
|
190
|
+
</div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L417">src/sdk/index.ts:417</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getinstance"><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="getinstance-1"><span class="tsd-kind-call-signature">getInstance</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">Zello</a><a href="#getinstance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="" 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/404e3f047b3646c631afcdd844a9ad7010732747/src/sdk/index.ts#L61">src/sdk/index.ts:61</a></li></ul></aside></div></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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h3>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="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#accountstatus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>account<wbr/>Status</span></a><a href="#channels"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>channels</span></a><a href="#consolesettings"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>console<wbr/>Settings</span></a><a href="#emergencychannel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>emergency<wbr/>Channel</span></a><a href="#groupconversations"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>group<wbr/>Conversations</span></a><a href="#historyvoicemessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>history<wbr/>Voice<wbr/>Message</span></a><a href="#incomingemergencies"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>incoming<wbr/>Emergencies</span></a><a href="#incomingvoicemessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>incoming<wbr/>Voice<wbr/>Message</span></a><a href="#outgoingemergency"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outgoing<wbr/>Emergency</span></a><a href="#outgoingvoicemessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>outgoing<wbr/>Voice<wbr/>Message</span></a><a href="#recents"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>recents</span></a><a href="#selectedcontact"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>selected<wbr/>Contact</span></a><a href="#state"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state</span></a><a href="#users"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><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="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addlistener" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Listener</span></a><a href="#adduserstogroupconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Users<wbr/>To<wbr/>Group<wbr/>Conversation</span></a><a href="#configure"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>configure</span></a><a href="#connect"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect</span></a><a href="#connectchannel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>connect<wbr/>Channel</span></a><a href="#creategroupconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Group<wbr/>Conversation</span></a><a href="#destroy"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a><a href="#disconnect"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>disconnect</span></a><a href="#disconnectchannel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>emit</span></a><a href="#enddispatchcall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>end<wbr/>Dispatch<wbr/>Call</span></a><a href="#getchannel"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Channel</span></a><a href="#getgroupconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Group<wbr/>Conversation</span></a><a href="#gethistory"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>History</span></a><a href="#getimagedataforhistoryimagemessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Image<wbr/>Data<wbr/>For<wbr/>History<wbr/>Image<wbr/>Message</span></a><a href="#getuser"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>User</span></a><a href="#leavegroupconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>leave<wbr/>Group<wbr/>Conversation</span></a><a href="#listenercount" class="tsd-is-inherited tsd-is-external"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>listener<wbr/>Count</span></a><a href="#mutecontact"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>mute<wbr/>Contact</span></a><a href="#playhistorymessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><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" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>All<wbr/>Listeners</span></a><a href="#renamegroupconversation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>rename<wbr/>Group<wbr/>Conversation</span></a><a href="#sendalert"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Alert</span></a><a href="#sendimage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Image</span></a><a href="#sendlocation"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Location</span></a><a href="#sendtext"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>send<wbr/>Text</span></a><a href="#setaccountstatus"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Account<wbr/>Status</span></a><a href="#setselectedcontact"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Selected<wbr/>Contact</span></a><a href="#startemergency"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Emergency</span></a><a href="#startvoicemessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>start<wbr/>Voice<wbr/>Message</span></a><a href="#stopemergency"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Emergency</span></a><a href="#stophistorymessageplayback"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>History<wbr/>Message<wbr/>Playback</span></a><a href="#stopvoicemessage"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>stop<wbr/>Voice<wbr/>Message</span></a><a href="#submitproblemreport"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>submit<wbr/>Problem<wbr/>Report</span></a><a href="#unmutecontact"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>unmute<wbr/>Contact</span></a><a href="#getinstance"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Instance</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@zelloptt/react-native-zello-sdk</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
|