A B C D E G H I N O P R S T U V W Z 

A

accountAvailabilityFailed() - Method in interface zendesk.chat.ChatStringProvider
 
accountProvider() - Method in interface zendesk.chat.Providers
Returns a provider to access account information.
AccountProvider - Interface in zendesk.chat
A provider to access account information.
addVisitorTags(List<String>, <any>) - Method in interface zendesk.chat.ProfileProvider
Adds the tags to the visitor profile.
appendVisitorNote(String) - Method in interface zendesk.chat.ProfileProvider
Appends the note to an existing note on the visitor profile.
appendVisitorNote(String, <any>) - Method in interface zendesk.chat.ProfileProvider
Deprecated.
use #appendVisitorNote(String note) instead Appending visitor notes does not return an acknowledgement from the chat server. Therefore callbacks are redundant.

B

build() - Method in class zendesk.chat.ChatConfiguration.Builder
Constructs a new instance of ChatConfiguration.
build() - Method in class zendesk.chat.ChatProvidersConfiguration.Builder
Builds an instance of ChatProvidersConfiguration with this configuration.
builder() - Static method in class zendesk.chat.ChatConfiguration
Returns a new builder for constructing ChatConfiguration.
builder() - Static method in class zendesk.chat.ChatProvidersConfiguration
Returns a builder for constructing an instances of ChatProvidersConfiguration.
builder(ChatConfiguration) - Static method in class zendesk.chat.ChatConfiguration
Returns a new builder for constructing ChatConfiguration that builds on top of an existing configuration.
builder(ChatProvidersConfiguration) - Static method in class zendesk.chat.ChatProvidersConfiguration
Returns a builder for constructing an instances of ChatProvidersConfiguration that builds on top of an existing visitor info.
Builder() - Constructor for class zendesk.chat.ChatProvidersConfiguration.Builder
 

C

Chat - Enum in zendesk.chat
A centralized entry point into Zendesk Chat SDK.
ChatConfiguration - Class in zendesk.chat
Data class, that represents the initial configuration of Chat SDK.
ChatConfiguration.Builder - Class in zendesk.chat
Fluent API to construct instances of ChatConfiguration.
ChatEngine - Class in zendesk.chat
Implementation of an engine that connects Messaging SDK with ChatProviders.
ChatInfo - Class in zendesk.chat
Wrapper class for handling the response from ChatProvider#getChatInfo(com.zendesk.service.ZendeskCallback)
ChatInfo(boolean) - Constructor for class zendesk.chat.ChatInfo
 
ChatMenuAction - Enum in zendesk.chat
All possible menu actions accessible by the visitor during the chat.
chatProvider() - Method in interface zendesk.chat.Providers
Returns a provider to access and modify the chat state.
ChatProvider - Interface in zendesk.chat
A provider to access and modify the chat state.
ChatProvidersConfiguration - Class in zendesk.chat
Default configuration used when starting chats from this SDK.
ChatProvidersConfiguration.Builder - Class in zendesk.chat
 
ChatStringProvider - Interface in zendesk.chat
 
clearCache() - Method in enum zendesk.chat.Chat
Clears and data associated with the current chat session.
clearDepartment(<any>) - Method in interface zendesk.chat.ChatProvider
Sends a request to clear the currently selected department.
clearVisitorNotes(<any>) - Method in interface zendesk.chat.ProfileProvider
Clears all visitor notes.
connect() - Method in interface zendesk.chat.ConnectionProvider
Connects to the backend.
connectionProvider() - Method in interface zendesk.chat.Providers
Returns a provider to access and control state of the connection.
ConnectionProvider - Interface in zendesk.chat
A provider to access and control state of the web socket connection with the Zendesk Chat backend.

D

deleteFailedMessage(String) - Method in interface zendesk.chat.ChatProvider
Deletes the failed ChatLog with given ID from the local chat state.
departmentFieldPrompt() - Method in interface zendesk.chat.ChatStringProvider
 
disconnect() - Method in interface zendesk.chat.ConnectionProvider
Disconnects from the backend.

E

emailFieldHint() - Method in interface zendesk.chat.ChatStringProvider
 
emailFieldPrompt() - Method in interface zendesk.chat.ChatStringProvider
 
endChat(<any>) - Method in interface zendesk.chat.ChatProvider
Sends a request to end the chat session.
engine() - Static method in class zendesk.chat.ChatEngine
Returns the chat engine to be used in the Messaging SDK.
expectCommentComposerHint() - Method in interface zendesk.chat.ChatStringProvider
 

G

getAccount() - Method in interface zendesk.chat.AccountProvider
Gets the currently cached account.
getAccount(<any>) - Method in interface zendesk.chat.AccountProvider
Gets the latest Account.
getAuthor() - Method in class zendesk.chat.PushData
Returns the author of this push data.
getChatInfo(<any>) - Method in interface zendesk.chat.ChatProvider
Gets information about the state of the current chat for the current visitor.
getChatProvidersConfiguration() - Method in enum zendesk.chat.Chat
Gets the current ChatProvidersConfigurationStore
getChatSettings() - Method in interface zendesk.chat.SettingsProvider
Gets the currently cached ChatSettings.
getChatState() - Method in interface zendesk.chat.ChatProvider
Gets an immutable snapshot of the current chat state.
getConfigurations() - Method in class zendesk.chat.ChatConfiguration
 
getConnectionStatus() - Method in interface zendesk.chat.ConnectionProvider
Gets the current connection status.
getDepartmentName() - Method in class zendesk.chat.ChatProvidersConfiguration
Returns the default department of this chat.
getMessage() - Method in class zendesk.chat.PushData
Returns a message or null depending on the type of this push data.
getTimestamp() - Method in class zendesk.chat.PushData
Returns the timestamp in UTC time zone.
getType() - Method in class zendesk.chat.PushData
Returns the type of this push data.
getVisitorInfo() - Method in class zendesk.chat.ChatProvidersConfiguration
Returns the zendesk.chat.VisitorInfo of this user.
getVisitorInfo() - Method in interface zendesk.chat.ProfileProvider
Gets the current information about the visitor

H

handoverWelcomeMessage() - Method in interface zendesk.chat.ChatStringProvider
 
hasIdentity() - Method in enum zendesk.chat.Chat
Checks whether an identity has been set up for the current chat session.

I

init(Context, String) - Method in enum zendesk.chat.Chat
Initializes the Chat SDK.
init(Context, String, String) - Method in enum zendesk.chat.Chat
Initializes the Chat SDK with app id.
invalidEmailMessage() - Method in interface zendesk.chat.ChatStringProvider
 
isChatting() - Method in class zendesk.chat.ChatInfo
 

N

nameFieldHint() - Method in interface zendesk.chat.ChatStringProvider
 
nameFieldPrompt() - Method in interface zendesk.chat.ChatStringProvider
 

O

observeAccount(ObservationScope, <any>) - Method in interface zendesk.chat.AccountProvider
Observes changes to the Account in real-time.
observeChatSettings(ObservationScope, <any>) - Method in interface zendesk.chat.SettingsProvider
Registers an observer to be notified when chat settings changes.
observeChatState(ObservationScope, <any>) - Method in interface zendesk.chat.ChatProvider
Registers an observer to be notified when chat state changes.
observeConnectionStatus(ObservationScope, <any>) - Method in interface zendesk.chat.ConnectionProvider
Registers an observer to be notified when connection status changes.
observeVisitorInfo(ObservationScope, <any>) - Method in interface zendesk.chat.ProfileProvider
Registers an observer to be notified when the visitor info changes.
offlineFormCompletionAcknowledgement() - Method in interface zendesk.chat.ChatStringProvider
 
offLineFormIntroduction() - Method in interface zendesk.chat.ChatStringProvider
 
offlineFormMessagePrompt() - Method in interface zendesk.chat.ChatStringProvider
 
offlineFormWelcomeMessage() - Method in interface zendesk.chat.ChatStringProvider
 
offlineMessage() - Method in interface zendesk.chat.ChatStringProvider
 

P

phoneFieldHint() - Method in interface zendesk.chat.ChatStringProvider
 
phoneFieldPrompt() - Method in interface zendesk.chat.ChatStringProvider
 
PreChatFormFieldStatus - Enum in zendesk.chat
Enum describing the possible statuses of the fields of the pre-Chat form.
preChatFormIntroduction() - Method in interface zendesk.chat.ChatStringProvider
 
preChatFormWelcomeMessage() - Method in interface zendesk.chat.ChatStringProvider
 
preChatResponseAcceptedMessage() - Method in interface zendesk.chat.ChatStringProvider
 
processPushNotification(Map<String, String>) - Method in interface zendesk.chat.PushNotificationsProvider
Processes the data from the received remote message and returns a parsed representation of the raw data.
profileProvider() - Method in interface zendesk.chat.Providers
Returns a provider to access and control visitor profile information.
ProfileProvider - Interface in zendesk.chat
A provider to access and control visitor profile information.
providers() - Method in enum zendesk.chat.Chat
Exposes access to all available providers within the Zendesk Chat SDK.
Providers - Interface in zendesk.chat
All available providers within Zendesk Chat SDK.
PushData - Class in zendesk.chat
Represents a push notification data sent by the Zendesk Chat backend.
PushData.Type - Enum in zendesk.chat
Defines the type of the push data.
pushNotificationsProvider() - Method in interface zendesk.chat.Providers
Returns a provider to interact with push notifications.
PushNotificationsProvider - Interface in zendesk.chat
A provider to interact with push notifications.

R

registerPushToken(String) - Method in interface zendesk.chat.PushNotificationsProvider
Registers the push token in Zendesk Chat backend.
registerPushToken(String, <any>) - Method in interface zendesk.chat.PushNotificationsProvider
Registers the push token in Zendesk Chat backend.
removeVisitorTags(List<String>, <any>) - Method in interface zendesk.chat.ProfileProvider
Removes the tags from the visitor profile.
requestChat() - Method in interface zendesk.chat.ChatProvider
Deprecated.
This API is no longer supported
requestTranscript() - Method in interface zendesk.chat.ChatStringProvider
 
requestTranscriptEmailText() - Method in interface zendesk.chat.ChatStringProvider
 
requestTranscriptText() - Method in interface zendesk.chat.ChatStringProvider
 
resendFailedFile(String, FileUploadListener) - Method in interface zendesk.chat.ChatProvider
Re-sends the failed file and updates the local chat logs.
resendFailedMessage(String) - Method in interface zendesk.chat.ChatProvider
Re-sends the failed message and updates the local chat logs.
resetIdentity() - Method in enum zendesk.chat.Chat
Resets the visitor details to a clean slate allowing a new visitor to chat
resetIdentity(<any>) - Method in enum zendesk.chat.Chat
Resets the visitor details to a clean slate allowing a new visitor to chat

S

sendChatComment(String, <any>) - Method in interface zendesk.chat.ChatProvider
Sends the visitor's comment on the chat experience.
sendChatRating(ChatRating, <any>) - Method in interface zendesk.chat.ChatProvider
Sends the visitor's rating on the chat experience.
sendEmailTranscript(String, <any>) - Method in interface zendesk.chat.ChatProvider
Schedules an email containing the chat transcript to be sent when the chat has ended.
sendFile(File, FileUploadListener) - Method in interface zendesk.chat.ChatProvider
Sends a file and updates the local chat state.
sendMessage(String) - Method in interface zendesk.chat.ChatProvider
Sends a new text message and updates the local chat logs.
sendOfflineForm(OfflineForm, <any>) - Method in interface zendesk.chat.ChatProvider
Sends an offline form to contact the business when agents are offline.
setChatProvidersConfiguration(ChatProvidersConfiguration) - Method in enum zendesk.chat.Chat
Sets the default configuration used when starting chats from this SDK.
setDepartment(long, <any>) - Method in interface zendesk.chat.ChatProvider
Sends a request to set a department for chatting.
setDepartment(String, <any>) - Method in interface zendesk.chat.ChatProvider
Sends a request to set a department for chatting.
setIdentity(JwtAuthenticator) - Method in enum zendesk.chat.Chat
Sets up the Chat SDK to authenticate visitors using the given JwtAuthenticator
setIdentity(JwtAuthenticator, <any>) - Method in enum zendesk.chat.Chat
Sets up the Chat SDK to authenticate visitors using the given JwtAuthenticator
settingsProvider() - Method in interface zendesk.chat.Providers
Returns a provider to access server-driven settings.
SettingsProvider - Interface in zendesk.chat
A provider to access server-driven settings for Zendesk Chat.
setTyping(boolean) - Method in interface zendesk.chat.ChatProvider
Sends a request to inform involved agents whether the visitor is currently typing or not.
setVisitorInfo(VisitorInfo, <any>) - Method in interface zendesk.chat.ProfileProvider
Sets the information about the visitor.
setVisitorNote(String) - Method in interface zendesk.chat.ProfileProvider
Sets the note on the visitor profile.
setVisitorNote(String, <any>) - Method in interface zendesk.chat.ProfileProvider
Deprecated.
use #setVisitorNote(String note) instead Setting visitor notes does not return an acknowledgement from the chat server. Therefore callbacks are redundant.
skip() - Method in interface zendesk.chat.ChatStringProvider
 

T

trackVisitorPath(VisitorPath, <any>) - Method in interface zendesk.chat.ProfileProvider
Tracks the current location of the visitor.
transcriptConfirmation(String) - Method in interface zendesk.chat.ChatStringProvider
 
transferString() - Method in interface zendesk.chat.ChatStringProvider
 

U

unregisterPushToken() - Method in interface zendesk.chat.PushNotificationsProvider
Unregisters the push token in Zendesk Chat backend.
unregisterPushToken(<any>) - Method in interface zendesk.chat.PushNotificationsProvider
Unregisters the push token in Zendesk Chat backend.
update(Update) - Method in class zendesk.chat.ChatEngine
 

V

valueOf(String) - Static method in enum zendesk.chat.Chat
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.chat.ChatMenuAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.chat.PreChatFormFieldStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.chat.PushData.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum zendesk.chat.Chat
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.chat.ChatMenuAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.chat.PreChatFormFieldStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.chat.PushData.Type
Returns an array containing the constants of this enum type, in the order they are declared.

W

withAgentAvailabilityEnabled(boolean) - Method in class zendesk.chat.ChatConfiguration.Builder
Toggles the agent availability on or off.
withChatMenuActions(ChatMenuAction...) - Method in class zendesk.chat.ChatConfiguration.Builder
Allows overriding of the conversation menu.
withDepartment(String) - Method in class zendesk.chat.ChatProvidersConfiguration.Builder
Configures the default department to be used.
withDepartmentFieldStatus(PreChatFormFieldStatus) - Method in class zendesk.chat.ChatConfiguration.Builder
Sets the status of the 'department' field in the pre-Chat form.
withEmailFieldStatus(PreChatFormFieldStatus) - Method in class zendesk.chat.ChatConfiguration.Builder
Sets the status of the 'email' field in the pre-Chat form.
withNameFieldStatus(PreChatFormFieldStatus) - Method in class zendesk.chat.ChatConfiguration.Builder
Sets the status of the 'name' field in the pre-Chat form.
withOfflineFormEnabled(boolean) - Method in class zendesk.chat.ChatConfiguration.Builder
Toggles the offline form on or off.
withPhoneFieldStatus(PreChatFormFieldStatus) - Method in class zendesk.chat.ChatConfiguration.Builder
Sets the status of the 'phone number' field in the pre-Chat form.
withPreChatFormEnabled(boolean) - Method in class zendesk.chat.ChatConfiguration.Builder
Toggles the entire pre-Chat form on or off.
withTranscriptEnabled(boolean) - Method in class zendesk.chat.ChatConfiguration.Builder
Toggles the flag to either enable or disable the email transcript prompt at the end of a chat that allows end users to request a transcript.
withVisitorInfo(VisitorInfo) - Method in class zendesk.chat.ChatProvidersConfiguration.Builder
Configures the zendesk.chat.VisitorInfo of the user.

Z

zendesk.chat - package zendesk.chat
 
A B C D E G H I N O P R S T U V W Z