Class ResetPasswordMfaPushChallengePush

Class representing the reset-password-mfa-push-challenge-push screen functionality This screen is shown when a push notification has been sent to the user's device during password reset

Hierarchy

BaseContext
- ResetPasswordMfaPushChallengePush

Implements

Screens.ResetPasswordMfaPushChallengePushMembers

Index

Constructors

constructor

new ResetPasswordMfaPushChallengePush(): ResetPasswordMfaPushChallengePush
Returns ResetPasswordMfaPushChallengePush
Overrides BaseContext.constructor
- Defined in src/screens/reset-password-mfa-push-challenge-push/index.ts:25

Properties

branding

branding: Screens.BrandingMembers

client

client: Screens.ClientMembers

organization

organization: Screens.OrganizationMembers

prompt

prompt: Screens.PromptMembers

screen

screen: Screens.ScreenMembersOnResetPasswordMfaPushChallengePush

tenant

tenant: Screens.TenantMembers

transaction

transaction: Screens.TransactionMembers

untrustedData

untrustedData: Screens.UntrustedDataMembers

user

user: Screens.UserMembers

`Static`screenIdentifier

screenIdentifier: string = ScreenIds.RESET_PASSWORD_MFA_PUSH_CHALLENGE_PUSH

Methods - Language

changeLanguage

changeLanguage(options: Screens.LanguageChangeOptions): Promise<void>
Utility Feature
Changes the language/locale for the current authentication flow.

This method triggers a language change by submitting the new locale preference to the server with the 'change-language' action. The language change will cause the current screen to re-render with the new locale.
Parameters
- options: Screens.LanguageChangeOptions
  Language change options including the target language code
  
  Options for changing the language/locale during the authentication flow
  - [key: string]: string | number | boolean | undefined
    Additional custom fields to be submitted along with the language change. Custom fields should be prefixed with 'ulp-'.
  - language: string
    Short language name (locale code) to be set (e.g., 'en', 'fr', 'es').
  - Optionalpersist?: "session"
    Defines persistence scope for the language preference. Currently only 'session' is supported.
    
    Default
    'session'
Returns Promise<void>
A promise that resolves when the form submission is complete
Example
```
import LoginId from "@auth0/auth0-acul-js/login-id";

const loginManager = new LoginId();

// Change language to French
await loginManager.changeLanguage({
  language: 'fr',
  persist: 'session'
});
```
Example
```
import LoginPassword from "@auth0/auth0-acul-js/login-password";

const loginPasswordManager = new LoginPassword();

// Change language to Spanish with additional custom data
await loginPasswordManager.changeLanguage({
  language: 'es',
  persist: 'session',
  'ulp-custom-field': 'custom-value'
});
```
Remarks
- This method is available on all screen instances that extend BaseContext
- The language must be one of the enabled locales configured in your Auth0 tenant
- The screen will automatically re-render with the new language after submission
- Custom fields can be included and will be accessible in the Post Login Trigger
Implementation of ResetPasswordMfaPushChallengePushMembers.changeLanguage
Inherited from BaseContext.changeLanguage
- Defined in src/models/base-context.ts:156

Methods - Other

continue

continue(payload?: Screens.CustomOptions): Promise<void>
Continues with the push notification challenge
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional custom options to include with the request
Returns Promise<void>
Example
```
import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';

const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush();
await resetPasswordMfaPushChallengePush.continue();
```
Implementation of ResetPasswordMfaPushChallengePushMembers.continue
- Defined in src/screens/reset-password-mfa-push-challenge-push/index.ts:42

enterCodeManually

enterCodeManually(payload?: Screens.CustomOptions): Promise<void>
Switches to entering the verification code manually
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional custom options to include with the request
Returns Promise<void>
Example
```
import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';

const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush();
await resetPasswordMfaPushChallengePush.enterCodeManually();
```
Implementation of ResetPasswordMfaPushChallengePushMembers.enterCodeManually
- Defined in src/screens/reset-password-mfa-push-challenge-push/index.ts:83

getErrors

getErrors(): Screens.Error[]
Retrieves the array of transaction errors from the context, or an empty array if none exist.

Returns Screens.Error[]
An array of error objects from the transaction context.
Implementation of ResetPasswordMfaPushChallengePushMembers.getErrors
Inherited from BaseContext.getErrors
- Defined in src/models/base-context.ts:103

pollingManager

pollingManager(
options?: Screens.MfaPollingOptions,
): Screens.MfaPushPollingControl
Utility Feature
Starts and manages polling for an MFA push challenge.

Creates a polling session that repeatedly checks the MFA push challenge endpoint at the specified interval until the challenge is approved or an error occurs. When the approval condition is met, the provided onCompleted callback is invoked and polling stops automatically.

Use the returned MfaPushPollingControl to start, stop, or check the status of the polling process at any time.
Parameters
- options: Screens.MfaPollingOptions = {}
  Configuration options for the polling process:
  
  intervalMs — Optional polling interval in milliseconds (defaults to SDK’s internal value, typically 5000 ms).
  
  onCompleted — Optional callback fired when the MFA push is successfully approved.
  
  onError — Optional callback fired when a polling error occurs, receiving an ULError.
Returns Screens.MfaPushPollingControl
A MfaPushPollingControl instance exposing:
- startPolling() — Starts or resumes polling.
- stopPolling() — Cancels polling immediately.
- isRunning() — Indicates whether polling is currently active.
Example
```
// Start polling every 5 seconds until the push challenge is approved
const control = mfaPushChallengePush.pollingManager({
  intervalMs: 5000,
  onCompleted: () => mfaPushChallengePush.continue(),
  onError: (error) => console.error('Polling error:', error),
});

// Later, cancel polling if needed
control.stopPolling();
```
Remarks
- HTTP 429 (rate limit) responses are handled internally: polling automatically waits until the rate limit resets before retrying.
- Safe to call startPolling() multiple times; it has no effect if already running.
Implementation of ResetPasswordMfaPushChallengePushMembers.pollingManager
- Defined in src/screens/reset-password-mfa-push-challenge-push/index.ts:158

resendPushNotification

resendPushNotification(payload?: Screens.CustomOptions): Promise<void>
Re-sends the push notification
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional custom options to include with the request
Returns Promise<void>
Example
```
import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';

const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush();
await resetPasswordMfaPushChallengePush.resendPushNotification();
```
Implementation of ResetPasswordMfaPushChallengePushMembers.resendPushNotification
- Defined in src/screens/reset-password-mfa-push-challenge-push/index.ts:61

tryAnotherMethod

tryAnotherMethod(payload?: Screens.CustomOptions): Promise<void>
Allows trying another authentication method
Parameters
- Optionalpayload: Screens.CustomOptions
  Optional custom options to include with the request
Returns Promise<void>
Example
```
import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';

const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush();
await resetPasswordMfaPushChallengePush.tryAnotherMethod();
```
Implementation of ResetPasswordMfaPushChallengePushMembers.tryAnotherMethod
- Defined in src/screens/reset-password-mfa-push-challenge-push/index.ts:105

Class ResetPasswordMfaPushChallengePush

Hierarchy

Implements

Index

Constructors

Properties

Methods - Language

Methods - Other

Constructors

constructor

Returns ResetPasswordMfaPushChallengePush

Properties

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

StaticscreenIdentifier

Methods - Language

changeLanguage

Parameters

[key: string]: string | number | boolean | undefined

language: string

Optionalpersist?: "session"

Default

Returns Promise<void>

Example

Example

Remarks

Methods - Other

continue

Parameters

Returns Promise<void>

Example

enterCodeManually

Parameters

Returns Promise<void>

Example

getErrors

Returns Screens.Error[]

pollingManager

Parameters

Returns Screens.MfaPushPollingControl

Example

Remarks

resendPushNotification

Parameters

Returns Promise<void>

Example

tryAnotherMethod

Parameters

Returns Promise<void>

Example

Settings

On This Page

`Static`screenIdentifier

`Optional`persist?: "session"