@zelloptt/react-native-zello-sdk 0.4.0 → 1.0.1

package/src/types/index.ts

@@ -26,6 +26,8 @@ export type ZelloContact = {
 export enum ZelloContactType {
   User = 'user',
   Channel = 'channel',
+  DispatchChannel = 'dispatchChannel',
+  GroupConversation = 'groupConversation',
 }
 
 /**
@@ -73,6 +75,10 @@ export class ZelloUser implements ZelloContact {
    * This can be used for displaying a smaller version of the profile picture (such as in a list).
    */
   public profilePictureThumbnailUrl: string | undefined;
+  /**
+   * The supported features of the user.
+   */
+  public supportedFeatures: ZelloUserSupportedFeatures;
 
   constructor(
     name: string,
@@ -80,7 +86,8 @@ export class ZelloUser implements ZelloContact {
     isMuted: boolean,
     status: ZelloUserStatus,
     profilePictureUrl: string | undefined,
-    profilePictureThumbnailUrl: string | undefined
+    profilePictureThumbnailUrl: string | undefined,
+    supportedFeatures: ZelloUserSupportedFeatures
   ) {
     this.name = name;
     this.type = ZelloContactType.User;
@@ -89,6 +96,21 @@ export class ZelloUser implements ZelloContact {
     this.status = status;
     this.profilePictureUrl = profilePictureUrl;
     this.profilePictureThumbnailUrl = profilePictureThumbnailUrl;
+    this.supportedFeatures = supportedFeatures;
+  }
+}
+
+/**
+ * The supported features of a {@link ZelloUser}.
+ */
+export class ZelloUserSupportedFeatures {
+  /**
+   * Whether the user supports group conversations.
+   */
+  public readonly groupConversations: boolean;
+
+  constructor(groupConversations: boolean) {
+    this.groupConversations = groupConversations;
   }
 }
 
@@ -146,6 +168,7 @@ export class ZelloDispatchChannel extends ZelloChannel {
     currentCall: ZelloDispatchCall | undefined
   ) {
     super(name, isMuted, connectionStatus, usersOnline, options);
+    this.type = ZelloContactType.DispatchChannel;
     this.currentCall = currentCall;
   }
 }
@@ -179,6 +202,43 @@ export enum ZelloDispatchCallStatus {
   Disconnected = 'disconnected',
 }
 
+/**
+ * A ad-hoc group conversation in Zello. A {@link ZelloGroupConversation} is a type of {@link ZelloChannel}, but the provisioning is done by the end user instead of through the Zello Work Administrative Console.
+ *
+ * {@link ZelloGroupConversation}s are only possible when {@link ZelloConsoleSettings.allowGroupConversations} is true.
+ */
+export class ZelloGroupConversation extends ZelloChannel {
+  /**
+   * The display name of the group conversation. This should be used in the UI instead of {@link ZelloChannel#name}, as the {@link ZelloChannel#name} will be a uniquely hashed value starting with c##.
+   */
+  public readonly displayName: string;
+  /**
+   * The users in the group conversation.
+   */
+  public readonly users: ZelloChannelUser[];
+  /**
+   * The users in the group conversation that are currently online.
+   */
+  public readonly onlineUsers: ZelloChannelUser[];
+
+  constructor(
+    name: string,
+    isMuted: boolean,
+    connectionStatus: ZelloChannelConnectionStatus,
+    usersOnline: number,
+    options: ZelloChannelOptions,
+    displayName: string,
+    users: ZelloChannelUser[],
+    onlineUsers: ZelloChannelUser[]
+  ) {
+    super(name, isMuted, connectionStatus, usersOnline, options);
+    this.type = ZelloContactType.GroupConversation;
+    this.displayName = displayName;
+    this.users = users;
+    this.onlineUsers = onlineUsers;
+  }
+}
+
 /**
  * The connection status of a {@link ZelloChannel}.
  */
@@ -211,7 +271,7 @@ export type ZelloChannelOptions = {
    * Whether the user is allowed to send alert messages to the channel.
    * When this is true, you should not show any UI to allow the user to send alert messages to the channel.
    */
-  allowAlerts: boolean;
+  allowAlertMessages: boolean;
   /**
    * Whether the user is allowed to send text messages to the channel.
    * When this is true, you should not show any UI to allow the user to send text messages to the channel.
@@ -221,17 +281,19 @@ export type ZelloChannelOptions = {
    * Whether the user is allowed to send location messages to the channel.
    * When this is true, you should not show any UI to allow the user to send location messages to the channel.
    */
-  allowLocations: boolean;
+  allowLocationMessages: boolean;
 };
 
 /**
- * A user in a {@link ZelloChannel}. A {@link ZelloChannelUser} may or may not not be part of your contact list.
+ * A user in a {@link ZelloChannel}. A {@link ZelloChannelUser} may or may not be part of your contact list.
  */
 export class ZelloChannelUser {
   public name: string;
+  public displayName: string;
 
-  constructor(name: string) {
+  constructor(name: string, displayName: string) {
     this.name = name;
+    this.displayName = displayName;
   }
 }
 
@@ -875,13 +937,29 @@ export type ZelloConfig = {
 /**
  * Settings for the network. These are configured via the Zello Work Administrative Console.
  */
-export class ZelloConsoleSettings {
+export type ZelloConsoleSettings = {
   /**
    * Allow non-dispatchers to end calls. When this is false, you should not show any UI to allow non-dispatchers to end calls.
    */
-  public readonly allowNonDispatchersToEndCalls: boolean;
-
-  constructor(allowNonDispatchersToEndCalls: boolean) {
-    this.allowNonDispatchersToEndCalls = allowNonDispatchersToEndCalls;
-  }
-}
+  allowNonDispatchersToEndCalls: boolean;
+  /**
+   * Allow image messages. When this is false, you should not show any UI to allow users to send image messages.
+   */
+  allowImageMessages: boolean;
+  /**
+   * Allow alert messages. When this is false, you should not show any UI to allow users to send alert messages.
+   */
+  allowAlertMessages: boolean;
+  /**
+   * Allow location messages. When this is false, you should not show any UI to allow users to send location messages.
+   */
+  allowLocationMessages: boolean;
+  /**
+   * Allow text messages. When this is false, you should not show any UI to allow users to send text messages.
+   */
+  allowTextMessages: boolean;
+  /**
+   * Allow group conversations. When this is false, you should not show any UI to allow users to create group conversations.
+   */
+  allowGroupConversations: boolean;
+};

package/src/utils/index.ts

@@ -1,12 +1,14 @@
 import {
   ZelloChannel,
   ZelloChannelConnectionStatus,
+  ZelloChannelOptions,
   ZelloChannelUser,
   ZelloConsoleSettings,
   ZelloContact,
   ZelloDispatchCall,
   ZelloDispatchCallStatus,
   ZelloDispatchChannel,
+  ZelloGroupConversation,
   ZelloHistoryAlertMessage,
   ZelloHistoryImageMessage,
   ZelloHistoryLocationMessage,
@@ -16,6 +18,7 @@ import {
   ZelloIncomingEmergency,
   ZelloUser,
   ZelloUserStatus,
+  ZelloUserSupportedFeatures,
 } from '../types';
 import { Platform } from 'react-native';
 
@@ -39,7 +42,21 @@ export function bridgeContactToSdkContact(
           ? ZelloChannelConnectionStatus.Connecting
           : ZelloChannelConnectionStatus.Disconnected;
       const usersOnline = eventContact.usersOnline;
-      const options = eventContact.options;
+      const eventOptions = eventContact.options;
+      let options: ZelloChannelOptions | undefined;
+      if (eventOptions) {
+        options = {
+          noDisconnect: eventOptions.noDisconnect,
+          hidePowerButton: eventOptions.hidePowerButton,
+          listenOnly: eventOptions.listenOnly,
+          allowAlertMessages: eventOptions.allowAlerts,
+          allowLocationMessages: eventOptions.allowLocations,
+          allowTextMessages: eventOptions.allowTextMessages,
+        };
+      }
+      if (!options) {
+        return undefined;
+      }
       if (eventContact.isDispatchChannel) {
         let call: ZelloDispatchCall | undefined;
         if (eventContact.currentCall) {
@@ -60,6 +77,21 @@ export function bridgeContactToSdkContact(
           options,
           call
         );
+      } else if (eventContact.isGroupConversation) {
+        contact = new ZelloGroupConversation(
+          contactName,
+          isMuted,
+          connectionStatus,
+          usersOnline,
+          options,
+          eventContact.displayName,
+          eventContact.users.map((user: any) =>
+            bridgeChannelUserToSdkChannelUser(user)
+          ),
+          eventContact.onlineUsers.map((user: any) =>
+            bridgeChannelUserToSdkChannelUser(user)
+          )
+        );
       } else {
         contact = new ZelloChannel(
           contactName,
@@ -81,7 +113,10 @@ export function bridgeContactToSdkContact(
         eventContact.isMuted,
         userStatus,
         eventContact.profilePictureUrl,
-        eventContact.profilePictureThumbnailUrl
+        eventContact.profilePictureThumbnailUrl,
+        new ZelloUserSupportedFeatures(
+          eventContact.supportedFeatures.groupConversations
+        )
       );
     }
   }
@@ -92,12 +127,13 @@ export function bridgeIncomingEmergencyToSdkIncomingEmergency(
   emergency: any
 ): ZelloIncomingEmergency | undefined {
   const channel = bridgeContactToSdkContact(emergency.channel) as ZelloChannel;
-  if (!channel) {
+  const channelUser = bridgeChannelUserToSdkChannelUser(emergency.channelUser);
+  if (!channel || !channelUser) {
     return undefined;
   }
   return new ZelloIncomingEmergency(
     channel,
-    new ZelloChannelUser(emergency.channelUserName),
+    channelUser,
     emergency.emergencyId,
     parseInt(emergency.startTimestamp, 10),
     parseInt(emergency.endTimestamp, 10)
@@ -115,9 +151,7 @@ export function bridgeHistoryMessageToSdkHistoryMessage(
     case 'voice':
       return new ZelloHistoryVoiceMessage(
         contact,
-        message.channelUserName
-          ? new ZelloChannelUser(message.channelUserName)
-          : undefined,
+        bridgeChannelUserToSdkChannelUser(message.channelUser),
         parseInt(message.timestamp, 10),
         message.historyId,
         message.incoming,
@@ -126,9 +160,7 @@ export function bridgeHistoryMessageToSdkHistoryMessage(
     case 'image':
       return new ZelloHistoryImageMessage(
         contact,
-        message.channelUserName
-          ? new ZelloChannelUser(message.channelUserName)
-          : undefined,
+        bridgeChannelUserToSdkChannelUser(message.channelUser),
         parseInt(message.timestamp, 10),
         message.historyId,
         message.incoming
@@ -136,9 +168,7 @@ export function bridgeHistoryMessageToSdkHistoryMessage(
     case 'location':
       return new ZelloHistoryLocationMessage(
         contact,
-        message.channelUserName
-          ? new ZelloChannelUser(message.channelUserName)
-          : undefined,
+        bridgeChannelUserToSdkChannelUser(message.channelUser),
         parseInt(message.timestamp, 10),
         message.historyId,
         message.incoming,
@@ -150,9 +180,7 @@ export function bridgeHistoryMessageToSdkHistoryMessage(
     case 'text':
       return new ZelloHistoryTextMessage(
         contact,
-        message.channelUserName
-          ? new ZelloChannelUser(message.channelUserName)
-          : undefined,
+        bridgeChannelUserToSdkChannelUser(message.channelUser),
         parseInt(message.timestamp, 10),
         message.historyId,
         message.incoming,
@@ -161,9 +189,7 @@ export function bridgeHistoryMessageToSdkHistoryMessage(
     case 'alert':
       return new ZelloHistoryAlertMessage(
         contact,
-        message.channelUserName
-          ? new ZelloChannelUser(message.channelUserName)
-          : undefined,
+        bridgeChannelUserToSdkChannelUser(message.channelUser),
         parseInt(message.timestamp, 10),
         message.historyId,
         message.incoming,
@@ -191,5 +217,24 @@ export function bridgeConsoleSettingsToSdkConsoleSettings(
   if (!settings) {
     return undefined;
   }
-  return new ZelloConsoleSettings(settings.allowNonDispatchersToEndCalls);
+  return {
+    allowNonDispatchersToEndCalls: settings.allowNonDispatchersToEndCalls,
+    allowImageMessages: settings.allowImageMessages,
+    allowLocationMessages: settings.allowLocationMessages,
+    allowTextMessages: settings.allowTextMessages,
+    allowAlertMessages: settings.allowAlertMessages,
+    allowGroupConversations: settings.allowGroupConversations,
+  };
+}
+
+export function bridgeChannelUserToSdkChannelUser(
+  channelUser: any
+): ZelloChannelUser | undefined {
+  if (!channelUser?.name) {
+    return undefined;
+  }
+  return new ZelloChannelUser(
+    channelUser.name,
+    channelUser.displayName ?? channelUser.name
+  );
 }

package/lib/commonjs/docs/classes/types.ZelloConsoleSettings.html

@@ -1,5 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZelloConsoleSettings | @zelloptt/react-native-zello-sdk</title><meta name="description" content="Documentation for @zelloptt/react-native-zello-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@zelloptt/react-native-zello-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@zelloptt/react-native-zello-sdk</a></li><li><a href="../modules/types.html">types</a></li><li><a href="types.ZelloConsoleSettings.html">ZelloConsoleSettings</a></li></ul><h1>Class ZelloConsoleSettings</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Settings for the network. These are configured via the Zello Work Administrative Console.</p>
-</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/68ceb919b83b2ca14f8c1bb7bc5f3f7eb87a5cf9/src/types/index.ts#L878">src/types/index.ts:878</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.ZelloConsoleSettings.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
-</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.ZelloConsoleSettings.html#allowNonDispatchersToEndCalls" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Non<wbr/>Dispatchers<wbr/>To<wbr/>End<wbr/>Calls</span></a>
-</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"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ZelloConsoleSettings" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Zello<wbr/>Console<wbr/>Settings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">allowNonDispatchersToEndCalls</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="types.ZelloConsoleSettings.html" class="tsd-signature-type tsd-kind-class">ZelloConsoleSettings</a><a href="#constructor.new_ZelloConsoleSettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">allowNonDispatchersToEndCalls</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.ZelloConsoleSettings.html" class="tsd-signature-type tsd-kind-class">ZelloConsoleSettings</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/68ceb919b83b2ca14f8c1bb7bc5f3f7eb87a5cf9/src/types/index.ts#L884">src/types/index.ts:884</a></li></ul></aside></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"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="allowNonDispatchersToEndCalls" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>allow<wbr/>Non<wbr/>Dispatchers<wbr/>To<wbr/>End<wbr/>Calls</span><a href="#allowNonDispatchersToEndCalls" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">allow<wbr/>Non<wbr/>Dispatchers<wbr/>To<wbr/>End<wbr/>Calls</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Allow non-dispatchers to end calls. When this is false, you should not show any UI to allow non-dispatchers to end calls.</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/68ceb919b83b2ca14f8c1bb7bc5f3f7eb87a5cf9/src/types/index.ts#L882">src/types/index.ts:882</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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#allowNonDispatchersToEndCalls" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Non<wbr/>Dispatchers<wbr/>To<wbr/>End<wbr/>Calls</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@zelloptt/react-native-zello-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>

package/lib/module/docs/classes/types.ZelloConsoleSettings.html

@@ -1,5 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZelloConsoleSettings | @zelloptt/react-native-zello-sdk</title><meta name="description" content="Documentation for @zelloptt/react-native-zello-sdk"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">@zelloptt/react-native-zello-sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../index.html">@zelloptt/react-native-zello-sdk</a></li><li><a href="../modules/types.html">types</a></li><li><a href="types.ZelloConsoleSettings.html">ZelloConsoleSettings</a></li></ul><h1>Class ZelloConsoleSettings</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Settings for the network. These are configured via the Zello Work Administrative Console.</p>
-</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/68ceb919b83b2ca14f8c1bb7bc5f3f7eb87a5cf9/src/types/index.ts#L878">src/types/index.ts:878</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Constructors</h3><div class="tsd-index-list"><a href="types.ZelloConsoleSettings.html#constructor" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a>
-</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="types.ZelloConsoleSettings.html#allowNonDispatchersToEndCalls" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Non<wbr/>Dispatchers<wbr/>To<wbr/>End<wbr/>Calls</span></a>
-</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"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Constructors</h2></summary><section><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_ZelloConsoleSettings" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Zello<wbr/>Console<wbr/>Settings</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">allowNonDispatchersToEndCalls</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="types.ZelloConsoleSettings.html" class="tsd-signature-type tsd-kind-class">ZelloConsoleSettings</a><a href="#constructor.new_ZelloConsoleSettings" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">allowNonDispatchersToEndCalls</span>: <span class="tsd-signature-type">boolean</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <a href="types.ZelloConsoleSettings.html" class="tsd-signature-type tsd-kind-class">ZelloConsoleSettings</a></h4><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/68ceb919b83b2ca14f8c1bb7bc5f3f7eb87a5cf9/src/types/index.ts#L884">src/types/index.ts:884</a></li></ul></aside></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"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Properties</h2></summary><section><section class="tsd-panel tsd-member"><a id="allowNonDispatchersToEndCalls" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag">Readonly</code><span>allow<wbr/>Non<wbr/>Dispatchers<wbr/>To<wbr/>End<wbr/>Calls</span><a href="#allowNonDispatchersToEndCalls" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">allow<wbr/>Non<wbr/>Dispatchers<wbr/>To<wbr/>End<wbr/>Calls</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Allow non-dispatchers to end calls. When this is false, you should not show any UI to allow non-dispatchers to end calls.</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/zelloptt/react-native-zello-sdk/blob/68ceb919b83b2ca14f8c1bb7bc5f3f7eb87a5cf9/src/types/index.ts#L882">src/types/index.ts:882</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"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary><div><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="tsd-otp-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary><div><a href="#allowNonDispatchersToEndCalls" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>allow<wbr/>Non<wbr/>Dispatchers<wbr/>To<wbr/>End<wbr/>Calls</span></a></div></details></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../index.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>@zelloptt/react-native-zello-sdk</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>