THEOliveConfiguration

public struct THEOliveConfiguration

Configuration for THEOlive

  • An id used to report usage analytics

    Declaration

    Swift

    public let externalSessionId: String?

  • Override for the discovery URL.

    Declaration

    Swift

    public let discoveryUrl: String?

  • Override for the discovery URL.

    Declaration

    Swift

    public let discoveryUrls: [String]

  • Override (in seconds) for how long HESP is not offered after a HESP source failure/fallback.

    Remark

    • When set, this takes precedence over any value supplied by discovery.
    • A value of nil means no override (discovery decides); a non-positive value disables the cooldown.
    • Intended for testing and validation.

    Declaration

    Swift

    public let hespFallbackCooldown: Double?

  • Create a new instance of THEOliveConfiguration that can be used with THEOliveIntegrationFactory.create()

    Declaration

    Swift

    public init(externalSessionId: String?, discoveryUrl: String? = nil, discoveryUrls: [String] = [], hespFallbackCooldown: Double? = nil)

    Parameters

    externalSessionId

    An id used to report usage analytics. If not explicitly given, a random UUID is used.
    discoveryUrl

    An optional custom discovery endpoint URL for THEOlive, defaults to nil. Takes precedence over discoveryUrls if defined.
    discoveryUrls

    An optional custom discovery endpoint URL list for THEOlive, defaults to [].
    hespFallbackCooldown

    An optional override (in seconds) for the HESP-after-fallback cooldown, defaults to nil (discovery decides).