@auth0/auth0-acul-react - v1.10.0
    Preparing search index...

    Interface MfaVoiceChallengeMembers

    Interface defining all members and operations available on the MFA Voice Challenge screen.

    interface MfaVoiceChallengeMembers {
        branding: BrandingMembers;
        client: ClientMembers;
        countryCodes?: CountryCodesMembers;
        experiment?: ExperimentMembers | null;
        organization: OrganizationMembers;
        prompt: PromptMembers;
        tenant: TenantMembers;
        transaction: TransactionMembers;
        user: UserMembers;
        getErrors(): Error[];
        changeLanguage(options: LanguageChangeOptions): Promise<void>;
        screen: ScreenMembersOnMfaVoiceChallenge;
        untrustedData: UntrustedDataMembersOnMfaVoiceChallenge;
        continue(payload: MfaVoiceChallengeContinueOptions): Promise<void>;
        pickPhone(payload?: CustomOptions): Promise<void>;
        switchToSms(payload?: CustomOptions): Promise<void>;
        resendCode(payload?: CustomOptions): Promise<void>;
        tryAnotherMethod(payload?: CustomOptions): Promise<void>;
        resendManager(options?: StartResendOptions): ResendControl;
    }

    Hierarchy (View Summary)

    Index

    Properties

    branding client countryCodes? experiment? organization prompt tenant transaction user screen untrustedData

    Methods

    getErrors changeLanguage continue pickPhone switchToSms resendCode tryAnotherMethod resendManager

    Properties

    branding: BrandingMembers
    client: ClientMembers
    countryCodes?: CountryCodesMembers

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    experiment?: ExperimentMembers | null

    The active Experiment Center experiment for the current screen, or null when none is active (or the screen has not opted in via context_configuration).

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    organization: OrganizationMembers
    prompt: PromptMembers
    tenant: TenantMembers
    transaction: TransactionMembers
    user: UserMembers
    screen: ScreenMembersOnMfaVoiceChallenge

    Screen-specific properties and data.

    untrustedData: UntrustedDataMembersOnMfaVoiceChallenge

    Methods

    • Returns Error[]

    • Submits the voice verification code to validate the MFA challenge.

      Parameters

      Returns Promise<void>

      Promise that resolves when the code is successfully validated

      const mfaVoiceChallenge = new MfaVoiceChallenge();
      mfaVoiceChallenge.continue({
        code: '123456',
        rememberDevice: true
      });

    • Navigates to the screen for selecting a different phone number.

      Parameters

      Returns Promise<void>

      Promise that resolves when navigation is complete

      const mfaVoiceChallenge = new MfaVoiceChallenge();
      mfaVoiceChallenge.pickPhone();

    • Switches to SMS verification method instead of voice call.

      Parameters

      Returns Promise<void>

      Promise that resolves when switching is complete

      const mfaVoiceChallenge = new MfaVoiceChallenge();
      mfaVoiceChallenge.switchToSms();

    • Requests a new voice call with a verification code.

      Parameters

      • Optionalpayload: CustomOptions

        Optional custom parameters to send with the request.

      Returns Promise<void>

      A promise that resolves once the form is submitted, before the page reloads. It doesn't confirm that a new code was sent.

      Submits a form POST with action: "resend-code". Auth0 responds by rendering this screen again, so the browser reloads the page and the current JavaScript context, including component state and timers, is lost.

      Code after await resendCode() may still run, but anything it sets up, such as a "code sent" message or a countdown, is gone after the reload. Server-side errors, such as rate limits, appear in transaction.errors (or useErrors() in React) on the reloaded page. They don't reject the returned promise.

      To add a cooldown between resends, use resendManager() (or useResend() in React). It stores its countdown in localStorage, so the countdown survives the reload.

    • Navigates to the screen for selecting an alternative MFA method.

      Parameters

      Returns Promise<void>

      Promise that resolves when navigation is complete

      const mfaVoiceChallenge = new MfaVoiceChallenge();
      mfaVoiceChallenge.tryAnotherMethod();

    • Gets resend functionality with timeout management for this screen

      Parameters

      Returns ResendControl

    Settings

    Member Visibility

    On This Page

    Properties
    Methods