SignInStartDelegate

@objc
public protocol SignInStartDelegate

Protocol that defines the methods of a SignInStart delegate

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

    Declaration

    Swift

    @MainActor
func onSignInStartError(error: SignInStartError)

    Parameters

    error

    An error object indicating why the operation failed.

  • Notifies the delegate that a verification code is required from the user to continue.

    Note

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

    Declaration

    Swift

    @MainActor
@objc
optional func onSignInCodeRequired(newState: SignInCodeRequiredState,
                                   sentTo: String,
                                   channelTargetType: MSALNativeAuthChannelType,
                                   codeLength: Int)

    Parameters

    newState

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

    The email/phone number that the code was sent to.
    channelTargetType

    The channel (email/phone) the code was sent through.
    codeLength

    The length of the code required.

  • Notifies the delegate that a password is required from the user to continue.

    Note

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

    Declaration

    Swift

    @MainActor
@objc
optional func onSignInPasswordRequired(newState: SignInPasswordRequiredState)

    Parameters

    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 onSignInStartError(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 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 onSignInStartError(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 the sign in operation completed successfully.

    Note

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

    Declaration

    Swift

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

    Parameters

    result

    An object representing the signed in user account.