Configuration

public struct Configuration : Hashable

The SDK configuration object.

  • The account unique identifier (8x8_test, etc).

    Declaration

    Swift

    public var accountId: String

  • The user unique identifier (user01, user02, etc).

    Declaration

    Swift

    public var userId: String

  • The user display name. The remote peer will see this name on the incoming call screen.

    Declaration

    Swift

    public var displayName: String

  • The mobile device phone number (if available).

    Declaration

    Swift

    public var phoneNumber: String?

  • The CallKit configuration options (application name, ringtone, etc).

    Declaration

    Swift

    public var callKit: CallKitOptions

  • The client application bundle id.

    Declaration

    Swift

    public var appBundleId: String

  • The push environment (sandbox or production) to be used for sending push notification to this device.

    Note

    When an iOS application is code signed, it is the embedded Provisioning Profile that will specify which Apple Push Notification Service Environment (APS Environment) the acquired push notification device token will be bound to. Depending on how an application is provisioned it has an effect on what should be set to pushEnvironment property. For example if your application is signed with a Development provisioning profile it will be bound to the APS Development environment. If it’s code signed with a Distribution provisioning profile it will be bound to the APS Production environment.

    Declaration

    Swift

    public var pushEnvironment: PushNotificationEnvironment?

  • The inbound call path (voip, pstn, voipWithFallbackToPSTN) to be used for routing the incoming call to this device.

    Declaration

    Swift

    public var inboundCallPath: InboundCallPath

  • The service API url.

    Declaration

    Swift

    public var serviceUrl: String

  • Declaration

    Swift

    public init(accountId: String,
            userId: String,
            displayName: String,
            phoneNumber: String?,
            callKit: CallKitOptions,
            appBundleId: String,
            pushEnvironment: PushNotificationEnvironment?,
            inboundCallPath: InboundCallPath,
            serviceUrl: String)