ChannelConfiguration

public struct ChannelConfiguration

The various options for how a channel is configured.

Properties

  • Whether the channel supports multiple threads for the same user.

    Declaration

    Swift

    public let hasMultipleThreadsPerEndUser: Bool

  • Whether the channel supports proactive chat features.

    Declaration

    Swift

    public let isProactiveChatEnabled: Bool

  • Whether OAuth authorization is enabled for the channel.

    Declaration

    Swift

    public let isAuthorizationEnabled: Bool

  • Indicates whether the Send Transcript feature is enabled for the channel.

    Declaration

    Swift

    public let isSendTranscriptEnabled: Bool

  • Details of attachment uploads allowed.

    Declaration

    Swift

    public let fileRestrictions: FileRestrictions

  • Currently handled features.

    If the feature is no longer listed, it is by default on.

    Declaration

    Swift

    public let features: [String : Bool]

  • Whether the service is available.

    Declaration

    Swift

    public let isOnline: Bool

  • Whether the channel is liveChat vs messaging

    Declaration

    Swift

    public let isLiveChat: Bool

  • The authentication type for this channel.

    Determines which authentication method to use when connecting to this channel.

    Declaration

    Swift

    public let authenticationType: AuthenticationType

Init

  • Creates a new channel configuration with the provided options and capabilities.

    Declaration

    Swift

    public init(
    hasMultipleThreadsPerEndUser: Bool,
    isProactiveChatEnabled: Bool,
    isAuthorizationEnabled: Bool,
    isSendTranscriptEnabled: Bool,
    fileRestrictions: FileRestrictions,
    features: [String: Bool],
    isOnline: Bool,
    isLiveChat: Bool,
    authenticationType: AuthenticationType
)

    Parameters

    hasMultipleThreadsPerEndUser

    Whether the channel supports multiple concurrent threads for the same end user.
    isProactiveChatEnabled

    Indicates if proactive chat features are enabled.
    isAuthorizationEnabled

    Indicates if OAuth-based authorization is required/enabled for the channel.
    isSendTranscriptEnabled

    Whether the Send Transcript feature is enabled.
    fileRestrictions

    Constraints describing allowed uploads for this channel.
    features

    A dictionary of feature flags currently handled by the client; if a feature is not present, it is considered on by default.
    isOnline

    Whether the service is currently available.
    isLiveChat

    Whether the channel operates as live chat (as opposed to messaging).
    authenticationType

    The authentication method required for this channel.