Index

A B C D E F G H I K L M N O P R S T U V W Z
All Classes and Interfaces|All Packages

A

APP_UPDATE_REQUIRED - Enum constant in enum class com.zello.sdk.Error

An update is required.

AppState - Class in com.zello.sdk

The AppState class represents the current state of the Zello Work app.

AppState() - Constructor for class com.zello.sdk.AppState

Audio - Class in com.zello.sdk

Manages AudioMode used by Zello Work app.

AudioMode - Enum Class in com.zello.sdk

The AudioMode enum represents the audio modes available with Zello SDK.

AVAILABLE - Enum constant in enum class com.zello.sdk.ContactStatus

Contact is online and available to talk.

AVAILABLE - Enum constant in enum class com.zello.sdk.Status

User is online and available to talk.

B

beginMessage() - Method in class com.zello.sdk.Zello

Starts sending a voice message to the currently selected user or channel.

BLUETOOTH - Enum constant in enum class com.zello.sdk.AudioMode

Bluetooth headset.

BluetoothAccessoryState - Enum Class in com.zello.sdk

The BluetoothAccessoryState enum represents states of Bluetooth accessories.

BluetoothAccessoryType - Enum Class in com.zello.sdk

The BluetoothAccessoryType enum represents types of Bluetooth accessories.

BUSY - Enum constant in enum class com.zello.sdk.ContactStatus

Contact is online but currently busy.

BUSY - Enum constant in enum class com.zello.sdk.Status

User is online but currently busy.

C

cancelSignIn() - Method in class com.zello.sdk.Zello

Cancels the currently running sign in process.

CHANNEL - Enum constant in enum class com.zello.sdk.ContactType

Contact is a channel.

CHANNELS - Enum constant in enum class com.zello.sdk.Tab

Tab populated with the list of channels.

clone() - Method in class com.zello.sdk.AppState

clone() - Method in class com.zello.sdk.Contact

clone() - Method in class com.zello.sdk.MessageIn

clone() - Method in class com.zello.sdk.MessageOut

com.zello.sdk - package com.zello.sdk

configure(Context) - Method in class com.zello.sdk.Zello

Configures the Zello SDK.

configure(String, Context) - Method in class com.zello.sdk.Zello

Configures the Zello SDK.

configure(String, Context, Events) - Method in class com.zello.sdk.Zello

Configures the Zello SDK and subscribes for Zello SDK Events.

connectChannel(String) - Method in class com.zello.sdk.Zello

Connects the user to a channel.

CONNECTED - Enum constant in enum class com.zello.sdk.BluetoothAccessoryState

A device has connected.

CONNECTING - Enum constant in enum class com.zello.sdk.ContactStatus

The channel is in the process of connecting.

Contact - Class in com.zello.sdk

The Contact class represents a contact of the current user.

Contact() - Constructor for class com.zello.sdk.Contact

Contacts - Class in com.zello.sdk

The Contacts class represents the contacts of the current user.

ContactStatus - Enum Class in com.zello.sdk

The ContactStatus enum represents the status of a Contact.

ContactType - Enum Class in com.zello.sdk

The ContactType enum represents the type of Contact.

CONVERSATION - Enum constant in enum class com.zello.sdk.ContactType

Contact is a conversation.

D

DARK - Enum constant in enum class com.zello.sdk.Theme

Dark UI.

DEVICE_ID_MISMATCH - Enum constant in enum class com.zello.sdk.Error

The device identifier provided does not match the one from the Zello Work console.

disconnectChannel(String) - Method in class com.zello.sdk.Zello

Disconnects the user from a channel.

DISCONNECTED - Enum constant in enum class com.zello.sdk.BluetoothAccessoryState

A device has disconnected.

E

EARPIECE - Enum constant in enum class com.zello.sdk.AudioMode

Phone's earpiece.

endMessage() - Method in class com.zello.sdk.Zello

Stops sending a voice message.

enterPowerSavingMode() - Method in class com.zello.sdk.Zello

Limits communication between the Zello Work app and the server to optimize power and data consumption.

Error - Enum Class in com.zello.sdk

The Error enum represents some of the authentication errors that can be encountered in the Zello SDK.

ERROR - Enum constant in enum class com.zello.sdk.BluetoothAccessoryState

An error occurred.

Events - Interface in com.zello.sdk

The Events interface enables monitoring of Zello SDK state and property changes

F

FOREGROUND_SERVICE_NOT_ALLOWED - Enum constant in enum class com.zello.sdk.PermissionError

Foreground service cannot start.

G

GATEWAY - Enum constant in enum class com.zello.sdk.ContactType

Contact is a gateway.

getAppState(AppState) - Method in class com.zello.sdk.Zello

Gets info about the current application state.

getAudio() - Method in class com.zello.sdk.Zello

Gets an instance of the Audio class that is used to control Zello audio settings.

getAuthor() - Method in class com.zello.sdk.MessageIn

Returns an instance of the Contact that authored the message.

getContacts() - Method in class com.zello.sdk.Zello

Gets the list of users and channels in the contact list of the current user.

getCount() - Method in class com.zello.sdk.Contacts

Returns the number of contacts in the list.

getDisplayName() - Method in class com.zello.sdk.Contact

Returns the display name for the Contact.

getExternalId() - Method in class com.zello.sdk.AppState

Returns an optional external id tag used by Zello Work Server Recording.

getFrom() - Method in class com.zello.sdk.MessageIn

Returns an instance of the Contact that is sending the user the message.

getFullName() - Method in class com.zello.sdk.Contact

Returns the full name of the Contact.

getInstance() - Static method in class com.zello.sdk.Zello

Gets the instance of Zello singleton object.

getItem(int) - Method in class com.zello.sdk.Contacts

Returns the Contact at the specified index.

getLastError() - Method in class com.zello.sdk.AppState

Returns the most recent Error encountered by the Zello Work app.

getMessageIn(MessageIn) - Method in class com.zello.sdk.Zello

Gets info about the current active incoming voice message.

getMessageOut(MessageOut) - Method in class com.zello.sdk.Zello

Gets info about the current active outgoing voice message.

getMode() - Method in class com.zello.sdk.Audio

Returns the current AudioMode type.

getMuted() - Method in class com.zello.sdk.Contact

Returns whether the Contact is muted or not.

getName() - Method in class com.zello.sdk.Contact

Returns the identifying name of the Contact.

getNetwork() - Method in class com.zello.sdk.AppState

Returns the network name for the current user.

getNetworkUrl() - Method in class com.zello.sdk.AppState

Returns the network in URL for the current user.

getNoDisconnect() - Method in class com.zello.sdk.Contact

Returns whether the channel has the no disconnect setting enabled or not.

getReconnectTimer() - Method in class com.zello.sdk.AppState

Returns the timer for reconnecting to the network.

getSelectedContact(Contact) - Method in class com.zello.sdk.Zello

Gets info about the currently selected contact.

getShowContacts() - Method in class com.zello.sdk.AppState

Determines if the contacts list for the user is available to display.

getStatus() - Method in class com.zello.sdk.AppState

Returns the Status for the current user.

getStatus() - Method in class com.zello.sdk.Contact

Returns the ContactStatus for the Contact.

getStatusMessage() - Method in class com.zello.sdk.AppState

Returns the custom status message for the current user.

getStatusMessage() - Method in class com.zello.sdk.Contact

Returns the custom status message for the Contact.

getTitle() - Method in class com.zello.sdk.Contact

Returns the title for the Contact.

getTo() - Method in class com.zello.sdk.MessageOut

Returns the instance of the Contact that the outgoing message is being sent to.

getType() - Method in class com.zello.sdk.Contact

Returns the ContactType for the Contact.

getUsername() - Method in class com.zello.sdk.AppState

Returns the username of the current user.

getUsersCount() - Method in class com.zello.sdk.Contact

Returns the number of online users in the channel.

getUsersTotal() - Method in class com.zello.sdk.Contact

Returns the number of total users in the channel.

getWearableCount() - Method in class com.zello.sdk.Audio

Gets the number of wearable devices that can play audio.

GROUP - Enum constant in enum class com.zello.sdk.ContactType

Contact is a group.

H

handleMessage(Message) - Method in class com.zello.sdk.SafeHandler

handleMessageFromSafeHandler(Message) - Method in interface com.zello.sdk.SafeHandlerEvents

Method that's implements handling of a Message routed through an associated SafeHandler.

I

INTERNET_CONNECTION_RESTRICTED - Enum constant in enum class com.zello.sdk.Error

Internet access is currently restricted.

INVALID_CREDENTIALS - Enum constant in enum class com.zello.sdk.Error

An invalid username or password was input.

INVALID_NETWORK_NAME - Enum constant in enum class com.zello.sdk.Error

An invalid network name was input.

isActive() - Method in class com.zello.sdk.MessageIn

Determines if the MessageIn is currently in progress or not.

isActive() - Method in class com.zello.sdk.MessageOut

Determines if the MessageOut is currently in progress or not.

isAutoRunEnabled() - Method in class com.zello.sdk.AppState

Determines if the auto run setting is enabled.

isAvailable() - Method in class com.zello.sdk.AppState

Determines if the Zello Work app is available on the device.

isCancellingSignin() - Method in class com.zello.sdk.AppState

Determines if the sign in request for the user is being cancelled.

isChannelAutoConnectEnabled() - Method in class com.zello.sdk.AppState

Determines if the auto connect channel setting is enabled.

isConfiguring() - Method in class com.zello.sdk.AppState

Determines if the Zello Work app is currently configuring.

isConnecting() - Method in class com.zello.sdk.MessageOut

Determines if a connection is currently being established between the user and the recipient.

isCustomBuild() - Method in class com.zello.sdk.AppState

Determines if the Zello Work app is a custom build.

isInitializing() - Method in class com.zello.sdk.AppState

Determines if the Zello Work app is initializing.

isLastMessageReplayAvailable() - Method in class com.zello.sdk.Zello

Determines if there is a message available to replay.

isLocked() - Method in class com.zello.sdk.AppState

Determines if the Zello Work app is currently locked.

isModeAvailable(AudioMode) - Method in class com.zello.sdk.Audio

Determines if the passed in AudioMode is available on the device.

isModeChanging() - Method in class com.zello.sdk.Audio

Determines if the old AudioMode is currently in the process of changing to a new AudioMode.

isReconnecting() - Method in class com.zello.sdk.AppState

Determines if the Zello Work app is trying to reconnect the user to the network.

isSignedIn() - Method in class com.zello.sdk.AppState

Determines if the user is currently signed into a Zello Work network.

isSigningIn() - Method in class com.zello.sdk.AppState

Determines if the user is in the process of signing in.

isSigningOut() - Method in class com.zello.sdk.AppState

Determines if the user is in the process of signing out.

isValid() - Method in class com.zello.sdk.Contact

Check if the object is empty.

isWaitingForNetwork() - Method in class com.zello.sdk.AppState

Determines if the Zello Work app is waiting for the network to be available.

K

KICKED - Enum constant in enum class com.zello.sdk.Error

User signed in on another device, which kicked the user off the network on the previous device.

L

LE - Enum constant in enum class com.zello.sdk.BluetoothAccessoryType

A PTT button connected via Low Energy Bluetooth connection.

leavePowerSavingMode() - Method in class com.zello.sdk.Zello

Resumes full communication between the Zello Work app and the server.

LIGHT - Enum constant in enum class com.zello.sdk.Theme

Light UI.

lock(String, String) - Method in class com.zello.sdk.Zello

Locks the default Zello Work app UI to prevent users from accessing it.

M

MessageIn - Class in com.zello.sdk

The MessageIn class represents an incoming voice message.

MessageIn() - Constructor for class com.zello.sdk.MessageIn

MessageOut - Class in com.zello.sdk

The MessageOut class represents an outgoing voice message.

MessageOut() - Constructor for class com.zello.sdk.MessageOut

MICROPHONE_NOT_GRANTED - Enum constant in enum class com.zello.sdk.PermissionError

Microphone permission error.

muteContact(Contact, boolean) - Method in class com.zello.sdk.Zello

Mutes or unmutes a contact.

N

NETWORK_SIGNIN_FAILED - Enum constant in enum class com.zello.sdk.Error

Can't join the network.

NETWORK_SUSPENDED - Enum constant in enum class com.zello.sdk.Error

The network was suspended.

NO_INTERNET_CONNECTION - Enum constant in enum class com.zello.sdk.Error

There is no internet connection.

NONE - Enum constant in enum class com.zello.sdk.Error

No error.

NONE - Enum constant in enum class com.zello.sdk.PermissionError

No error.

O

OFFLINE - Enum constant in enum class com.zello.sdk.ContactStatus

Contact is offline.

onAppStateChanged() - Method in interface com.zello.sdk.Events

Called when the AppState changes.

onAudioStateChanged() - Method in interface com.zello.sdk.Events

Called when the the state of the Audio changes.

onBluetoothAccessoryStateChanged(BluetoothAccessoryType, BluetoothAccessoryState, String, String) - Method in interface com.zello.sdk.Events

Called when a Bluetooth accessory connection state changes.

onContactsChanged() - Method in interface com.zello.sdk.Events

Called when the Contacts for the user changes.

onForegroundServiceStartFailed(Throwable) - Method in interface com.zello.sdk.Events

Called when an attempt to start the Zello foreground service fails.

onLastContactsTabChanged(Tab) - Method in interface com.zello.sdk.Events

Called when the last Contacts Tab changes.

onMessageStateChanged() - Method in interface com.zello.sdk.Events

Called when the state of either the MessageOut or MessageIn changes.

onMicrophonePermissionNotGranted() - Method in interface com.zello.sdk.Events

Called when an invocation of the beginMessage() method fails because the microphone permission hasn't been granted.

onSelectedContactChanged() - Method in interface com.zello.sdk.Events

Called when the selected contact changes.

openMainScreen() - Method in class com.zello.sdk.Zello

Opens the main screen of the Zello Work app.

P

PermissionError - Enum Class in com.zello.sdk

The PermissionError enum defines permission-related errors.

R

RECENTS - Enum constant in enum class com.zello.sdk.Tab

Tab populated with recent users and channels.

replayLastIncomingMessage() - Method in class com.zello.sdk.Zello

Replays the last played voice message.

requestLocationPermission() - Method in class com.zello.sdk.Zello

Opens a dialog that requests the location permission needed by the Zello Work app to function properly.

requestLocationPermission(Activity) - Method in class com.zello.sdk.Zello

Opens a dialog that requests the location permission needed by the Zello Work app to function properly.

requestVitalPermissions() - Method in class com.zello.sdk.Zello

Opens a dialog that requests all of the vital run time permissions needed by the Zello Work app to function properly.

requestVitalPermissions(Activity) - Method in class com.zello.sdk.Zello

Opens a dialog that requests all of the vital run time permissions needed by the Zello Work app to function properly.

reset() - Method in class com.zello.sdk.AppState

Resets the AppState instance back to the default values.

reset() - Method in class com.zello.sdk.Contact

Resets the Contact instance back to the default values.

reset() - Method in class com.zello.sdk.MessageIn

Resets the MessageIn instance back to the default values.

reset() - Method in class com.zello.sdk.MessageOut

Resets the MessageOut instance back to the default values.

S

SafeHandler<T extends SafeHandlerEvents> - Class in com.zello.sdk

Handler wrapper that prevents a potential memory leak occurring due to a raw Handler being a member of a service or an activity.

SafeHandler(T, Context) - Constructor for class com.zello.sdk.SafeHandler

Primary constructor.

SafeHandlerEvents - Interface in com.zello.sdk

Callback events used with SafeHandler.

selectContact(String, Tab[], Tab, Theme) - Method in class com.zello.sdk.Zello

Opens an activity, which lets the user select a user or channel to talk to.

selectContact(String, Tab[], Tab, Theme, Activity) - Method in class com.zello.sdk.Zello

Opens an activity, which lets the user select a user or channel to talk to, from another activity.

SERVER_LICENSE_PROBLEM - Enum constant in enum class com.zello.sdk.Error

There is a server license problem.

SERVER_SECURE_CONNECT_FAILED - Enum constant in enum class com.zello.sdk.Error

A secure connection with the server could not be established.

SERVER_SIGNIN_FAILED - Enum constant in enum class com.zello.sdk.Error

Can't connect to the server.

setAutoConnectChannels(boolean) - Method in class com.zello.sdk.Zello

Specifies whether newly added channels should connect automatically.

setAutoRun(boolean) - Method in class com.zello.sdk.Zello

Specifies whether the Zello Work app should be launched on the start of the OS.

setExternalId(String) - Method in class com.zello.sdk.Zello

Sets an optional external id tag used by Zello Work Server Recording.

setHeadsetActive(boolean) - Method in class com.zello.sdk.Zello

Tell the host app that it doesn't need to handle the headset hook events.

setMode(AudioMode) - Method in class com.zello.sdk.Audio

Sets the current AudioMode to mode.

setSelectedChannelOrGroup(String) - Method in class com.zello.sdk.Zello

Selects a contact (channel or group) to send messages to.

setSelectedContact(Contact) - Method in class com.zello.sdk.Zello

Selects a contact (user or channel) to send messages to.

setSelectedUserOrGateway(String) - Method in class com.zello.sdk.Zello

Selects a contact (user or gateway) to send messages to.

setShowBluetoothAccessoriesNotifications(boolean) - Method in class com.zello.sdk.Zello

Asks the host app to suppress UI notifications when Bluetooth PTT buttons connect or disconnect.

setStatus(Status) - Method in class com.zello.sdk.Zello

Sets the current user's availability status.

setStatusMessage(String) - Method in class com.zello.sdk.Zello

Sets the current user's custom status message text.

setWearableMode(int) - Method in class com.zello.sdk.Audio

Sets the current AudioMode to the AudioMode.WEARABLE mode using the passed in wearable index.

showMicrophonePermissionDialog() - Method in class com.zello.sdk.Zello

Opens a popup dialog that tells the user that they cannot send voice messages until the permission to record audio has been granted.

showMicrophonePermissionDialog(Activity) - Method in class com.zello.sdk.Zello

Opens a popup dialog that tells the user that they cannot send voice messages until the permission to record audio has been granted.

showPttButtonsScreen(Activity) - Method in class com.zello.sdk.Zello

Opens the PTT buttons settings screen.

signIn(String, String, String) - Method in class com.zello.sdk.Zello

Signs the user into the network with the passed in login credentials.

signIn(String, String, String, boolean) - Method in class com.zello.sdk.Zello

Signs is the user into the network with the passed in login credentials.

signOut() - Method in class com.zello.sdk.Zello

Signs out currently signed in user.

SOLO - Enum constant in enum class com.zello.sdk.Status

User is online but only available to talk with the selected Contact.

SPEAKER - Enum constant in enum class com.zello.sdk.AudioMode

Phone's loudspeaker.

SPP - Enum constant in enum class com.zello.sdk.BluetoothAccessoryType

A PTT button connected via serial protocol over Bluetooth.

STANDBY - Enum constant in enum class com.zello.sdk.ContactStatus

Contact is offline but was recently online.

Status - Enum Class in com.zello.sdk

The Status enum represents the status of the current user.

subscribeToEvents(Events) - Method in class com.zello.sdk.Zello

Subscribes for Zello SDK Events.

T

Tab - Enum Class in com.zello.sdk

The Tab enum represents the contact selection UI tabs of the Zello Work app.

Theme - Enum Class in com.zello.sdk

The Theme enum represents the UI themes available for contact selection UI.

TOO_MANY_SIGNIN_ATTEMPTS - Enum constant in enum class com.zello.sdk.Error

Incorrect credentials were input too many times.

U

unconfigure() - Method in class com.zello.sdk.Zello

Disconnects the SDK from Zello Work app and unsubscribes all Events handlers.

UNKNOWN - Enum constant in enum class com.zello.sdk.Error

An unknown error occurred.

UNKNOWN - Enum constant in enum class com.zello.sdk.PermissionError

Unknown permission error.

unlock() - Method in class com.zello.sdk.Zello

Unlocks the default Zello Work app UI.

UNRELIABLE_CONNECTION - Enum constant in enum class com.zello.sdk.Error

Connection is unreliable and is causing the app to repeatedly sign in.

unsubscribeFromEvents(Events) - Method in class com.zello.sdk.Zello

Unsubscribes from Zello SDK Events.

USER - Enum constant in enum class com.zello.sdk.ContactType

Contact is a single user.

USERS - Enum constant in enum class com.zello.sdk.Tab

Tab populated with the list of users.

V

valueOf(String) - Static method in enum class com.zello.sdk.AudioMode

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.zello.sdk.BluetoothAccessoryState

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.zello.sdk.BluetoothAccessoryType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.zello.sdk.ContactStatus

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.zello.sdk.ContactType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.zello.sdk.Error

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.zello.sdk.PermissionError

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.zello.sdk.Status

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.zello.sdk.Tab

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.zello.sdk.Theme

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.zello.sdk.AudioMode

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.zello.sdk.BluetoothAccessoryState

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.zello.sdk.BluetoothAccessoryType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.zello.sdk.ContactStatus

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.zello.sdk.ContactType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.zello.sdk.Error

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.zello.sdk.PermissionError

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.zello.sdk.Status

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.zello.sdk.Tab

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.zello.sdk.Theme

Returns an array containing the constants of this enum class, in the order they are declared.

W

WEARABLE - Enum constant in enum class com.zello.sdk.AudioMode

Android Wear device.

Z

Zello - Class in com.zello.sdk

The Zello singleton acts as the primary point of interacting to the Zello SDK.

A B C D E F G H I K L M N O P R S T U V W Z
All Classes and Interfaces|All Packages