@zelloptt/react-native-zello-sdk 2.0.0 → 3.0.0

package/lib/module/events/index.js

@@ -1,49 +1,266 @@
 "use strict";
 
 export let ZelloEvent = /*#__PURE__*/function (ZelloEvent) {
+  /**
+   * The connection to the Zello Work network has failed.
+   * {@link sdk.Zello.state | Zello.state} will be {@link types.ZelloConnectionState.Disconnected | ZelloConnectionState.Disconnected}.
+   * @param {@link types.ZelloConnectionState | ZelloConnectionState} state The current state of the connection.
+   * @param {@link types.ZelloConnectionError | ZelloConnectionError} error The error that caused the connection to fail.
+   */
   ZelloEvent["CONNECT_FAILED"] = "onConnectFailed";
+  /**
+   * The connection to the Zello Work network has started.
+   * {@link sdk.Zello.state | Zello.state} will be {@link types.ZelloConnectionState.Connecting | ZelloConnectionState.Connecting}.
+   * @param {@link types.ZelloConnectionState | ZelloConnectionState} state The current state of the connection.
+   * */
   ZelloEvent["CONNECT_STARTED"] = "onConnectStarted";
+  /**
+   * The connection to the Zello Work network has succeeded.
+   * {@link sdk.Zello.state | Zello.state} will be {@link types.ZelloConnectionState.Connected | ZelloConnectionState.Connected}.
+   * @param {@link types.ZelloConnectionState | ZelloConnectionState} state The current state of the connection.
+   * */
   ZelloEvent["CONNECT_SUCCEEDED"] = "onConnectSucceeded";
+  /**
+   * The connection to the Zello Work network has been disconnected.
+   * {@link sdk.Zello.state | Zello.state} will be {@link types.ZelloConnectionState.Disconnected | ZelloConnectionState.Disconnected}.
+   * @param {@link types.ZelloConnectionState | ZelloConnectionState} state The current state of the connection.
+   */
   ZelloEvent["DISCONNECTED"] = "onDisconnected";
+  /**
+   * The connection to the Zello Work network is attempting to reconnect.
+   * {@link sdk.Zello.state | Zello.state} will be {@link types.ZelloConnectionState.Reconnecting | ZelloConnectionState.Reconnecting}.
+   * @param {@link types.ZelloConnectionState | ZelloConnectionState} state The current state of the connection.
+   */
   ZelloEvent["RECONNECTING"] = "onWillReconnect";
+  /**
+   * The contact list has been updated.
+   * {@link sdk.Zello.users | Zello.users} and {@link sdk.Zello.channels | Zello.channels} will be updated.
+   * @param {@link types.ZelloUser | ZelloUser[]} users The list of users.
+   * @param {@link types.ZelloChannel | ZelloChannel[]} channels The list of channels.
+   * @param {@link types.ZelloGroupConversation | ZelloGroupConversation[]} groupConversations The list of group conversations.
+   */
   ZelloEvent["CONTACT_LIST_UPDATED"] = "onContactListUpdated";
+  /**
+   * The selected contact has changed.
+   * {@link sdk.Zello.selectedContact | Zello.selectedContact} will be updated.
+   * @param {@link types.ZelloContact | ZelloContact} contact The selected contact.
+   */
   ZelloEvent["SELECTED_CONTACT_CHANGED"] = "onSelectedContactChanged";
+  /**
+   * The account status has changed.
+   * {@link sdk.Zello.accountStatus | Zello.accountStatus} will be updated.
+   * @param {@link types.ZelloAccountStatus | ZelloAccountStatus} status The current account status.
+   */
   ZelloEvent["ACCOUNT_STATUS_CHANGED"] = "onAccountStatusChanged";
+  /**
+   * An incoming voice message has started.
+   * {@link sdk.Zello.incomingVoiceMessage | Zello.incomingVoiceMessage} will be updated.
+   * @param {@link types.ZelloIncomingVoiceMessage | ZelloIncomingVoiceMessage} voiceMessage The incoming voice message.
+   */
   ZelloEvent["INCOMING_VOICE_MESSAGE_STARTED"] = "onIncomingVoiceMessageStarted";
+  /**
+   * An incoming voice message has stopped.
+   * {@link sdk.Zello.incomingVoiceMessage | Zello.incomingVoiceMessage} will be set to undefined.
+   * @param {@link types.ZelloIncomingVoiceMessage | ZelloIncomingVoiceMessage} voiceMessage The incoming voice message.
+   */
   ZelloEvent["INCOMING_VOICE_MESSAGE_STOPPED"] = "onIncomingVoiceMessageStopped";
+  /**
+   * An outgoing voice message is connecting.
+   * {@link sdk.Zello.outgoingVoiceMessage | Zello.outgoingVoiceMessage} will be updated.
+   * @param {@link types.ZelloOutgoingVoiceMessage | ZelloOutgoingVoiceMessage} voiceMessage The outgoing voice message.
+   */
   ZelloEvent["OUTGOING_VOICE_MESSAGE_CONNECTING"] = "onOutgoingVoiceMessageConnecting";
+  /**
+   * An outgoing voice message has started.
+   * {@link sdk.Zello.outgoingVoiceMessage | Zello.outgoingVoiceMessage} will be updated.
+   * @param {@link types.ZelloOutgoingVoiceMessage | ZelloOutgoingVoiceMessage} voiceMessage The outgoing voice message.
+   */
   ZelloEvent["OUTGOING_VOICE_MESSAGE_STARTED"] = "onOutgoingVoiceMessageStarted";
+  /**
+   * An outgoing voice message has stopped.
+   * {@link sdk.Zello.outgoingVoiceMessage | Zello.outgoingVoiceMessage} will be set to undefined.
+   * @param {@link types.ZelloOutgoingVoiceMessage | ZelloOutgoingVoiceMessage} voiceMessage The outgoing voice message.
+   * @param {@link types.ZelloOutgoingVoiceMessageState} error Optional; An error that caused the outgoing voice message to stop.
+   */
   ZelloEvent["OUTGOING_VOICE_MESSAGE_STOPPED"] = "onOutgoingVoiceMessageStopped";
+  /**
+   * An incoming image message has been received.
+   * @param {@link types.ZelloImageMessage | ZelloImageMessage} imageMessage The incoming image message.
+   */
   ZelloEvent["INCOMING_IMAGE_MESSAGE_RECEIVED"] = "onIncomingImageMessage";
+  /**
+   * An outgoing image message has been sent.
+   * @param {@link types.ZelloImageMessage | ZelloImageMessage} imageMessage The outgoing image message.
+   */
   ZelloEvent["OUTGOING_IMAGE_MESSAGE_SENT"] = "onOutgoingImageMessageSent";
+  /**
+   * An outgoing image message has failed to send.
+   * @param {@link types.ZelloImageMessage | ZelloImageMessage} imageMessage The outgoing image message.
+   */
   ZelloEvent["OUTGOING_IMAGE_MESSAGE_SEND_FAILED"] = "onOutgoingImageMessageSendFailed";
+  /**
+   * An incoming alert message has been received.
+   * @param {@link types.ZelloAlertMessage | ZelloAlertMessage} alertMessage The incoming alert message.
+   */
   ZelloEvent["INCOMING_ALERT_MESSAGE_RECEIVED"] = "onIncomingAlertMessage";
+  /**
+   * An outgoing alert message has been sent.
+   * @param {@link types.ZelloAlertMessage | ZelloAlertMessage} alertMessage The outgoing alert message.
+   */
   ZelloEvent["OUTGOING_ALERT_MESSAGE_SENT"] = "onOutgoingAlertMessageSent";
+  /**
+   * An outgoing alert message has failed to send.
+   * @param {@link types.ZelloAlertMessage | ZelloAlertMessage} alertMessage The outgoing alert message.
+   */
   ZelloEvent["OUTGOING_ALERT_MESSAGE_SEND_FAILED"] = "onOutgoingAlertMessageSendFailed";
+  /**
+   * An incoming text message has been received.
+   * @param {@link types.ZelloTextMessage | ZelloTextMessage} textMessage The incoming text message.
+   */
   ZelloEvent["INCOMING_TEXT_MESSAGE_RECEIVED"] = "onIncomingTextMessage";
+  /**
+   * An outgoing text message has been sent.
+   * @param {@link types.ZelloTextMessage | ZelloTextMessage} textMessage The outgoing text message.
+   */
   ZelloEvent["OUTGOING_TEXT_MESSAGE_SENT"] = "onOutgoingTextMessageSent";
+  /**
+   * An outgoing text message has failed to send.
+   * @param {@link types.ZelloTextMessage | ZelloTextMessage} textMessage The outgoing text message.
+   */
   ZelloEvent["OUTGOING_TEXT_MESSAGE_SEND_FAILED"] = "onOutgoingTextMessageSendFailed";
+  /**
+   * An incoming location message has been received.
+   * @param {@link types.ZelloLocationMessage | ZelloLocationMessage} locationMessage The incoming location message.
+   */
   ZelloEvent["INCOMING_LOCATION_MESSAGE_RECEIVED"] = "onIncomingLocationMessage";
+  /**
+   * An outgoing location message has been sent.
+   * @param {@link types.ZelloLocationMessage | ZelloLocationMessage} locationMessage The outgoing location message.
+   */
   ZelloEvent["OUTGOING_LOCATION_MESSAGE_SENT"] = "onOutgoingLocationMessageSent";
+  /**
+   * An outgoing location message has failed to send.
+   * @param {@link types.ZelloLocationMessage | ZelloLocationMessage} locationMessage The outgoing location message.
+   */
   ZelloEvent["OUTGOING_LOCATION_MESSAGE_SEND_FAILED"] = "onOutgoingLocationMessageSendFailed";
+  /**
+   * An incoming emergency has started.
+   * {@link sdk.Zello.incomingEmergencies | Zello.incomingEmergencies} will be updated.
+   * @param {@link types.ZelloIncomingEmergency | ZelloIncomingEmergency} emergency The incoming emergency.
+   * @param {@link types.ZelloIncomingEmergency | ZelloIncomingEmergency[]} emergencies The list of incoming emergencies.
+   */
   ZelloEvent["INCOMING_EMERGENCY_STARTED"] = "onIncomingEmergencyStarted";
+  /**
+   * An incoming emergency has stopped.
+   * {@link sdk.Zello.incomingEmergencies | Zello.incomingEmergencies} will be updated.
+   * @param {@link types.ZelloIncomingEmergency | ZelloIncomingEmergency} emergency The stopped incoming emergency.
+   * @param {@link types.ZelloIncomingEmergency | ZelloIncomingEmergency[]} emergencies The list of incoming emergencies.
+   */
   ZelloEvent["INCOMING_EMERGENCY_STOPPED"] = "onIncomingEmergencyStopped";
+  /**
+   * An outgoing emergency has started.
+   * {@link sdk.Zello.outgoingEmergency | Zello.outgoingEmergency} will be updated.
+   * @param {@link types.ZelloOutgoingEmergency | ZelloOutgoingEmergency} emergency The outgoing emergency.
+   */
   ZelloEvent["OUTGOING_EMERGENCY_STARTED"] = "onOutgoingEmergencyStarted";
+  /**
+   * An outgoing emergency has stopped.
+   * {@link sdk.Zello.outgoingEmergency | Zello.outgoingEmergency} will be set to undefined.
+   * @param {@link types.ZelloOutgoingEmergency | ZelloOutgoingEmergency} emergency The stopped outgoing emergency.
+   */
   ZelloEvent["OUTGOING_EMERGENCY_STOPPED"] = "onOutgoingEmergencyStopped";
+  /**
+   * The list of recent entries has been updated.
+   * {@link sdk.Zello.recents | Zello.recents} will be updated.
+   * @param {@link types.ZelloRecentEntry | ZelloRecentEntry[]} recents The list of recent entries.
+   */
   ZelloEvent["RECENTS_UPDATED"] = "onRecentsUpdated";
+  /**
+   * The history has been updated.
+   */
   ZelloEvent["HISTORY_UPDATED"] = "onHistoryUpdated";
+  /**
+   * The history playback of a voice message has started.
+   * {@link sdk.Zello.historyVoiceMessage | Zello.historyVoiceMessage} will be updated.
+   * @param {@link types.ZelloHistoryVoiceMessage | ZelloHistoryVoiceMessage} voiceMessage The started history voice message.
+   */
   ZelloEvent["HISTORY_PLAYBACK_STARTED"] = "onHistoryPlaybackStarted";
+  /**
+   * The history playback of a voice message has stopped.
+   * {@link sdk.Zello.historyVoiceMessage | Zello.historyVoiceMessage} will be set to undefined.
+   * @param {@link types.ZelloHistoryVoiceMessage | ZelloHistoryVoiceMessage} voiceMessage The stopped history voice message.
+   */
   ZelloEvent["HISTORY_PLAYBACK_STOPPED"] = "onHistoryPlaybackStopped";
+  /**
+   * A successful transcription has been received for a voice history message.
+   *
+   * Transcriptions are produced asynchronously by the Zello server after a voice message has
+   * finished sending or receiving, so this event may arrive seconds or longer after the original
+   * voice message appears in the history.
+   * @param {@link types.ZelloHistoryVoiceMessage | ZelloHistoryVoiceMessage} voiceMessage The voice history message whose transcription was just received.
+   */
+  ZelloEvent["HISTORY_VOICE_MESSAGE_TRANSCRIPTION_AVAILABLE"] = "onHistoryVoiceMessageTranscriptionAvailable";
+  /**
+   * A dispatch call has been received by the server and is pending acceptance by a dispatcher.
+   * @param {@link types.ZelloDispatchCall | ZelloDispatchCall} call The pending dispatch call.
+   */
   ZelloEvent["DISPATCH_CALL_PENDING"] = "onDispatchCallPending";
+  /**
+   * A dispatch call has been accepted by a dispatcher.
+   * @param {@link types.ZelloDispatchCall | ZelloDispatchCall} call The accepted dispatch call.
+   */
   ZelloEvent["DISPATCH_CALL_ACTIVE"] = "onDispatchCallActive";
+  /**
+   * A dispatch call has been transferred to another dispatcher.
+   * @param {@link types.ZelloDispatchCall | ZelloDispatchCall} call The transferred dispatch call.
+   */
   ZelloEvent["DISPATCH_CALL_TRANSFERRED"] = "onDispatchCallTransferred";
+  /**
+   * A dispatch call has ended.
+   * @param {@link types.ZelloDispatchCall | ZelloDispatchCall} call The ended dispatch call.
+   */
   ZelloEvent["DISPATCH_CALL_ENDED"] = "onDispatchCallEnded";
+  /**
+   * The console settings have changed.
+   * {@link sdk.Zello.consoleSettings | Zello.consoleSettings} will contain the updated console settings.
+   * @param {@link types.ZelloConsoleSettings | ZelloConsoleSettings} settings The updated console settings.
+   */
   ZelloEvent["CONSOLE_SETTINGS_CHANGED"] = "onConsoleSettingsChanged";
+  /**
+   * A group conversation has been created.
+   * {@link sdk.Zello.groupConversations | Zello.groupConversations} will be updated.
+   * @param {@link types.ZelloGroupConversation | ZelloGroupConversation} groupConversation The created group conversation.
+   */
   ZelloEvent["GROUP_CONVERSATION_CREATED"] = "onGroupConversationCreated";
+  /**
+   * The user has been invited to a group conversation.
+   * {@link sdk.Zello.groupConversations | Zello.groupConversations} will be updated.
+   * @param {@link types.ZelloGroupConversation | ZelloGroupConversation} groupConversation The group conversation.
+   */
   ZelloEvent["GROUP_CONVERSATION_INVITE"] = "onGroupConversationInvite";
+  /**
+   * A group conversation has new users added.
+   * {@link sdk.Zello.groupConversations | Zello.groupConversations} will be updated.
+   * @param {@link types.ZelloGroupConversation | ZelloGroupConversation} groupConversation The group conversation.
+   */
   ZelloEvent["GROUP_CONVERSATION_USERS_ADDED"] = "onGroupConversationUsersAdded";
+  /**
+   * Users left a group conversation.
+   * {@link sdk.Zello.groupConversations | Zello.groupConversations} will be updated.
+   * @param {@link types.ZelloGroupConversation | ZelloGroupConversation} groupConversation The group conversation.
+   */
   ZelloEvent["GROUP_CONVERSATION_USERS_LEFT"] = "onGroupConversationUsersLeft";
+  /**
+   * The user has left a group conversation.
+   * {@link sdk.Zello.groupConversations | Zello.groupConversations} will be updated.
+   * @param {@link types.ZelloGroupConversation | ZelloGroupConversation} groupConversation The group conversation.
+   */
   ZelloEvent["GROUP_CONVERSATION_LEFT"] = "onGroupConversationLeft";
+  /**
+   * A group conversation has been renamed.
+   * {@link sdk.Zello.groupConversations | Zello.groupConversations} will be updated.
+   * @param {@link types.ZelloGroupConversation | ZelloGroupConversation} groupConversation The group conversation.
+   */
   ZelloEvent["GROUP_CONVERSATION_RENAMED"] = "onGroupConversationRenamed";
   return ZelloEvent;
 }({});

package/lib/module/events/index.js.map

@@ -1 +1 @@
-{"version":3,"names":["ZelloEvent"],"sourceRoot":"../../../src","sources":["events/index.ts"],"mappings":";;AAAA,WAAYA,UAAU,0BAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAVA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}
+{"version":3,"names":["ZelloEvent"],"sourceRoot":"../../../src","sources":["events/index.ts"],"mappings":";;AAAA,WAAYA,UAAU,0BAAVA,UAAU;EACpB;AACF;AACA;AACA;AACA;AACA;EANYA,UAAU;EAQpB;AACF;AACA;AACA;AACA;EAZYA,UAAU;EAcpB;AACF;AACA;AACA;AACA;EAlBYA,UAAU;EAoBpB;AACF;AACA;AACA;AACA;EAxBYA,UAAU;EA0BpB;AACF;AACA;AACA;AACA;EA9BYA,UAAU;EAgCpB;AACF;AACA;AACA;AACA;AACA;AACA;EAtCYA,UAAU;EAwCpB;AACF;AACA;AACA;AACA;EA5CYA,UAAU;EA8CpB;AACF;AACA;AACA;AACA;EAlDYA,UAAU;EAoDpB;AACF;AACA;AACA;AACA;EAxDYA,UAAU;EA0DpB;AACF;AACA;AACA;AACA;EA9DYA,UAAU;EAgEpB;AACF;AACA;AACA;AACA;EApEYA,UAAU;EAsEpB;AACF;AACA;AACA;AACA;EA1EYA,UAAU;EA4EpB;AACF;AACA;AACA;AACA;AACA;EAjFYA,UAAU;EAmFpB;AACF;AACA;AACA;EAtFYA,UAAU;EAwFpB;AACF;AACA;AACA;EA3FYA,UAAU;EA6FpB;AACF;AACA;AACA;EAhGYA,UAAU;EAkGpB;AACF;AACA;AACA;EArGYA,UAAU;EAuGpB;AACF;AACA;AACA;EA1GYA,UAAU;EA4GpB;AACF;AACA;AACA;EA/GYA,UAAU;EAiHpB;AACF;AACA;AACA;EApHYA,UAAU;EAsHpB;AACF;AACA;AACA;EAzHYA,UAAU;EA2HpB;AACF;AACA;AACA;EA9HYA,UAAU;EAgIpB;AACF;AACA;AACA;EAnIYA,UAAU;EAqIpB;AACF;AACA;AACA;EAxIYA,UAAU;EA0IpB;AACF;AACA;AACA;EA7IYA,UAAU;EA+IpB;AACF;AACA;AACA;AACA;AACA;EApJYA,UAAU;EAsJpB;AACF;AACA;AACA;AACA;AACA;EA3JYA,UAAU;EA6JpB;AACF;AACA;AACA;AACA;EAjKYA,UAAU;EAmKpB;AACF;AACA;AACA;AACA;EAvKYA,UAAU;EAyKpB;AACF;AACA;AACA;AACA;EA7KYA,UAAU;EA+KpB;AACF;AACA;EAjLYA,UAAU;EAmLpB;AACF;AACA;AACA;AACA;EAvLYA,UAAU;EAyLpB;AACF;AACA;AACA;AACA;EA7LYA,UAAU;EA+LpB;AACF;AACA;AACA;AACA;AACA;AACA;AACA;EAtMYA,UAAU;EAwMpB;AACF;AACA;AACA;EA3MYA,UAAU;EA6MpB;AACF;AACA;AACA;EAhNYA,UAAU;EAkNpB;AACF;AACA;AACA;EArNYA,UAAU;EAuNpB;AACF;AACA;AACA;EA1NYA,UAAU;EA4NpB;AACF;AACA;AACA;AACA;EAhOYA,UAAU;EAkOpB;AACF;AACA;AACA;AACA;EAtOYA,UAAU;EAwOpB;AACF;AACA;AACA;AACA;EA5OYA,UAAU;EA8OpB;AACF;AACA;AACA;AACA;EAlPYA,UAAU;EAoPpB;AACF;AACA;AACA;AACA;EAxPYA,UAAU;EA0PpB;AACF;AACA;AACA;AACA;EA9PYA,UAAU;EAgQpB;AACF;AACA;AACA;AACA;EApQYA,UAAU;EAAA,OAAVA,UAAU;AAAA","ignoreList":[]}