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

    Class DeviceCodeActivation

    Class implementing the Device Code Activation screen functionality. This screen is displayed when the user needs to enter the code on their device to activate it.

    Hierarchy

    • BaseContext
      • DeviceCodeActivation

    Implements

    Index

    Constructors

    Properties

    screenIdentifier: string = ScreenIds.DEVICE_CODE_ACTIVATION

    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

    • Submits the device code entered by the user. This action is triggered when the user enters the code displayed on their device and submits the form.

      Parameters

      • payload: Screens.DeviceCodeActivationContinueOptions

        An object containing the code entered by the user and any custom payload.

        payload for continuing device code activation.

        This interface extends CustomOptions, meaning all custom option properties are merged into the top level of the object. This avoids nesting and provides a simpler structure for consumers of this interface.

        • [key: string]: string | number | boolean | undefined
        • code: string

      Returns Promise<void>

      A promise that resolves when the code is successfully submitted.

      import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation';
      const deviceCodeActivationManager = new DeviceCodeActivation();
      async function activateDeviceCode(code) {
      try {
      await deviceCodeActivationManager.continue({ code });
      console.log('Device code activation successful.');
      } catch (error) {
      console.error('Error during device code activation:', error);
      }
      }

      Rejects with an error if the submission fails.