StaticscreenUtility FeatureLanguage 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'
});
Utility FeatureGets resend functionality with timeout management for this screen
Optionaloptions: Screens.StartResendOptionsConfiguration options for resend functionality
Options for configuring resend functionality
OptionalonStatusChange?: Screens.OnStatusChangeCallbackOptionalonTimeout?: () => voidOptionaltimeoutSeconds?: numberResendControl object with startResend method
import LoginPasswordlessSmsOtp from '@auth0/auth0-acul-js/login-passwordless-sms-otp';
const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp();
const { startResend } = loginPasswordlessSmsOtp.resendManager({
timeoutSeconds: 15,
onStatusChange: (remainingSeconds, isDisabled) => {
console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
},
onTimeout: () => {
console.log('Resend is now available');
}
});
// Call startResend when user clicks resend button
startResend();
Optionalpayload: Screens.CustomOptionsSwitches from passwordless SMS OTP authentication to a database connection.
The connection switch options
This method allows users to switch from the current passwordless SMS authentication to a traditional database connection that supports username/password authentication.
Common database connection names:
'Username-Password-Authentication' - The default Auth0 database connection'my-custom-db')import LoginPasswordlessSmsOtp from "@auth0/auth0-acul-js/login-passwordless-sms-otp";
const loginPasswordlessSmsOtp = new LoginPasswordlessSmsOtp();
// Function to handle connection switching (pass hardcoded connection name)
const handleSwitchConnection = (connectionName: string) => {
loginPasswordlessSmsOtp.switchConnection({ connection: connectionName });
};
// Switch to different connection strategies (using hardcoded DB connection name)
handleSwitchConnection('Username-Password-Authentication'); // Switch to login-password based authentication
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.