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

    Class Confirmation

    Class implementing the Confirmation screen functionality. This screen allows users to confirm or decline auto-signup after OTP verification.

    Hierarchy

    • BaseContext
      • Confirmation

    Implements

    Index

    Constructors

    constructor

    Properties

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

    Methods - Language

    changeLanguage

    Methods - Other

    getErrors goBack proceedToSignup

    Constructors

    • Creates an instance of the Confirmation screen.

      Returns Confirmation

      If the Universal Login Context is not available or if the current screen name in the context does not match Confirmation.screenIdentifier.

    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.ScreenMembers
    tenant: Screens.TenantMembers
    transaction: Screens.TransactionMembers
    untrustedData: Screens.UntrustedDataMembers
    user: Screens.UserMembers
    screenIdentifier: string = ScreenIds.CONFIRMATION

    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

    • Declines auto-signup and returns the user to the login screen without creating an account.

      Parameters

      Returns Promise<void>

      Throws an error if FormHandler encounters an unrecoverable issue during submission (e.g., network error). Server-side validation errors from Auth0 are not thrown as JavaScript errors but are made available in this.transaction.errors after the operation.

      import Confirmation from '@auth0/auth0-acul-js/confirmation';

      const confirmation = new Confirmation();
      await confirmation.goBack();

    • Proceeds with account creation after OTP verification.

      Parameters

      Returns Promise<void>

      Throws an error if FormHandler encounters an unrecoverable issue during submission (e.g., network error). Server-side validation errors from Auth0 are not thrown as JavaScript errors but are made available in this.transaction.errors after the operation.

      import Confirmation from '@auth0/auth0-acul-js/confirmation';

      const confirmation = new Confirmation();
      await confirmation.proceedToSignup();

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods - Language
    Methods - Other