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

    Interface MfaPushChallengePushMembers

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

    interface MfaPushChallengePushMembers {
        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: ScreenMembersOnMfaPushChallengePush;
        untrustedData: UntrustedDataMembersOnMfaPushChallengePush;
        continue(payload?: WithRememberOptions): Promise<void>;
        resendPushNotification(payload?: WithRememberOptions): Promise<void>;
        enterCodeManually(payload?: CustomOptions): Promise<void>;
        tryAnotherMethod(payload?: CustomOptions): Promise<void>;
        pollingManager(options: MfaPollingOptions): MfaPushPollingControl;
    }

    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

    Methods

    • Returns Error[]

    • Continues with the push notification challenge

      Parameters

      Returns Promise<void>

    • Resends the push notification.

      Parameters

      Returns Promise<void>

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

      Submits a form POST with action: "resend". Auth0 sends a new push notification and renders this screen again. The browser reloads the page, and the current JavaScript context, including component state, timers, and active polling, is lost.

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

    • Switches to entering the verification code manually

      Parameters

      • Optionalpayload: CustomOptions

        Optional custom options to include with the request

      Returns Promise<void>

    • Allows trying another authentication method

      Parameters

      • Optionalpayload: CustomOptions

        Optional custom options to include with the request

      Returns Promise<void>