View on GitHub
CXoneChat
public class CXoneChat : ChatProvider, EventReceiverThe implementation of the interface for interacting with chat features of the CXone platform.
-
The version of the CXone chat SDK.
Declaration
Swift
public static var version: String -
The singleton instance of the CXone chat SDK.
Declaration
Swift
public static var shared: ChatProvider
-
The handler for the chat events.
Declaration
Swift
@available(*, deprecated, message: "Deprecated with 2.2.0 Please use add(delegate:﹚") public weak var delegate: CXoneChatDelegate? { get set } -
The handler for the logs occured in CXoneChat.
Declaration
Swift
public weak var logDelegate: LogDelegate? { get set } -
Current chat state of the SDK
The state defines if the SDK is prepared for API services (analytics), connected for chat features or if it needs to be prepared or connected for proper usage.
Declaration
Swift
public var state: ChatState { get } -
Chat mode defining available functionality.
Declaration
Swift
public var mode: ChatMode { get }
-
The provider for connection related properties and methods.
Declaration
Swift
public let connection: ConnectionProvider -
The provider for customer related properties and methods.
Declaration
Swift
public let customer: CustomerProvider -
The provider for customer chat fields related properties and methods.
Declaration
Swift
public let customerCustomFields: CustomerCustomFieldsProvider -
The provider for thread related properties and methods.
Declaration
Swift
public let threads: ChatThreadsProvider -
The provider for report related properties and methods.
Declaration
Swift
public let analytics: AnalyticsProvider
-
Add a
CXoneChatDelegateFuture delegate messages will be routed to the newly added delegate.
Note: No strong reference to the delegate is maintained so the caller is responsible for its lifecycle.
Declaration
Swift
public func add(delegate: CXoneChatDelegate) -
Remove a
CXoneChatDelegate`No future delegate messages will be routed to the removed delegate.
Declaration
Swift
public func remove(delegate: CXoneChatDelegate)
-
Signs the customer out and disconnects from the CXone service.
Declaration
Swift
public static func signOut() -
Configures internal logger to be able to detect errors, warnings or even trace chat flow.
Declaration
Swift
public static func configureLogger(level: LogManager.Level, verbosity: LogManager.Verbosity)Parameters
levelSpecifies level of records to be presented in the console. Lower levels are ignored.
verbositorySpecifies verbosity of information in the log record.