AzureCommunicationChatClientOptions Structure Reference


                    
                    
                    apiVersion

The API version of the client to invoke.

Declaration

Swift

public let apiVersion: String


                    
                    
                    logger

The ClientLogger to be used by this client.

Declaration

Swift

public let logger: ClientLogger


                    
                    
                    telemetryOptions

Options for configuring telemetry sent by this client.

Declaration

Swift

public let telemetryOptions: TelemetryOptions


                    
                    
                    transportOptions

Global transport options

Declaration

Swift

public let transportOptions: TransportOptions


                    
                    
                    dispatchQueue

The default dispatch queue on which to call all completion handler. Defaults to DispatchQueue.main.

Declaration

Swift

public let dispatchQueue: DispatchQueue?


                    
                    
                    signalingErrorHandler

The CommunicationSignalingErrorHandler called when signaling errors occur.

Declaration

Swift

public let signalingErrorHandler: CommunicationSignalingErrorHandler?


                    
                    
                    ApiVersion

API version of the to invoke. Defaults to the latest.

Declaration

Swift

public enum ApiVersion : RequestStringConvertible


                    
                    
                    init(apiVersion:logger:telemetryOptions:transportOptions:dispatchQueue:signalingErrorHandler:)

Initialize a AzureCommunicationChatClientOptions structure.

Declaration

Swift

public init(
    apiVersion: AzureCommunicationChatClientOptions.ApiVersion = .latest,
    logger: ClientLogger = ClientLoggers.default(tag: "AzureCommunicationChat"),
    telemetryOptions: TelemetryOptions = TelemetryOptions(),
    transportOptions: TransportOptions? = nil,
    dispatchQueue: DispatchQueue? = nil,
    signalingErrorHandler: CommunicationSignalingErrorHandler? = nil
)

Parameters

`apiVersion`	The API version of the client to invoke.
`logger`	The `ClientLogger` to be used by this client.
`telemetryOptions`	Options for configuring telemetry sent by this client.
`cancellationToken`	A token used to make a best-effort attempt at canceling a request.
`dispatchQueue`	The default dispatch queue on which to call all completion handler. Defaults to `DispatchQueue.main`.
`signalingErrorHandler`	This handler is called if a CommunicationSignalingError occurs.