Creates an instance of MfaPushChallengePush screen manager
Optional on the interface so existing implementors of BaseMembers (e.g. test mocks)
keep compiling. Always populated at runtime by the BaseContext constructor.
StaticscreenUtility FeatureChanges 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.
Language change options including the target language code
Options for changing the language/locale during the authentication flow
Additional custom fields to be submitted along with the language change. Custom fields should be prefixed with 'ulp-'.
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.
A promise that resolves when the form submission is complete
import LoginId from "@auth0/auth0-acul-js/login-id";
const loginManager = new LoginId();
// Change language to French
await loginManager.changeLanguage({
language: 'fr',
persist: 'session'
});
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'
});
Continues with the push notification challenge
Optionalpayload: Screens.WithRememberOptionsOptional custom options to include with the request
Switches to entering the verification code manually
Optionalpayload: Screens.CustomOptionsOptional custom options to include with the request
Utility FeatureStarts 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.
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 Error.A MfaPushPollingControl instance exposing:
startPolling() — Starts or resumes polling.stopPolling() — Cancels polling immediately.isRunning() — Indicates whether polling is currently active.// 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();
Resends the push notification.
Optionalpayload: Screens.WithRememberOptionsOptional rememberDevice flag and custom parameters.
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 on the reloaded page. They don't reject the returned
promise.
Allows trying another authentication method
Optionalpayload: Screens.CustomOptionsOptional custom options to include with the request
Class implementing the mfa-push-challenge-push screen functionality This screen is shown when a user needs to confirm a push notification during MFA