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

    Interface MfaEmailChallengeMembers

    Interface defining the available methods and properties for the mfa-email-challenge screen

    interface MfaEmailChallengeMembers {
        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: ScreenMembersOnMfaEmailChallenge;
        untrustedData: UntrustedDataMembersOnMfaEmailChallenge;
        continue(payload: ContinuePayloadOptions): Promise<void>;
        resendCode(payload?: ResendCodePayloadOptions): Promise<void>;
        tryAnotherMethod(payload?: TryAnotherMethodPayloadOptions): Promise<void>;
        pickEmail(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 resendCode tryAnotherMethod pickEmail 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: ScreenMembersOnMfaEmailChallenge
    untrustedData: UntrustedDataMembersOnMfaEmailChallenge

    Methods

    • Returns Error[]

    • Continues with the email challenge using the provided code

      Parameters

      Returns Promise<void>

    • Resends the email code.

      Parameters

      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.

    • Allows the user to try another MFA method

      Parameters

      Returns Promise<void>

    • Submits the action to pick a different Email configuration, if available

      Parameters

      • Optionalpayload: CustomOptions

        Optional custom options to include with the request

      Returns Promise<void>

    • Gets resend functionality with timeout management for this screen

      Parameters

      Returns ResendControl

    Settings

    Member Visibility

    On This Page

    Properties
    Methods