AuthProvider

public class AuthProvider

Uses for initialization [AuthClient] object

  • Undocumented

    Declaration

    Swift

    private var config: Config

  • Undocumented

    Declaration

    Swift

    private var enableSecureStorage: Bool

  • Undocumented

    Declaration

    Swift

    private var authState: OIDAuthState?

  • Undocumented

    Declaration

    Swift

    private var biometricManager: IBiometricManager?

  • Undocumented

    Declaration

    Swift

    private var biometricType: EBiometricType

  • Initialises [AuthProvider] members with default values.

    Declaration

    Swift

    public init()

  • Specifies client id for [AuthClient]

    Declaration

    Swift

    public func withClientId(_ clientId: String) -> AuthProvider

    Parameters

    clientId

    specifies client id.

    Return Value

    AuthProvider object is returned.

  • Specifies client secret for [AuthClient]

    Declaration

    Swift

    public func withClientSecret(_ clientSecret: String) -> AuthProvider

    Parameters

    clientSecret

    specifies client secret.

    Return Value

    AuthProvider object is returned.

  • Specifies domain for [AuthClient]

    Declaration

    Swift

    public func withDomain(_ domain: String) -> AuthProvider

    Parameters

    domain

    specifies domain.

    Return Value

    AuthProvider object is returned.

  • Specifies redirect uri for [AuthClient]

    Declaration

    Swift

    public func withRedirectUri(_ redirectUri: String) -> AuthProvider

    Parameters

    redirectUri

    specifies redirect uri.

    Return Value

    AuthProvider object is returned.

  • Specifies using [SecureStorage]

    Declaration

    Swift

    public func setUseSecureStorage(_ enabled: Bool) -> AuthProvider

    Parameters

    enabled

    specifies secure storage usage.

    Return Value

    AuthProvider object is returned.

  • Specifies initial [AuthState]

    Declaration

    Swift

    public func withAuthState(_ authState: OIDAuthState) -> AuthProvider

    Parameters

    authState

    initial auth state.

    Return Value

    AuthProvider object is returned.

  • Specifies parameters for biometric authentication.

    Declaration

    Swift

    public func setUseBiometric(_ biometricType: EBiometricType, _ biometricManager: IBiometricManager? = nil) -> AuthProvider

    Parameters

    biometricType

    The type of biometric sensor. If biometricType is [BiometricType.ANY], then the biometric user authentication will be required. If biometricType is [BiometricType.NO], the biometric user authentication will not be required;
    biometricManager

    The particular class which implements [IBiometricManager] protocol and handles biometric authentication inside. If no one value for this parameter is specified or nill is passed, then the [BiometricManager] class with default context will be instantiated.

    Return Value

    AuthProvider object is returned.

  • Creates [AuthClient] with provided options.

    Declaration

    Swift

    public func provide(_ providerCallback: IProviderCallback)

    Parameters

    providerCallback

    The callback to invoke after AuthClient creation, it takes [AuthClient] object on success or [APIError] object on failure.

  • Checks that the device supports biometric authentication.

    Declaration

    Swift

    public func isBiometricSupported() -> Bool

    Return Value

    Boolean result, true if the biometric authentication supported, false otherwise.

  • Creates [AuthClient] with provided options.

    Declaration

    Swift

    private func createAuthClient() -> AuthClient

    Return Value

    AuthClient object.