Class LogoutAborted

branding

client

organization

prompt

screen

tenant

transaction

untrustedData

user

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'
      Copy

  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'
  });
  Copy

  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'
  });
  Copy

  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

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.