@auth0/auth0-acul-react - v1.9.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>

    • 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