@zelloptt/react-native-zello-sdk 2.0.0 → 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.map +1 -1
- package/lib/commonjs/docs/assets/style.css +2 -9
- package/lib/commonjs/docs/classes/sdk.Zello.html +66 -66
- package/lib/commonjs/docs/classes/types.ZelloAlertMessage.html +7 -7
- package/lib/commonjs/docs/classes/types.ZelloChannel.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloChannelUser.html +2 -2
- package/lib/commonjs/docs/classes/types.ZelloDispatchCall.html +4 -4
- package/lib/commonjs/docs/classes/types.ZelloDispatchChannel.html +9 -9
- package/lib/commonjs/docs/classes/types.ZelloGroupConversation.html +11 -11
- package/lib/commonjs/docs/classes/types.ZelloHistoryAlertMessage.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloHistoryImageMessage.html +7 -7
- package/lib/commonjs/docs/classes/types.ZelloHistoryLocationMessage.html +11 -11
- package/lib/commonjs/docs/classes/types.ZelloHistoryTextMessage.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloHistoryVoiceMessage.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloImageMessage.html +8 -8
- package/lib/commonjs/docs/classes/types.ZelloIncomingEmergency.html +7 -7
- package/lib/commonjs/docs/classes/types.ZelloIncomingVoiceMessage.html +6 -6
- package/lib/commonjs/docs/classes/types.ZelloLocationMessage.html +10 -10
- package/lib/commonjs/docs/classes/types.ZelloOutgoingEmergency.html +5 -5
- package/lib/commonjs/docs/classes/types.ZelloOutgoingVoiceMessage.html +7 -7
- package/lib/commonjs/docs/classes/types.ZelloRecentEntry.html +7 -7
- package/lib/commonjs/docs/classes/types.ZelloTextMessage.html +7 -7
- package/lib/commonjs/docs/classes/types.ZelloUser.html +9 -9
- package/lib/commonjs/docs/classes/types.ZelloUserSupportedFeatures.html +3 -3
- package/lib/commonjs/docs/enums/events.ZelloEvent.html +45 -45
- package/lib/commonjs/docs/enums/types.ZelloAccountStatus.html +3 -3
- package/lib/commonjs/docs/enums/types.ZelloChannelAlertLevel.html +3 -3
- package/lib/commonjs/docs/enums/types.ZelloChannelConnectionStatus.html +2 -2
- package/lib/commonjs/docs/enums/types.ZelloConnectionError.html +2 -2
- package/lib/commonjs/docs/enums/types.ZelloConnectionState.html +2 -2
- package/lib/commonjs/docs/enums/types.ZelloContactType.html +2 -2
- package/lib/commonjs/docs/enums/types.ZelloDispatchCallStatus.html +2 -2
- package/lib/commonjs/docs/enums/types.ZelloOutgoingVoiceMessageError.html +2 -2
- package/lib/commonjs/docs/enums/types.ZelloOutgoingVoiceMessageState.html +2 -2
- package/lib/commonjs/docs/enums/types.ZelloRecentEntryType.html +2 -2
- package/lib/commonjs/docs/enums/types.ZelloUserStatus.html +5 -5
- package/lib/commonjs/docs/index.html +7 -7
- package/lib/commonjs/docs/modules/index.html +1 -1
- package/lib/commonjs/docs/types/types.ZelloChannelOptions.html +7 -7
- package/lib/commonjs/docs/types/types.ZelloConfig.html +6 -6
- package/lib/commonjs/docs/types/types.ZelloConsoleSettings.html +7 -7
- package/lib/commonjs/docs/types/types.ZelloContact.html +4 -4
- package/lib/commonjs/docs/types/types.ZelloCredentials.html +4 -4
- package/lib/commonjs/docs/types/types.ZelloHistoryMessage.html +6 -6
- package/lib/commonjs/docs/types/types.ZelloMessage.html +5 -5
- package/lib/commonjs/sdk/index.js +1 -1
- package/lib/commonjs/sdk/index.js.map +1 -1
- package/lib/module/docs/assets/main.js.map +1 -1
- package/lib/module/docs/assets/style.css +2 -9
- package/lib/module/docs/classes/sdk.Zello.html +66 -66
- package/lib/module/docs/classes/types.ZelloAlertMessage.html +7 -7
- package/lib/module/docs/classes/types.ZelloChannel.html +8 -8
- package/lib/module/docs/classes/types.ZelloChannelUser.html +2 -2
- package/lib/module/docs/classes/types.ZelloDispatchCall.html +4 -4
- package/lib/module/docs/classes/types.ZelloDispatchChannel.html +9 -9
- package/lib/module/docs/classes/types.ZelloGroupConversation.html +11 -11
- package/lib/module/docs/classes/types.ZelloHistoryAlertMessage.html +8 -8
- package/lib/module/docs/classes/types.ZelloHistoryImageMessage.html +7 -7
- package/lib/module/docs/classes/types.ZelloHistoryLocationMessage.html +11 -11
- package/lib/module/docs/classes/types.ZelloHistoryTextMessage.html +8 -8
- package/lib/module/docs/classes/types.ZelloHistoryVoiceMessage.html +8 -8
- package/lib/module/docs/classes/types.ZelloImageMessage.html +8 -8
- package/lib/module/docs/classes/types.ZelloIncomingEmergency.html +7 -7
- package/lib/module/docs/classes/types.ZelloIncomingVoiceMessage.html +6 -6
- package/lib/module/docs/classes/types.ZelloLocationMessage.html +10 -10
- package/lib/module/docs/classes/types.ZelloOutgoingEmergency.html +5 -5
- package/lib/module/docs/classes/types.ZelloOutgoingVoiceMessage.html +7 -7
- package/lib/module/docs/classes/types.ZelloRecentEntry.html +7 -7
- package/lib/module/docs/classes/types.ZelloTextMessage.html +7 -7
- package/lib/module/docs/classes/types.ZelloUser.html +9 -9
- package/lib/module/docs/classes/types.ZelloUserSupportedFeatures.html +3 -3
- package/lib/module/docs/enums/events.ZelloEvent.html +45 -45
- package/lib/module/docs/enums/types.ZelloAccountStatus.html +3 -3
- package/lib/module/docs/enums/types.ZelloChannelAlertLevel.html +3 -3
- package/lib/module/docs/enums/types.ZelloChannelConnectionStatus.html +2 -2
- package/lib/module/docs/enums/types.ZelloConnectionError.html +2 -2
- package/lib/module/docs/enums/types.ZelloConnectionState.html +2 -2
- package/lib/module/docs/enums/types.ZelloContactType.html +2 -2
- package/lib/module/docs/enums/types.ZelloDispatchCallStatus.html +2 -2
- package/lib/module/docs/enums/types.ZelloOutgoingVoiceMessageError.html +2 -2
- package/lib/module/docs/enums/types.ZelloOutgoingVoiceMessageState.html +2 -2
- package/lib/module/docs/enums/types.ZelloRecentEntryType.html +2 -2
- package/lib/module/docs/enums/types.ZelloUserStatus.html +5 -5
- package/lib/module/docs/index.html +7 -7
- package/lib/module/docs/modules/index.html +1 -1
- package/lib/module/docs/types/types.ZelloChannelOptions.html +7 -7
- package/lib/module/docs/types/types.ZelloConfig.html +6 -6
- package/lib/module/docs/types/types.ZelloConsoleSettings.html +7 -7
- package/lib/module/docs/types/types.ZelloContact.html +4 -4
- package/lib/module/docs/types/types.ZelloCredentials.html +4 -4
- package/lib/module/docs/types/types.ZelloHistoryMessage.html +6 -6
- package/lib/module/docs/types/types.ZelloMessage.html +5 -5
- package/lib/module/sdk/index.js +1 -1
- package/lib/module/sdk/index.js.map +1 -1
- package/package.json +1 -1
- package/src/sdk/index.ts +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
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>ZelloDispatchChannel | @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/types.html">types</a></li><li><a href="" aria-current="page">ZelloDispatchChannel</a></li></ul><h1>Class ZelloDispatchChannel</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A Zello dispatch channel. A dispatch channel is a special type of channel that has calls between a user and a dispatcher.</p>
|
|
2
|
-
</div
|
|
2
|
+
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="245"><h4>Hierarchy (<a href="../hierarchy.html#types.ZelloDispatchChannel">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="types.ZelloChannel.html" class="tsd-signature-type tsd-kind-class">ZelloChannel</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ZelloDispatchChannel</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/types/index.ts#L156">src/types/index.ts:156</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">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
3
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#connectionstatus" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connection<wbr/>Status</span></a>
|
|
4
4
|
<a href="#currentcall" 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>current<wbr/>Call</span></a>
|
|
5
5
|
<a href="#ismuted" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Muted</span></a>
|
|
@@ -7,13 +7,13 @@
|
|
|
7
7
|
<a href="#options" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a>
|
|
8
8
|
<a href="#type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
9
9
|
<a href="#usersonline" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>users<wbr/>Online</span></a>
|
|
10
|
-
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzellodispatchchannel"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZelloDispatchChannel</span><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-kind-parameter">isMuted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">connectionStatus</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloChannelConnectionStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelConnectionStatus</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">usersOnline</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloChannelOptions.html" class="tsd-signature-type tsd-kind-type-alias">ZelloChannelOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">currentCall</span><span class="tsd-signature-symbol">:</span> <
|
|
11
|
-
</div><
|
|
12
|
-
</div><
|
|
10
|
+
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzellodispatchchannel"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZelloDispatchChannel</span><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-kind-parameter">isMuted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">connectionStatus</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloChannelConnectionStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelConnectionStatus</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">usersOnline</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloChannelOptions.html" class="tsd-signature-type tsd-kind-type-alias">ZelloChannelOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">currentCall</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloDispatchCall.html" class="tsd-signature-type tsd-kind-class">ZelloDispatchCall</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ZelloDispatchChannel</a><a href="#constructorzellodispatchchannel" aria-label="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-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></li><li><span><span class="tsd-kind-parameter">isMuted</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">connectionStatus</span>: <a href="../enums/types.ZelloChannelConnectionStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelConnectionStatus</a></span></li><li><span><span class="tsd-kind-parameter">usersOnline</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/types.ZelloChannelOptions.html" class="tsd-signature-type tsd-kind-type-alias">ZelloChannelOptions</a></span></li><li><span><span class="tsd-kind-parameter">currentCall</span>: <a href="types.ZelloDispatchCall.html" class="tsd-signature-type tsd-kind-class">ZelloDispatchCall</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZelloDispatchChannel</a></h4><aside class="tsd-sources"><p>Overrides <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L162">src/types/index.ts:162</a></li></ul></aside></div></li></ul></section></section></details><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 tsd-is-inherited"><h3 class="tsd-anchor-link" id="connectionstatus"><span>connection<wbr/>Status</span><a href="#connectionstatus" aria-label="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">connectionStatus</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloChannelConnectionStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelConnectionStatus</a></div><div class="tsd-comment tsd-typography"><p>The connection status of the channel. Connecting to a channel is asynchronous.</p>
|
|
11
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#connectionstatus">connectionStatus</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L127">src/types/index.ts:127</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="currentcall"><code class="tsd-tag">Readonly</code><span>current<wbr/>Call</span><a href="#currentcall" aria-label="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">currentCall</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloDispatchCall.html" class="tsd-signature-type tsd-kind-class">ZelloDispatchCall</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>The current call on the dispatch channel, if any.</p>
|
|
12
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L160">src/types/index.ts:160</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ismuted"><span>is<wbr/>Muted</span><a href="#ismuted" aria-label="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">isMuted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the contact is muted.
|
|
13
13
|
When a contact is muted, messages from the contact will not play live, but they will still be in the history.</p>
|
|
14
|
-
</div><
|
|
14
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#ismuted">isMuted</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L123">src/types/index.ts:123</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the contact. Names are unique within their type.
|
|
15
15
|
When comparing names, it is recommended to do so in a case-insensitive manner.</p>
|
|
16
|
-
</div><
|
|
17
|
-
</div><
|
|
18
|
-
</div><
|
|
19
|
-
</div><
|
|
16
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L121">src/types/index.ts:121</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="options"><span>options</span><a href="#options" aria-label="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">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloChannelOptions.html" class="tsd-signature-type tsd-kind-type-alias">ZelloChannelOptions</a></div><div class="tsd-comment tsd-typography"><p>The options of the channel.</p>
|
|
17
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#options">options</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L135">src/types/index.ts:135</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" aria-label="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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloContactType.html" class="tsd-signature-type tsd-kind-enum">ZelloContactType</a></div><div class="tsd-comment tsd-typography"><p>The type of contact.</p>
|
|
18
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L122">src/types/index.ts:122</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="usersonline"><span>users<wbr/>Online</span><a href="#usersonline" aria-label="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">usersOnline</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The number of users connected to the channel.</p>
|
|
19
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#usersonline">usersOnline</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L131">src/types/index.ts:131</a></li></ul></aside></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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><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="#connectionstatus" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connection<wbr/>Status</span></a><a href="#currentcall"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>current<wbr/>Call</span></a><a href="#ismuted" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Muted</span></a><a href="#name" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#options" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a><a href="#usersonline" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>users<wbr/>Online</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>
|
|
@@ -1,6 +1,6 @@
|
|
|
1
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>ZelloGroupConversation | @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/types.html">types</a></li><li><a href="" aria-current="page">ZelloGroupConversation</a></li></ul><h1>Class ZelloGroupConversation</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A ad-hoc group conversation in Zello. A <a href="#" class="tsd-kind-class">ZelloGroupConversation</a> is a type of <a href="types.ZelloChannel.html" class="tsd-kind-class">ZelloChannel</a>, but the provisioning is done by the end user instead of through the Zello Work Administrative Console.</p>
|
|
2
2
|
<p><a href="#" class="tsd-kind-class">ZelloGroupConversation</a>s are only possible when <a href="../types/types.ZelloConsoleSettings.html#allowgroupconversations" class="tsd-kind-property">ZelloConsoleSettings.allowGroupConversations</a> is true.</p>
|
|
3
|
-
</div
|
|
3
|
+
</div></section><section class="tsd-panel tsd-hierarchy" data-refl="273"><h4>Hierarchy (<a href="../hierarchy.html#types.ZelloGroupConversation">View Summary</a>)</h4><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><a href="types.ZelloChannel.html" class="tsd-signature-type tsd-kind-class">ZelloChannel</a><ul class="tsd-hierarchy"><li class="tsd-hierarchy-item"><span class="tsd-hierarchy-target">ZelloGroupConversation</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/types/index.ts#L210">src/types/index.ts:210</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">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
4
4
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#connectionstatus" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connection<wbr/>Status</span></a>
|
|
5
5
|
<a href="#displayname" 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>display<wbr/>Name</span></a>
|
|
6
6
|
<a href="#ismuted" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Muted</span></a>
|
|
@@ -10,15 +10,15 @@
|
|
|
10
10
|
<a href="#type" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
|
|
11
11
|
<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>
|
|
12
12
|
<a href="#usersonline" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>users<wbr/>Online</span></a>
|
|
13
|
-
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzellogroupconversation"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZelloGroupConversation</span><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-kind-parameter">isMuted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">connectionStatus</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloChannelConnectionStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelConnectionStatus</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">usersOnline</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloChannelOptions.html" class="tsd-signature-type tsd-kind-type-alias">ZelloChannelOptions</a><span class="tsd-signature-symbol">,</span><br/> <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><br/> <span class="tsd-kind-parameter">users</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">onlineUsers</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</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> <a href="" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a><a href="#constructorzellogroupconversation" aria-label="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-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></li><li><span><span class="tsd-kind-parameter">isMuted</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">connectionStatus</span>: <a href="../enums/types.ZelloChannelConnectionStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelConnectionStatus</a></span></li><li><span><span class="tsd-kind-parameter">usersOnline</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/types.ZelloChannelOptions.html" class="tsd-signature-type tsd-kind-type-alias">ZelloChannelOptions</a></span></li><li><span><span class="tsd-kind-parameter">displayName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">users</span>: <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">onlineUsers</span>: <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a></h4><aside class="tsd-sources"><p>Overrides <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/
|
|
14
|
-
</div><
|
|
15
|
-
</div><
|
|
13
|
+
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzellogroupconversation"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZelloGroupConversation</span><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-kind-parameter">isMuted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">connectionStatus</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloChannelConnectionStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelConnectionStatus</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">usersOnline</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloChannelOptions.html" class="tsd-signature-type tsd-kind-type-alias">ZelloChannelOptions</a><span class="tsd-signature-symbol">,</span><br/> <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><br/> <span class="tsd-kind-parameter">users</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">onlineUsers</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</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> <a href="" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a><a href="#constructorzellogroupconversation" aria-label="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-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></li><li><span><span class="tsd-kind-parameter">isMuted</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">connectionStatus</span>: <a href="../enums/types.ZelloChannelConnectionStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelConnectionStatus</a></span></li><li><span><span class="tsd-kind-parameter">usersOnline</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">options</span>: <a href="../types/types.ZelloChannelOptions.html" class="tsd-signature-type tsd-kind-type-alias">ZelloChannelOptions</a></span></li><li><span><span class="tsd-kind-parameter">displayName</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">users</span>: <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a><span class="tsd-signature-symbol">[]</span></span></li><li><span><span class="tsd-kind-parameter">onlineUsers</span>: <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a><span class="tsd-signature-symbol">[]</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZelloGroupConversation</a></h4><aside class="tsd-sources"><p>Overrides <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#constructor">constructor</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L224">src/types/index.ts:224</a></li></ul></aside></div></li></ul></section></section></details><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 tsd-is-inherited"><h3 class="tsd-anchor-link" id="connectionstatus"><span>connection<wbr/>Status</span><a href="#connectionstatus" aria-label="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">connectionStatus</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloChannelConnectionStatus.html" class="tsd-signature-type tsd-kind-enum">ZelloChannelConnectionStatus</a></div><div class="tsd-comment tsd-typography"><p>The connection status of the channel. Connecting to a channel is asynchronous.</p>
|
|
14
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#connectionstatus">connectionStatus</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L127">src/types/index.ts:127</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="displayname"><code class="tsd-tag">Readonly</code><span>display<wbr/>Name</span><a href="#displayname" aria-label="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">displayName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The display name of the group conversation. This should be used in the UI instead of <a href="types.ZelloChannel.html#name" class="tsd-kind-property">ZelloChannel#name</a>, as the <a href="types.ZelloChannel.html#name" class="tsd-kind-property">ZelloChannel#name</a> will be a uniquely hashed value starting with c##.</p>
|
|
15
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L214">src/types/index.ts:214</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="ismuted"><span>is<wbr/>Muted</span><a href="#ismuted" aria-label="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">isMuted</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the contact is muted.
|
|
16
16
|
When a contact is muted, messages from the contact will not play live, but they will still be in the history.</p>
|
|
17
|
-
</div><
|
|
17
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#ismuted">isMuted</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L123">src/types/index.ts:123</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="name"><span>name</span><a href="#name" aria-label="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">name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The name of the contact. Names are unique within their type.
|
|
18
18
|
When comparing names, it is recommended to do so in a case-insensitive manner.</p>
|
|
19
|
-
</div><
|
|
20
|
-
</div><
|
|
21
|
-
</div><
|
|
22
|
-
</div><
|
|
23
|
-
</div><
|
|
24
|
-
</div><
|
|
19
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#name">name</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L121">src/types/index.ts:121</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="onlineusers"><code class="tsd-tag">Readonly</code><span>online<wbr/>Users</span><a href="#onlineusers" aria-label="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">onlineUsers</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The users in the group conversation that are currently online.</p>
|
|
20
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L222">src/types/index.ts:222</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="options"><span>options</span><a href="#options" aria-label="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">options</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloChannelOptions.html" class="tsd-signature-type tsd-kind-type-alias">ZelloChannelOptions</a></div><div class="tsd-comment tsd-typography"><p>The options of the channel.</p>
|
|
21
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#options">options</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L135">src/types/index.ts:135</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" aria-label="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">type</span><span class="tsd-signature-symbol">:</span> <a href="../enums/types.ZelloContactType.html" class="tsd-signature-type tsd-kind-enum">ZelloContactType</a></div><div class="tsd-comment tsd-typography"><p>The type of contact.</p>
|
|
22
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#type">type</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L122">src/types/index.ts:122</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="users"><code class="tsd-tag">Readonly</code><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.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>The users in the group conversation.</p>
|
|
23
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L218">src/types/index.ts:218</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-is-inherited"><h3 class="tsd-anchor-link" id="usersonline"><span>users<wbr/>Online</span><a href="#usersonline" aria-label="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">usersOnline</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The number of users connected to the channel.</p>
|
|
24
|
+
</div><aside class="tsd-sources"><p>Inherited from <a href="types.ZelloChannel.html">ZelloChannel</a>.<a href="types.ZelloChannel.html#usersonline">usersOnline</a></p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L131">src/types/index.ts:131</a></li></ul></aside></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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><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="#connectionstatus" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>connection<wbr/>Status</span></a><a href="#displayname"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>display<wbr/>Name</span></a><a href="#ismuted" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>is<wbr/>Muted</span></a><a href="#name" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>name</span></a><a href="#onlineusers"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>online<wbr/>Users</span></a><a href="#options" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>options</span></a><a href="#type" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</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><a href="#usersonline" class="tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>users<wbr/>Online</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>
|
|
@@ -1,17 +1,17 @@
|
|
|
1
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>ZelloHistoryAlertMessage | @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/types.html">types</a></li><li><a href="" aria-current="page">ZelloHistoryAlertMessage</a></li></ul><h1>Class ZelloHistoryAlertMessage</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>A Zello history alert message.</p>
|
|
2
|
-
</div
|
|
2
|
+
</div></section><section class="tsd-panel"><h4>Implements</h4><ul class="tsd-hierarchy"><li><a href="../types/types.ZelloHistoryMessage.html" class="tsd-signature-type tsd-kind-type-alias">ZelloHistoryMessage</a></li></ul></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L800">src/types/index.ts:800</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">Constructors</h3><div class="tsd-index-list"><a href="#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
|
|
3
3
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="#channeluser" 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>channel<wbr/>User</span></a>
|
|
4
4
|
<a href="#contact" 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>contact</span></a>
|
|
5
5
|
<a href="#historyid" 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/>Id</span></a>
|
|
6
6
|
<a href="#incoming" 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</span></a>
|
|
7
7
|
<a href="#text" 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>text</span></a>
|
|
8
8
|
<a href="#timestamp" 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>timestamp</span></a>
|
|
9
|
-
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzellohistoryalertmessage"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZelloHistoryAlertMessage</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">channelUser</span><span class="tsd-signature-symbol">:</span> <
|
|
9
|
+
</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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Constructors</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link" id="constructorzellohistoryalertmessage"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">ZelloHistoryAlertMessage</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">channelUser</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">timestamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">historyId</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">incoming</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><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-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">ZelloHistoryAlertMessage</a><a href="#constructorzellohistoryalertmessage" aria-label="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-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></li><li><span><span class="tsd-kind-parameter">channelUser</span>: <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></span></li><li><span><span class="tsd-kind-parameter">timestamp</span>: <span class="tsd-signature-type">number</span></span></li><li><span><span class="tsd-kind-parameter">historyId</span>: <span class="tsd-signature-type">string</span></span></li><li><span><span class="tsd-kind-parameter">incoming</span>: <span class="tsd-signature-type">boolean</span></span></li><li><span><span class="tsd-kind-parameter">text</span>: <span class="tsd-signature-type">string</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">ZelloHistoryAlertMessage</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L811">src/types/index.ts:811</a></li></ul></aside></div></li></ul></section></section></details><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="channeluser"><span>channel<wbr/>User</span><a href="#channeluser" aria-label="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">channelUser</span><span class="tsd-signature-symbol">:</span> <a href="types.ZelloChannelUser.html" class="tsd-signature-type tsd-kind-class">ZelloChannelUser</a> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></div><div class="tsd-comment tsd-typography"><p>If incoming, the author that sent the message, if the message was sent in a channel.
|
|
10
10
|
If outgoing, undefined.</p>
|
|
11
|
-
</div><
|
|
12
|
-
</div><
|
|
11
|
+
</div><aside class="tsd-sources"><p>Implementation of ZelloHistoryMessage.channelUser</p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L802">src/types/index.ts:802</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="contact"><span>contact</span><a href="#contact" aria-label="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">contact</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ZelloContact.html" class="tsd-signature-type tsd-kind-type-alias">ZelloContact</a></div><div class="tsd-comment tsd-typography"><p>The contact that sent or received the message.</p>
|
|
12
|
+
</div><aside class="tsd-sources"><p>Implementation of ZelloHistoryMessage.contact</p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L801">src/types/index.ts:801</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="historyid"><span>history<wbr/>Id</span><a href="#historyid" aria-label="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">historyId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The unique identifier of the message. This can be used to lookup messages in the history.
|
|
13
13
|
This identifier persists across sessions.</p>
|
|
14
|
-
</div><
|
|
15
|
-
</div><
|
|
16
|
-
</div><
|
|
17
|
-
</div><
|
|
14
|
+
</div><aside class="tsd-sources"><p>Implementation of ZelloHistoryMessage.historyId</p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L804">src/types/index.ts:804</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="incoming"><span>incoming</span><a href="#incoming" aria-label="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">incoming</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether the message was received or sent.</p>
|
|
15
|
+
</div><aside class="tsd-sources"><p>Implementation of ZelloHistoryMessage.incoming</p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L805">src/types/index.ts:805</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="text"><span>text</span><a href="#text" aria-label="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">text</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><div class="tsd-comment tsd-typography"><p>The text body of the message.</p>
|
|
16
|
+
</div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L809">src/types/index.ts:809</a></li></ul></aside></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="timestamp"><span>timestamp</span><a href="#timestamp" aria-label="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">timestamp</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div><div class="tsd-comment tsd-typography"><p>The timestamp of the message.</p>
|
|
17
|
+
</div><aside class="tsd-sources"><p>Implementation of ZelloHistoryMessage.timestamp</p><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/404e3f047b3646c631afcdd844a9ad7010732747/src/types/index.ts#L803">src/types/index.ts:803</a></li></ul></aside></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-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><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="#channeluser"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>channel<wbr/>User</span></a><a href="#contact"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>contact</span></a><a href="#historyid"><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/>Id</span></a><a href="#incoming"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>incoming</span></a><a href="#text"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>text</span></a><a href="#timestamp"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>timestamp</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>
|