ChatAPIConfiguration

@objc(ZDKChatAPIConfiguration)
public final class ChatAPIConfiguration : NSObject

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

  • This string will be placed in the first line of the visitor path. Defaults to “Direct Path” if not specified.

    Declaration

    Swift

    @objc
public var visitorPathOne: String?

  • This string will be placed in the second line of the visitor path. Defaults to “Zendesk Chat SDK v(ChatProvidersSDKVersionNumber)”

    Declaration

    Swift

    @objc
public var visitorPathTwo: String

  • This string can be found when hovering over the second line of the visitor path.

    Declaration

    Swift

    @objc
public var visitorPathTwoValue: String?

  • The tags to be set when a chat starts.

    Declaration

    Swift

    @objc
public var tags: [String]

  • The department to be set when a chat starts. default is nil

    Declaration

    Swift

    @objc
public var department: String?

  • Set the visitor info. Default is nil. Pass through fields as empty strings to clear info.

    Declaration

    Swift

    @objc
public var visitorInfo: VisitorInfo?

  • Default initializer

    Declaration

    Swift

    @objc
override public init()

  • Returns a Boolean value that indicates whether the receiver and a given object are equal.

    Declaration

    Swift

    @objc
override public func isEqual(_ object: Any?) -> Bool

    Parameters

    object

    the object to compare against