Chat

@objc(ZDKChat)
public final class Chat : NSObject, Loggable

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)

NotificationMessageReceived
Called when Chat receives push notification with message
Declaration
Swift

@objc public static let NotificationMessageReceived: NSNotification.Name
NotificationChatEnded
This notification is called when Chat session did end
Declaration
Swift

@objc public static let NotificationChatEnded: NSNotification.Name
NotificationAuthenticationFailed
This notification is called when the user authentication failed.
Declaration
Swift

@objc public static let NotificationAuthenticationFailed: NSNotification.Name
accountKey
Account key
Declaration
Swift

@objc public let accountKey: String
appId
App id
Declaration
Swift

@objc public let appId: String?


                    
                    
                    providers

Grouping of Zendesk Chat’s providers

Declaration

Swift

@objc
public internal(set) var providers: Providers { get }

instance
Static instance of the Chat provider
Declaration
Swift

@objc public static var instance: Chat? { get }
configuration
Set configuration to start Chat with pre-configured department, visitorInfo and tags.

Note
Department can be changed only before the Chat has started. Changing the department during the ongoing Chat is not allowed.
Declaration
Swift

@objc public var configuration: ChatAPIConfiguration { get set }

Static Providers

configuration
Set configuration to start Chat with pre-configured department, visitorInfo and tags.

Note
Department can be changed only before the Chat has started. Changing the department during the ongoing Chat is not allowed.
Declaration
Swift

@objc public static var configuration: ChatAPIConfiguration { get }
hasIdentity
Whether a user is authenticated.
Declaration
Swift

@objc public static var hasIdentity: Bool { get }


                    
                    
                    accountProvider

Account Provider

Declaration

Swift

@objc
public static var accountProvider: AccountProvider? { get }


                    
                    
                    connectionProvider

Connection Provider

Declaration

Swift

@objc
public static var connectionProvider: ConnectionProvider? { get }


                    
                    
                    profileProvider

Profile Provider

Declaration

Swift

@objc
public static var profileProvider: ProfileProvider? { get }


                    
                    
                    pushNotificationsProvider

Push Notifications Provider

Declaration

Swift

@objc
public static var pushNotificationsProvider: PushNotificationsProvider? { get }


                    
                    
                    chatProvider

Chat Provider

Declaration

Swift

@objc
public static var chatProvider: ChatProvider? { get }


                    
                    
                    settingsProvider

Settings Provider

Declaration

Swift

@objc
public static var settingsProvider: SettingsProvider? { get }

Providers

hasIdentity
Whether a user is authenticated.
Declaration
Swift

@objc public var hasIdentity: Bool { get }


                    
                    
                    accountProvider

Account Provider

Declaration

Swift

@objc
public var accountProvider: AccountProvider { get }


                    
                    
                    connectionProvider

Connection Provider

Declaration

Swift

@objc
public var connectionProvider: ConnectionProvider { get }


                    
                    
                    pushNotificationsProvider

Push Notifications Provider

Declaration

Swift

@objc
public var pushNotificationsProvider: PushNotificationsProvider { get }


                    
                    
                    profileProvider

Profile Provider

Declaration

Swift

@objc
public var profileProvider: ProfileProvider { get }


                    
                    
                    chatProvider

Chat Provider

Declaration

Swift

@objc
public var chatProvider: ChatProvider { get }


                    
                    
                    settingsProvider

Settings Provider

Declaration

Swift

@objc
public var settingsProvider: SettingsProvider { get }


                    
                    
                    initialize(accountKey:appId:queue:)

Initializes chat with Chat’s accountkey

Declaration

Swift

@objc
public class func initialize(accountKey: String, appId: String? = nil, queue: DispatchQueue = .main)

Parameters

`accountKey`	The accountKey from your chat instance
`appId`	The app id
`queue`	the queue to dispatch chat operations on. Default is `.main`

Cache

clearCache()
Clears the cache Call this method when leaving the conversation screen
Declaration
Swift

@objc public func clearCache()


                    
                    
                    setIdentity(authenticator:)

Set the authenticated user’s identity

Declaration

Swift

@objc
public func setIdentity(authenticator: JWTAuthenticator)

Parameters


                                authenticator

Instance of the class that conforms to JWTAuthenticator protocol

resetIdentity(_:)
Resets the visitor data to a clean state allowing a new visitor to chat

Any ongoing chat will be ended, and locally stored information about the visitor will be cleared, including the registered push token. Make sure to re-register for push notifications as needed.
Declaration
Swift

@objc public func resetIdentity(_ completion: (() -> Void)? = nil)


                    
                    
                    resetIdentity()

Resets the visitor data to a clean state allowing a new visitor to chat

Declaration

Swift

@available(*, deprecated, message: "Please use `resetIdentity(_ completion: ((﹚ -> Void﹚?﹚` instead")
@objc
public func resetIdentity()

Push Notifications


                    
                    
                    registerPushToken(_:)

Sends push token to server

Declaration

Swift

@objc
public class func registerPushToken(_ pushTokenData: Data)

Parameters


                                pushTokenData

device token received in didRegisterForRemoteNotificationsWithDeviceToken after registration


                    
                    
                    registerPushTokenString(_:)

Sends push token to server

Declaration

Swift

@objc
public class func registerPushTokenString(_ pushTokenString: String)

Parameters


                                pushTokenString

device token received in didRegisterForRemoteNotificationsWithDeviceToken after registration


                    
                    
                    didReceiveRemoteNotification(_:in:)

Pass the received remote notification to didReceiveRemoteNotification. If the push notification belongs to Zendesk Chat, the push notification will be processed accordingly

There are currently two types of supported Push Notifications:

New chat message
- This event happens, when there’s new message typed by an agent. In order to respond to this event, you can observe the notification with name PushNotificationsProvider.ChatMessageReceivedNotification in NotificationCenter.
Chat has ended
- When this event is received, the Chat will be ended and the chat session will be disconnected In order to respond to this event, you can observe the notification with name Chat.NotificationChatEnded in NotificationCenter.

Declaration

Swift

@objc
public class func didReceiveRemoteNotification(_ userInfo: [AnyHashable : Any], in application: UIApplication)

Parameters

`userInfo`	A dictionary that contains information related to the remote notification
`application`	The centralized point of control and coordination for apps running in iOS.