@auth0/auth0-acul-js - v1.10.0
    Preparing search index...

    Class MfaCountryCodes

    Class implementing the mfa-country-codes screen functionality This screen allows users to select a country code for MFA phone number verification

    Hierarchy

    • BaseContext
      • MfaCountryCodes

    Implements

    Index

    Constructors

    constructor

    Properties

    branding client countryCodes experiment organization prompt screen tenant transaction untrustedData user screenIdentifier

    Methods - Language

    changeLanguage

    Methods - Other

    getErrors goBack selectCountryCode

    Constructors

    Properties

    branding: Screens.BrandingMembers
    client: Screens.ClientMembers
    countryCodes: Screens.CountryCodesMembers

    Optional on the interface so existing implementors of BaseMembers (e.g. test mocks) keep compiling. Always populated at runtime by the BaseContext constructor.

    experiment: Screens.ExperimentMembers | null
    organization: Screens.OrganizationMembers
    prompt: Screens.PromptMembers
    screen: Screens.ScreenMembersOnMfaCountryCodes
    tenant: Screens.TenantMembers
    transaction: Screens.TransactionMembers
    untrustedData: Screens.UntrustedDataMembers
    user: Screens.UserMembers
    screenIdentifier: string = ScreenIds.MFA_COUNTRY_CODES

    Methods - Language

    • 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.

          'session'

      Returns Promise<void>

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

    Methods - Other

    • Selects a country code from the available options

      Parameters

      Returns Promise<void>

      import MfaCountryCodes from '@auth0/auth0-acul-js/mfa-country-codes';

      const mfaCountryCodes = new MfaCountryCodes();

      // Get the available country codes and phone prefixes
      const { screen } = mfaCountryCodes;
      const { phone_prefixes } = screen.data
      const {country_code, phone_prefix} = phone_prefixes[0]

      await mfaCountryCodes.selectCountryCode({
        country_code: 'US',
        phone_prefix: '+1',
      });

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods - Language
    Methods - Other