Index (Chat SDK v2 EAP

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

A

Account - Class in zendesk.chat.client: Holds information about your Zendesk Chat account.
addVisitorTags(List<String>, <any>) - Method in interface zendesk.chat.ProfileProvider: Adds the tags to the visitor profile.
Agent - Class in zendesk.chat.client: Represents a Zendesk Chat agent.
appendVisitorNote(String) - Method in interface zendesk.chat.ProfileProvider: Appends the note to an existing note on the visitor profile.
Attachment - Class in zendesk.chat.client: Describes a file attached to the ChatLog.AttachmentMessage.
Attachment.Metadata - Class in zendesk.chat.client: Information about the image attachment.

B

build() - Method in class zendesk.chat.client.OfflineForm.Builder: Builds the offline form
build() - Method in class zendesk.chat.client.VisitorInfo.Builder: Builds an instance of [VisitorInfo] with the current configuration.
builder() - Static method in class zendesk.chat.client.VisitorInfo: Returns a builder for constructing [VisitorInfo] object.
builder(String) - Static method in class zendesk.chat.client.OfflineForm: Returns a builder for constructing the offline form
builder(VisitorInfo) - Static method in class zendesk.chat.client.VisitorInfo: Returns a builder for constructing [VisitorInfo] that builds on top of an existing visitor info.

C

cancel() - Method in class zendesk.chat.client.ObservationToken: Cancels the observation by unregistering the observer and clearing all references, allowing resource cleanup.
Chat - Enum in zendesk.chat: A centralized entry point into Zendesk Chat SDK.
ChatEngine - Class in zendesk.chat: Implementation of an engine that connects Messaging SDK with ChatProviders.
ChatLog - Class in zendesk.chat.client: A chat log is a record of an event that happened in the chat between participants.
ChatLog.AttachmentMessage - Class in zendesk.chat.client: Chat log with an additional attachment field.
ChatLog.Comment - Class in zendesk.chat.client: Chat log with an additional fields for the previous and new chat comment.
ChatLog.Message - Class in zendesk.chat.client: Chat log with an additional message field.
ChatLog.Rating - Class in zendesk.chat.client: Chat log with an additional fields for the previous and new chat rating.
ChatLog.Type - Enum in zendesk.chat.client: All possible types of chat logs.
ChatParticipant - Enum in zendesk.chat.client: A chat participant is someone who has participated in the chat either by joining the chat or sending a message.
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.
ChatRating - Enum in zendesk.chat.client: Rating of the chat given by the visitor.
ChatSettings - Class in zendesk.chat.client: Defines a server-driven settings for Zendesk Chat.
ChatState - Class in zendesk.chat.client: Represents the current state of the chat.
ChatStateStore - Class in zendesk.chat.client: Source of truth for the local chat state.
clearDepartment(<any>) - Method in interface zendesk.chat.ChatProvider: Sends a request to clear the currently selected department.
clearVisitorNotes() - 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.
ConnectionState - Enum in zendesk.chat.client: Represents the current state of the connection with the Zendesk Chat backend.
create(String) - Static method in class zendesk.chat.client.VisitorPath: Creates an instance of [VisitorPath] with the title of the web page visited.
create(String, String) - Static method in class zendesk.chat.client.VisitorPath: Creates an instance of [VisitorPath] with the title and the url of the web page visited.
create(Observable<T>, Observer<T>, boolean) - Static method in class zendesk.chat.client.ObservationToken

D

deleteFailedChatLog(String) - Method in interface zendesk.chat.ChatProvider: Deletes the failed ChatLog from the local chat state.
DeliveryStatus - Enum in zendesk.chat.client: An enumeration that specifies the status of the operation.
Department - Class in zendesk.chat.client: Model class for representing an available department in a chat session.
disconnect() - Method in interface zendesk.chat.ConnectionProvider: Disconnects from the backend.

E

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.
equals(Object) - Method in class zendesk.chat.client.Account
equals(Object) - Method in class zendesk.chat.client.Agent
equals(Object) - Method in class zendesk.chat.client.Attachment
equals(Object) - Method in class zendesk.chat.client.Attachment.Metadata
equals(Object) - Method in class zendesk.chat.client.ChatLog.AttachmentMessage
equals(Object) - Method in class zendesk.chat.client.ChatLog.Comment
equals(Object) - Method in class zendesk.chat.client.ChatLog
equals(Object) - Method in class zendesk.chat.client.ChatLog.Message
equals(Object) - Method in class zendesk.chat.client.ChatLog.Rating
equals(Object) - Method in class zendesk.chat.client.ChatSettings
equals(Object) - Method in class zendesk.chat.client.ChatState
equals(Object) - Method in class zendesk.chat.client.Department
equals(Object) - Method in class zendesk.chat.client.VisitorInfo

F

FileUploadListener - Interface in zendesk.chat.client: Delivers an updates that occur during file uploading.

G

getAccount(<any>) - Method in interface zendesk.chat.ChatProvider: Gets the current state of the Account.
getAgents() - Method in class zendesk.chat.client.ChatState: Returns list of agents in the chat.
getAllowedFileTypes() - Method in class zendesk.chat.client.ChatSettings: Returns a set of allowed file types that can be uploaded.
getAttachment() - Method in class zendesk.chat.client.ChatLog.AttachmentMessage: Gets the attachment that describes and helps locate the file shared by the ChatParticipant.
getAuthor() - Method in class zendesk.chat.PushData: Returns the author of this push data.
getAvatarPath() - Method in class zendesk.chat.client.Agent: Returns the avatar url of this agent.
getChatComment() - Method in class zendesk.chat.client.ChatLog.Comment: Gets the previous chat comment.
getChatComment() - Method in class zendesk.chat.client.ChatState: Returns the current comment about chat experience given by the visitor.
getChatLogs() - Method in class zendesk.chat.client.ChatState: Returns the chat logs for this chat.
getChatParticipant() - Method in class zendesk.chat.client.ChatLog: Gets the participant from whom this log originated from.
getChatRating() - Method in class zendesk.chat.client.ChatLog.Rating: Gets the previous chat rating.
getChatRating() - Method in class zendesk.chat.client.ChatState: Returns the current chat rating given by the visitor.
getChatState() - Method in interface zendesk.chat.ChatProvider: Gets the current chat state.
getConnectionState() - Method in interface zendesk.chat.ConnectionProvider: Returns the current connection state.
getDeliveryStatus() - Method in class zendesk.chat.client.ChatLog: Gets the delivery status of this chat log.
getDepartment() - Method in class zendesk.chat.client.ChatState: Returns the selected department for this chat, if one has been selected.
getDepartments() - Method in class zendesk.chat.client.Account: Gets the current departments.
getDisplayName() - Method in class zendesk.chat.client.Agent: Returns the display name of this agent.
getDisplayName() - Method in class zendesk.chat.client.ChatLog: Gets the display name of the participant from who this log originated from.
getEmail() - Method in class zendesk.chat.client.VisitorInfo: Returns the email of this visitor or null if none has been set.
getFile() - Method in class zendesk.chat.client.Attachment: Returns the local File for this attachment.
getHeight() - Method in class zendesk.chat.client.Attachment.Metadata: Returns the height of the image in pixels.
getId() - Method in class zendesk.chat.client.Agent: Returns the unique identifier of this agent.
getId() - Method in class zendesk.chat.client.ChatLog: Gets an unique identifier of this chat log.
getId() - Method in class zendesk.chat.client.Department
getLastModifiedTimestamp() - Method in class zendesk.chat.client.ChatLog: Gets epoch timestamp at which this chat log was last modified.
getMaxFileSizeLimit() - Method in class zendesk.chat.client.ChatSettings: Returns the maximum file upload size in bytes
getMessage() - Method in class zendesk.chat.client.ChatLog.Message: Gets the message sent by the ChatParticipant.
getMessage() - Method in class zendesk.chat.PushData: Returns a message or null depending on the type of this push data.
getMetadata() - Method in class zendesk.chat.client.Attachment: Returns the metadata for this image attachment or null if this attachment is not an image.
getMimeType() - Method in class zendesk.chat.client.Attachment: Returns the MIME type of this attachment.
getName() - Method in class zendesk.chat.client.Attachment: Returns the full name of this attachment.
getName() - Method in class zendesk.chat.client.Department
getName() - Method in class zendesk.chat.client.VisitorInfo: Returns the name of this visitor or null if none has been set.
getNewChatComment() - Method in class zendesk.chat.client.ChatLog.Comment: Gets the new chat comment.
getNewChatRating() - Method in class zendesk.chat.client.ChatLog.Rating: Gets the new chat rating.
getNick() - Method in class zendesk.chat.client.ChatLog: Gets an unique identifier of the participant from whom this log originated from.
getPhoneNumber() - Method in class zendesk.chat.client.VisitorInfo: Returns phone number of this visitor or null if none has been set.
getQueuePosition() - Method in class zendesk.chat.client.ChatState: Returns the queue position of the visitor.
getSize() - Method in class zendesk.chat.client.Attachment: Returns size of this attachment in bytes.
getStatus() - Method in class zendesk.chat.client.Account: Gets the current status of an account.
getStatus() - Method in class zendesk.chat.client.Department
getTimestamp() - Method in class zendesk.chat.PushData: Returns the timestamp in UTC time zone.
getType() - Method in class zendesk.chat.client.ChatLog: Gets the type of this chat log.
getType() - Method in class zendesk.chat.PushData: Returns the type of this push data.
getUrl() - Method in class zendesk.chat.client.Attachment: Returns the URL for this attachment.
getWidth() - Method in class zendesk.chat.client.Attachment.Metadata: Returns the width of the image in pixels.

H

hasFailed(DeliveryStatus) - Static method in enum zendesk.chat.client.DeliveryStatus: Returns true if the request has failed, false otherwise.
hashCode() - Method in class zendesk.chat.client.Account
hashCode() - Method in class zendesk.chat.client.Agent
hashCode() - Method in class zendesk.chat.client.Attachment
hashCode() - Method in class zendesk.chat.client.Attachment.Metadata
hashCode() - Method in class zendesk.chat.client.ChatLog.AttachmentMessage
hashCode() - Method in class zendesk.chat.client.ChatLog.Comment
hashCode() - Method in class zendesk.chat.client.ChatLog
hashCode() - Method in class zendesk.chat.client.ChatLog.Message
hashCode() - Method in class zendesk.chat.client.ChatLog.Rating
hashCode() - Method in class zendesk.chat.client.ChatSettings
hashCode() - Method in class zendesk.chat.client.ChatState
hashCode() - Method in class zendesk.chat.client.Department
hashCode() - Method in class zendesk.chat.client.VisitorInfo

I

init(Context, String) - Method in enum zendesk.chat.Chat: Initializes the Chat SDK.
isChatting() - Method in class zendesk.chat.client.ChatState: Returns true if visitor sent or received a message, false otherwise.
isFileSendingEnabled() - Method in class zendesk.chat.client.ChatSettings: Returns true if file sending is enabled, false otherwise.
isTyping() - Method in class zendesk.chat.client.Agent: Returns true if this agent is typing, false otherwise.

N

NO_QUEUE_POSITION - Static variable in class zendesk.chat.client.ChatState: Value for position denoting that the visitor is not in the queue.

O

ObservationToken<T> - Class in zendesk.chat.client: Defines a token for an Observer that is currently registered to observe updates
observeAccount(Observer<Account>) - Method in interface zendesk.chat.ChatProvider: Observes changes to the Account in real-time.
observeChatSettings(Observer<ChatSettings>) - Method in interface zendesk.chat.SettingsProvider: Registers an observer to be notified when chat settings changes.
observeChatState(Observer<ChatState>) - Method in interface zendesk.chat.ChatProvider: Registers an observer to be notified when chat state changes.
observeConnectionState(Observer<ConnectionState>) - Method in interface zendesk.chat.ConnectionProvider: Registers an observer to be notified when connection state changes.
Observer<T> - Interface in zendesk.chat.client: Defines a mechanism for receiving update notifications when an observable object changes.
OfflineForm - Class in zendesk.chat.client: A form to contact the business when agents are offline.
OfflineForm.Builder - Class in zendesk.chat.client
onProgress(String, long, long) - Method in interface zendesk.chat.client.FileUploadListener: Called while uploading the file to inform about the current progress.

P

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, <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: Sends a request to inform an agent that the visitor wants to chat.
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.

S

selectDepartment(String, <any>) - Method in interface zendesk.chat.ChatProvider: Sends a request to select a department for chatting.
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.
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.
sendTyping(boolean) - Method in interface zendesk.chat.ChatProvider: Sends a request to inform involved agents whether the visitor is currently typing or not.
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.
setVisitorInfo(VisitorInfo) - 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.
Status - Enum in zendesk.chat.client: Represents status of an account or a department.

T

TIMESTAMP_COMPARATOR - Static variable in class zendesk.chat.client.ChatLog: Comparator to sort ChatLogs based on their timestamps.
toString() - Method in class zendesk.chat.client.ChatState
trackVisitorPath(VisitorPath, <any>) - Method in interface zendesk.chat.ProfileProvider: Tracks the current location of the visitor.

U

unregisterPushToken(<any>) - Method in interface zendesk.chat.PushNotificationsProvider: Unregisters the push token in Zendesk Chat backend.
update(T) - Method in interface zendesk.chat.client.Observer: Called when an observable object has been updated.
update(ChatState) - Method in class zendesk.chat.client.ChatStateStore

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.client.ChatLog.Type: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.chat.client.ChatParticipant: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.chat.client.ChatRating: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.chat.client.ConnectionState: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.chat.client.DeliveryStatus: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum zendesk.chat.client.Status: 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.client.ChatLog.Type: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.chat.client.ChatParticipant: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.chat.client.ChatRating: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.chat.client.ConnectionState: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.chat.client.DeliveryStatus: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum zendesk.chat.client.Status: 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.
VisitorInfo - Class in zendesk.chat.client: Holds information about the visitor in the Zendesk Chat system.
VisitorInfo.Builder - Class in zendesk.chat.client: Constructs instances of VisitorInfo.
VisitorPath - Class in zendesk.chat.client: Definition of a visitor path used to track information about visited web pages.

W

withDepartment(String) - Method in class zendesk.chat.client.OfflineForm.Builder: Selects a department to receive the offline form.
withEmail(String) - Method in class zendesk.chat.client.VisitorInfo.Builder: Configures the email of the visitor.
withName(String) - Method in class zendesk.chat.client.VisitorInfo.Builder: Configures the name of the visitor.
withPhoneNumber(String) - Method in class zendesk.chat.client.VisitorInfo.Builder: Configures the phone number of the visitor.
withVisitorInfo(VisitorInfo) - Method in class zendesk.chat.client.OfflineForm.Builder: Provides information about the visitor.

Z

zendesk.chat - package zendesk.chat
zendesk.chat.client - package zendesk.chat.client

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