ChatProvidersSDK Documentation

Classes

Chat

Chat is a singleton class of the ChatProviderSDK.

Chat​APIConfiguration

A set of configurations that are associated with each chat session.

Account

The ZDKChatAccount model stores information about the chat account, such as the current accountStatus and the list of Departments associated with the account

Agent

The ZDKAgent model has information about an agent in a chat session, such as their backend id represented as nick, their display name, their avatar, and if they're currently typing.

Chat​Attachment

The ZDKChatAttachment model, contains information about attachments that were sent or received by the visitor.

Chat​Settings

The ZDKChatSettings model stores information about the chat account's settings, such as the fileSizeLimit, whether attachments are enabled, and the list of accepted file extensions.

Chat​State

ZDKChatState is a model representation of the current chat session.

Queue​Position

ZDKQueuePosition is a model that represents the current queue position of the visitor.

Department

Department model contains id associated with the department, the department name, and the current status of the department.

Offline​Form

Offline form is formed from the given fields: visitor info - name, email, phone department - department id message - visitor's message

Chat​Attachment​Message

The Chat Log attachment

Chat​Comment

Chat comment in relation to a Chat rating.

Chat​Log

Base class for chat log events that may occur in a chat session

Chat​Member​Join

Chat Member Join event

Chat​Member​Leave

Chat Member Leave event

Chat​Message

Chat message

Chat​Options​Message

Questions from agent with multiple options that a user can respond with

Chat​Rating

A Chat rating left by the user after an agent requested it. Can be none, good, or bad

Chat​Rating​Request

Chat Rating Request (sent by the agent)

Visitor​Info

Visitor information that can be seen in the Chat dashboard Contains name, email, and phoneNumber

Visitor​Path

A Custom Update Event that can be seen in the agent dashboard.

Chat​Info

ZDKChatInfo contains information about the chat session, such as if there is a chat ongoing.

Logger
Push​Notification​Data

PushNotificationData can be used to gather information about Chat related push notifications

Account​Provider

ZDKChatAccountProvider gives the ability to observe account updates.

Chat​Provider

The ZDKChatProvider provides APIs to interact and observe the current Chat session.

Connection​Provider

ZDKConnectionProvider gives the ability to observe connection updates.

Profile​Provider

The ZDKProfileProvider contain APIs to update information about a visitor. Such as name, email, phone number, tags, and notes related to the visitor and their session.

Providers

ZDKChatProviders is a grouping of all the providers that allow you to, setup for push notifications, handle session updates, handle connection state, and interact with the APIs in other ways.

Push​Notifications​Provider

The ZDKPushNoticiationProvider provides APIs to subscribe to, and handle Zendesk Chat's Push Notifications.

Settings​Provider

ZDKSettingsProvider gives the ability to observe settings updates.

Structures

Debug​Logger

Enumerations

Delivery​Status

Delivery Status of the ChatLog

Delivery​Status​Error

Delivery status error describes the reason of a delivery failure

ZDKDelivery​Status

Delivery Status of the ChatLog

Chat​Error

Potential errors returned from the ChatProviderSDK

Account​Status

Account Status

Chat​Attachment​Error

The error of type ChatAttachmentError is emitted when file upload has failed.

Rating

A rating that can be assigned to the chat

ZDKRating

A rating that can be assigned to the chat

Chat​Log​Type

An enum of the message types that can be in sent/received in a chat session

Department​Status

The status of the department.

ZDKDepartment​Status
Chat​Participant

Who sent the message can be user/agent/trigger

Authentication​Error​Code

Possible Authentication related error codes

Authentication​Error

Possible Authentication related errors

Chat​Session​Status

Chat session status describes current state of the session

Connection​Status

Represents different states of theChatSession

Log​Level
Push​Notification​Data.​Push​Notification​Type

Enum representing the different types of notifications that can be received for Chat

Protocols

Chat​Form
Chat​Log​Protocol

Base protocol representation of a ChatLog

JWTAuthenticator

Protocol that an object that handles authentication should conform to. Called by the ChatSDK everytime authentication is required.

Log
Logger​Factory
Loggable

Protocol that conforms