@auth0/auth0-acul-js - v0.1.0-beta.8
    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

    • 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: Classes.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]: undefined | string | number | boolean
        • 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.

    • Retrieves the array of transaction errors from the context, or an empty array if none exist.

      Returns Classes.Error[]

      An array of error objects from the transaction context.