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'
});
import LoginPassword from "@auth0/auth0-acul-js/login-id";
const loginIdManager = new LoginPassword();
// Check if alternateConnections is available and has at least one item
if (!loginIdManager.transaction.alternateConnections) {
console.error('No alternate connections available.');
}
// Select the first available connection (users can select any available connection)
const selectedConnection = alternateConnections[0];
// Log the chosen connection for debugging or informational purposes
console.log(`Selected connection: ${selectedConnection.name}`);
// Proceed with federated login using the selected connection
loginIdManager.federatedLogin({
connection: selectedConnection.name,
});
This method handles switching between DB connection (password) and Passwordless connection (Email/SMS OTP). The connection parameter should be one of: 'email', 'sms', or a DB connection name.
import LoginPassword from "@auth0/auth0-acul-js/login-password";
const loginPasswordManager = new LoginPassword();
// Function to handle connection switching
const handleSwitchConnection = (connectionName: string) => {
loginPasswordManager.switchConnection({ connection: connectionName });
};
// Switch to different connection strategies
handleSwitchConnection('email'); // Switch to email-based authentication
handleSwitchConnection('sms'); // Switch to SMS-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.