Classes

ChatEngine is the access point for the UI of the Chat SDK. It is the ChatEngine.

Configuration class to modify the behaviour of the Chat UI such as forms, and ChatMenuActions

This can be passed into the Messaging.buildUI(engines:configs:) method.

Configuration object used to gather the desired requirements for a Chat form.

Chat is a singleton class of the ChatProviderSDK.

It needs to be intialized with an accountKey before using any of the Chat APIs. The accountKey can be retrieved from the Zendesk Chat dashboard.

Chat.initialize(accountKey: accountKey)

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

Default values

visitorPathOne = nil // "Direct Path"
visitorPathTwo = "Zendesk Chat SDK v\(VersionNumber)"
visitorPathTwoValue = nil
tags = []
department = nil
visitorInfo = nil

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

ZDKChatAccountProvider gives the ability to observe account updates.

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

It provides APIs to:

• proactively request a chat
• send messages
• handle failed messages (retry/delete)
• set the visitors’ typing indicator
• end the chat

ZDKConnectionProvider gives the ability to observe connection updates.

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.

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.

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

There are two types of chat notifications:

• chat.msg - received when a new chat message was sent from an agent
• chat.end - received when the current chat session ends.

ZDKSettingsProvider gives the ability to observe settings updates.

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

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.

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

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.

ZDKChatState is a model representation of the current chat session.

Can gather information about the agents in the session, the visitor’s queuePosition, what status the chat is in, and the list of logs in the session

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

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

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

The Chat Log attachment

Chat comment in relation to a Chat rating.

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

Different LogTypes

• ChatMessage, ChatAttachment, ChatMemberJoin, ChatMemberLeave

Chat Member Join event

Chat Member Leave event

Chat message

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

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

Chat Rating Request (sent by the agent)

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

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

The VisitorPath API is a way to know if visitors have performed certain events in your app. VisitorPath events can be queued before a chat has started, and they’ll be sent when the first message is sent.

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

Singleton access point for logging, inject a LoggerFactory to specify the Logger.

A convenience wrapper for the ObservationToken, that can be used alongside the ObserveBehaviours class

A convenience wrapper for a collection of ObserveBehaviours.

Unsubscribe from observers