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

    Interface PhoneIdentifierChallengeMembers

    interface PhoneIdentifierChallengeMembers {
        branding: BrandingMembers;
        client: ClientMembers;
        countryCodes?: CountryCodesMembers;
        experiment?: ExperimentMembers | null;
        organization: OrganizationMembers;
        prompt: PromptMembers;
        tenant: TenantMembers;
        transaction: TransactionMembers;
        user: UserMembers;
        untrustedData: UntrustedDataMembers;
        getErrors(): Error[];
        changeLanguage(options: LanguageChangeOptions): Promise<void>;
        screen: ScreenMembersOnPhoneIdentifierChallenge;
        submitPhoneChallenge(payload: PhoneChallengeOptions): Promise<void>;
        resendCode(payload?: CustomOptions): Promise<void>;
        resendManager(options?: StartResendOptions): ResendControl;
        returnToPrevious(payload?: CustomOptions): Promise<void>;
        switchToVoice(payload?: CustomOptions): Promise<void>;
        switchToText(payload?: CustomOptions): Promise<void>;
        switchToPassword(payload?: CustomOptions): Promise<void>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    branding: BrandingMembers
    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
    transaction: TransactionMembers
    untrustedData: UntrustedDataMembers

    Methods

    • Returns Error[]

    • Parameters

      Returns Promise<void>

    • Requests a new verification code for the user's phone number.

      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 new page loads. 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, or the interstitial-captcha screen if a captcha is required. Either way the browser loads a new 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. It also disables resending when screen.data.resendLimitReached is true.

    • Parameters

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

      Returns Promise<void>

    • Parameters

      Returns Promise<void>