SignInVerifyCodeDelegate

@objc
public protocol SignInVerifyCodeDelegate

Protocol that defines the methods of a SignInVerifyCode delegate

  • Notifies the delegate that the operation resulted in an error.

    Declaration

    Swift

    @MainActor
    func onSignInVerifyCodeError(error: VerifyCodeError, newState: SignInCodeRequiredState?)

    Parameters

    error

    An error object indicating why the operation failed.

    newState

    An object representing the new state of the flow with follow on methods.

  • Notifies the delegate that a multi factor authentication (MFA) is required from the user to continue.

    Note

    If a flow requires this optional method and it is not implemented, then onSignInVerifyCodeError(error:) will be called.

    Declaration

    Swift

    @MainActor
    @objc
    optional func onSignInAwaitingMFA(authMethods: [MSALAuthMethod], newState: AwaitingMFAState)

    Parameters

    authMethods

    The list of available authentication methods for MFA.

    newState

    An object representing the new state of the flow with follow on methods.

  • Notifies the delegate that a registration of a strong authentication method is required to continue.

    Note

    If a flow requires this optional method and it is not implemented, then onSignInVerifyCodeError(error:) will be called.

    Declaration

    Swift

    @MainActor
    @objc
    optional func onSignInStrongAuthMethodRegistration(authMethods: [MSALAuthMethod], newState: RegisterStrongAuthState)

    Parameters

    authMethods

    The list of available authentication methods for registration.

    newState

    An object representing the new state of the flow with follow on methods.

  • Notifies the delegate that the sign in operation completed successfully.

    Note

    If a flow requires this optional method and it is not implemented, then onSignInVerifyCodeError(error:newState:) will be called.

    Declaration

    Swift

    @MainActor
    @objc
    optional func onSignInCompleted(result: MSALNativeAuthUserAccountResult)

    Parameters

    result

    An object representing the signed in user account.