Class Zello

Zello SDK. This class is a singleton, and can be accessed via Zello.getInstance.

Hierarchy

default
- Zello

Properties

accountStatus

accountStatus: undefined | ZelloAccountStatus

The current account status. undefined when state is not ZelloConnectionState.Connected.

channels

channels: ZelloChannel[] = []

The list of ZelloChannel in the contact list. Sorted by name, ascending.

consoleSettings

consoleSettings: undefined | ZelloConsoleSettings

The console settings for the network. This is only expected to be valid when state is ZelloConnectionState.Connected.

emergencyChannel

emergencyChannel: undefined | ZelloChannel

The configured emergency channel.

groupConversations

groupConversations: ZelloGroupConversation[] = []

The list of ZelloGroupConversation in the contact list. Sorted by name, ascending.

historyVoiceMessage

historyVoiceMessage: undefined | ZelloHistoryVoiceMessage

The currently playing history voice message.

incomingEmergencies

incomingEmergencies: ZelloIncomingEmergency[] = []

The list of incoming emergencies. There can be multiple emergencies on the emergency channel at once. Sorted by start timestamp, ascending.

incomingVoiceMessage

incomingVoiceMessage: undefined | ZelloIncomingVoiceMessage

The current incoming voice message.

outgoingEmergency

outgoingEmergency: undefined | ZelloOutgoingEmergency

The current outgoing emergency.

outgoingVoiceMessage

outgoingVoiceMessage: undefined | ZelloOutgoingVoiceMessage

The current outgoing voice message.

recents

recents: ZelloRecentEntry[] = []

The list of recent entries. Sorted by timestamp, descending.

selectedContact

selectedContact: undefined | ZelloContact

The currently selected contact.

state

state: ZelloConnectionState = ZelloConnectionState.Disconnected

The current connection state of the SDK.

users

users: ZelloUser[] = []

The list of ZelloUser in the contact list. Sorted by name, ascending.

Methods

addListener

addListener(eventType, listener, context?): EmitterSubscription
Adds a listener to be invoked when events of the specified type are emitted. An optional calling context may be provided. The data arguments emitted will be passed to the listener function.
Parameters
- eventType: string
  Name of the event to listen to
- listener: ((...args: any[]) => any)
  Function to invoke when the specified event is emitted
  - - (...args): any
    - Parameters
      Rest...args: any[]
      Returns any
- Optionalcontext: any
  Optional context object to use when invoking the listener
Returns EmitterSubscription
Inherited from EventEmitter.addListener
- Defined in example/node_modules/react-native/Libraries/vendor/emitter/EventEmitter.d.ts:126

addUsersToGroupConversation

addUsersToGroupConversation(groupConversation, users): void
Adds users to the given group conversation. This will trigger the ZelloEvent.GROUP_CONVERSATION_USERS_ADDED and ZelloEvent.CONTACT_LIST_UPDATED events.
Parameters
- groupConversation: ZelloGroupConversation
  The group conversation to add users to.
- users: ZelloUser[]
  The users to add to the group conversation.
Returns void
- Defined in src/sdk/index.ts:606

configure

configure(config): void
Sets configuration variables for the SDK.
Parameters
- config: ZelloConfig
  The configuration to set.
Returns void
- Defined in src/sdk/index.ts:155

connect

connect(credentials): void
Signs into to the Zello Work network using the provided credentials. This will typically trigger the ZelloEvent.CONNECT_STARTED event, followed by either ZelloEvent.CONNECT_SUCCEEDED or ZelloEvent.CONNECT_FAILED. However, if the state is incorrect, ZelloEvent.CONNECT_FAILED will be triggered immediately.
Parameters
- credentials: ZelloCredentials
  The credentials to use for signing in.
Returns void
- Defined in src/sdk/index.ts:181

connectChannel

connectChannel(channel): void
Connects to the given channel. Once connected, the user will be able to send and receive messages from the channel. This will trigger the ZelloEvent.CONTACT_LIST_UPDATED event.
Parameters
- channel: ZelloChannel
  The channel to connect to.
Returns void
- Defined in src/sdk/index.ts:272

createGroupConversation

createGroupConversation(users, displayName?): void
Creates a new group conversation with the given users. This will trigger the ZelloEvent.GROUP_CONVERSATION_CREATED and ZelloEvent.CONTACT_LIST_UPDATED events.
Parameters
- users: ZelloUser[]
  The users to create the group conversation with.
- OptionaldisplayName: string
  Optional; The display name of the group conversation. The conversation can be renamed later by using renameGroupConversation.
Returns void
- Defined in src/sdk/index.ts:583

destroy

destroy(): void
Destroys the SDK instance and cleans up resources. Call this when you are done using the SDK instance for good (application quit).

Returns void
- Defined in src/sdk/index.ts:170

disconnect

disconnect(): void
Signs out of the Zello Work network. This will trigger the ZelloEvent.DISCONNECTED event.

Returns void
- Defined in src/sdk/index.ts:201

disconnectChannel

disconnectChannel(channel): void
Disconnects from the given channel. Once disconnected, the user will no longer be able to send or receive messages from the channel. This will trigger the ZelloEvent.CONTACT_LIST_UPDATED event.
Parameters
- channel: ZelloChannel
  The channel to disconnect from.
Returns void
- Defined in src/sdk/index.ts:290

emit

emit(eventType, ...params): void
Emits an event of the given type with the given data. All handlers of that particular type will be notified.
Parameters
- eventType: string
  Name of the event to emit
- Rest...params: any[]
Returns void
Example
```
emitter.addListener('someEvent', function(message) {
    console.log(message);
  });

  emitter.emit('someEvent', 'abc'); // logs 'abc'
```
Inherited from EventEmitter.emit
- Defined in example/node_modules/react-native/Libraries/vendor/emitter/EventEmitter.d.ts:163

endDispatchCall

endDispatchCall(channel): void
Ends the dispatch call for the given dispatch channel. This will trigger the ZelloEvent.DISPATCH_CALL_ENDED event.

If ZelloConsoleSettings.allowNonDispatchersToEndCalls is false, this method will do nothing.
Parameters
- channel: ZelloDispatchChannel
  The dispatch channel to end the call for.
Returns void
- Defined in src/sdk/index.ts:569

getChannel

getChannel(name): undefined | ZelloChannel
Returns the channel with the given name. Case-insensitive.
Parameters
- name: string
  The name of the channel to search for.
Returns undefined | ZelloChannel
The channel with the given name, or null if no channel with that name exists.
- Defined in src/sdk/index.ts:223

getGroupConversation

getGroupConversation(name): undefined | ZelloGroupConversation
Returns the group conversation with the given name. Case-insensitive.
Parameters
- name: string
  The name of the group conversation to search for.
Returns undefined | ZelloGroupConversation
The group conversation with the given name, or null if no group conversation with that name exists.
- Defined in src/sdk/index.ts:232

getHistory

getHistory(contact, size?): Promise<ZelloHistoryMessage[]>
Returns the history messages for the given contact.
Parameters
- contact: ZelloContact
  The contact to get the history for.
- Optionalsize: number
  Optional; The number of history items to retrieve. Defaults to 50.
Returns Promise<ZelloHistoryMessage[]>
The history items for the given contact.
- Defined in src/sdk/index.ts:464

getImageDataForHistoryImageMessage

getImageDataForHistoryImageMessage(message): Promise<undefined | string>
Returns the image data for the given history image message.
Parameters
- message: ZelloHistoryImageMessage
  The history image message to get the image data for.
Returns Promise<undefined | string>
The image data for the given history image message.
- Defined in src/sdk/index.ts:538

getUser

getUser(name): undefined | ZelloUser
Returns the user with the given name. Case-insensitive.
Parameters
- name: string
  The name of the user to search for.
Returns undefined | ZelloUser
The user with the given name, or null if no user with that name exists.
- Defined in src/sdk/index.ts:214

leaveGroupConversation

leaveGroupConversation(groupConversation): void
Removes the user from the group conversation. This will trigger the ZelloEvent.GROUP_CONVERSATION_LEFT and ZelloEvent.CONTACT_LIST_UPDATED events.
Parameters
- groupConversation: ZelloGroupConversation
  The group conversation to leave.
Returns void
- Defined in src/sdk/index.ts:631

listenerCount

listenerCount(eventType): number
Returns the number of listeners that are currently registered for the given event.
Parameters
- eventType: string
  Name of the event to query
Returns number
Inherited from EventEmitter.listenerCount
- Defined in example/node_modules/react-native/Libraries/vendor/emitter/EventEmitter.d.ts:147

muteContact

muteContact(contact): void
Mutes the given contact. When muted, incoming messages from this contact will not play live, but will still appear in the history. This will trigger the ZelloEvent.CONTACT_LIST_UPDATED event.
Parameters
- contact: ZelloContact
  The contact to mute.
Returns void
- Defined in src/sdk/index.ts:410

playHistoryMessage

playHistoryMessage(message): void
Plays the given history message. This will trigger the ZelloEvent.HISTORY_PLAYBACK_STARTED event.
Parameters
- message: ZelloHistoryVoiceMessage
  The history message to play.
Returns void
- Defined in src/sdk/index.ts:504

removeAllListeners

removeAllListeners(eventType?): void
Removes all of the registered listeners, including those registered as listener maps.
Parameters
- OptionaleventType: string
  Optional name of the event whose registered listeners to remove
Returns void
Inherited from EventEmitter.removeAllListeners
- Defined in example/node_modules/react-native/Libraries/vendor/emitter/EventEmitter.d.ts:139

renameGroupConversation

renameGroupConversation(groupConversation, name): void
Renames the group conversation. This will trigger the ZelloEvent.GROUP_CONVERSATION_RENAMED and ZelloEvent.CONTACT_LIST_UPDATED events.
Parameters
- groupConversation: ZelloGroupConversation
  The group conversation to rename.
- name: string
  The new name for the group conversation.
Returns void
- Defined in src/sdk/index.ts:648

sendAlert

sendAlert(contact, text, level?): void
Sends the alert message to the given contact. This will trigger the ZelloEvent.OUTGOING_ALERT_MESSAGE_SENT or ZelloEvent.OUTGOING_ALERT_MESSAGE_SEND_FAILED event.
Parameters
- contact: ZelloContact
  The contact to send the alert to.
- text: string
  The text to send.
- Optionallevel: ZelloChannelAlertLevel
  Optional; The alert level to send. Only applicable for channels.
Returns void
- Defined in src/sdk/index.ts:380

sendImage

sendImage(contact, data): void
Sends the image message data to the given contact. This will trigger the ZelloEvent.OUTGOING_IMAGE_MESSAGE_SENT or ZelloEvent.OUTGOING_IMAGE_MESSAGE_SEND_FAILED event.
Parameters
- contact: ZelloContact
  The contact to send the image to.
- data: number[]
  The image data to send.
Returns void
- Defined in src/sdk/index.ts:335

sendLocation

sendLocation(contact): void
Sends the alert message to the given contact. This will trigger the ZelloEvent.OUTGOING_ALERT_MESSAGE_SENT or ZelloEvent.OUTGOING_ALERT_MESSAGE_SEND_FAILED event.
Parameters
- contact: ZelloContact
  The contact to send the alert to.
Returns void
- Defined in src/sdk/index.ts:349

sendText

sendText(contact, text): void
Sends the text message to the given contact. This will trigger the ZelloEvent.OUTGOING_TEXT_MESSAGE_SENT or ZelloEvent.OUTGOING_TEXT_MESSAGE_SEND_FAILED event.
Parameters
- contact: ZelloContact
  The contact to send the text to.
- text: string
  The text to send.
Returns void
- Defined in src/sdk/index.ts:364

setAccountStatus

setAccountStatus(status): void
Sets the user's online account status. This will trigger the ZelloEvent.ACCOUNT_STATUS_CHANGED event.
Parameters
- status: ZelloAccountStatus
  The account status to set.
Returns void
- Defined in src/sdk/index.ts:258

setSelectedContact

setSelectedContact(contact): void
Sets the selected contact. While optional, this is typically used for tracking the contact that the user is currently interacting with. This will trigger the ZelloEvent.SELECTED_CONTACT_CHANGED event.
Parameters
- contact: ZelloContact
  The contact to set as selected.
Returns void
- Defined in src/sdk/index.ts:244

startEmergency

startEmergency(): void
Starts an outgoing emergency to the emergency channel. Upon starting, the user's location will be sent, an alert message will be sent, and a 10-second-long voice message will start recording. This will trigger the ZelloEvent.OUTGOING_EMERGENCY_STARTED event.

Returns void
- Defined in src/sdk/index.ts:438

startVoiceMessage

startVoiceMessage(contact): void
Starts a voice message with the given contact. This will trigger the ZelloEvent.OUTGOING_VOICE_MESSAGE_CONNECTING event, followed by the ZelloEvent.OUTGOING_VOICE_MESSAGE_STARTED event. If there is an error, the ZelloEvent.OUTGOING_VOICE_MESSAGE_STOPPED event will be triggered.
Parameters
- contact: ZelloContact
  The contact to start the voice message with.
Returns void
- Defined in src/sdk/index.ts:308

stopEmergency

stopEmergency(): void
Stops the outgoing emergency. This will trigger the ZelloEvent.OUTGOING_EMERGENCY_STOPPED event.

Returns void
- Defined in src/sdk/index.ts:450

stopHistoryMessagePlayback

stopHistoryMessagePlayback(): void
Stops the current history message playback. This will trigger the ZelloEvent.HISTORY_PLAYBACK_STOPPED event.

Returns void
- Defined in src/sdk/index.ts:525

stopVoiceMessage

stopVoiceMessage(): void
Stops the current outgoing voice message. This will trigger the ZelloEvent.OUTGOING_VOICE_MESSAGE_STOPPED event.

Returns void
- Defined in src/sdk/index.ts:321

submitProblemReport

submitProblemReport(): void
Submits a problem report to Zello. Additionally, please contact us to provide more information on what happened.

Returns void
- Defined in src/sdk/index.ts:397

unmuteContact

unmuteContact(contact): void
Unmutes a previously muted contact. When unmuted, incoming messages from this contact will play live. This will trigger the ZelloEvent.CONTACT_LIST_UPDATED event.
Parameters
- contact: ZelloContact
  The contact to unmute.
Returns void
- Defined in src/sdk/index.ts:424

`Static`getInstance

getInstance(): Zello
Returns Zello
- Defined in src/sdk/index.ts:61

Class Zello

Hierarchy

Index

Properties

Methods

Properties

accountStatus

channels

consoleSettings

emergencyChannel

groupConversations

historyVoiceMessage

incomingEmergencies

incomingVoiceMessage

outgoingEmergency

outgoingVoiceMessage

recents

selectedContact

state

users

Methods

addListener

Parameters

Parameters

Returns any

Returns EmitterSubscription

addUsersToGroupConversation

Parameters

Returns void

configure

Parameters

Returns void

connect

Parameters

Returns void

connectChannel

Parameters

Returns void

createGroupConversation

Parameters

Returns void

destroy

Returns void

disconnect

Returns void

disconnectChannel

Parameters

Returns void

emit

Parameters

Returns void

Example

endDispatchCall

Parameters

Returns void

getChannel

Parameters

Returns undefined | ZelloChannel

getGroupConversation

Parameters

Returns undefined | ZelloGroupConversation

getHistory

Parameters

Returns Promise<ZelloHistoryMessage[]>

getImageDataForHistoryImageMessage

Parameters

Returns Promise<undefined | string>

getUser

Parameters

Returns undefined | ZelloUser

leaveGroupConversation

Parameters

Returns void

listenerCount

Parameters

Returns number

muteContact

Parameters

Returns void

playHistoryMessage

`Static`getInstance