DeviceCodeActivation

Describe todos los hooks y métodos disponibles para personalizar la pantalla device-code-activation de Universal Login.

La pantalla device-code-activation se muestra durante el flujo de autorización de dispositivos. Solicita al usuario que introduzca el código del dispositivo que aparece en su dispositivo para autorizarlo.

​

Importación

Cada pantalla tiene su propio conjunto de hooks y métodos. El SDK admite importación parcial e importación raíz para cada pantalla.

• La importación parcial te permite incluir solo el código que necesitas para tu caso de uso.
• La importación raíz te permite cargar todas las pantallas desde un único bundle, lo que resulta útil cuando quieres una compilación unificada que gestione todas las pantallas posibles.

Import Example

// importación raíz
import { useDeviceCodeActivation } from '@auth0/auth0-acul-react';

// importación parcial
import {
  useDeviceCodeActivation,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  continueMethod,
} from '@auth0/auth0-acul-react/device-code-activation';

function DeviceCodeActivationScreen() {
  const { continueMethod } = useDeviceCodeActivation();
  return (
    <button onClick={() => continueMethod({ code: 'ABCD-1234' })}>
      Activate Device
    </button>
  );
}

​

Hooks de contexto

Hooks con ámbito de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla device-code-activation. Impórtelos desde @auth0/auth0-acul-react/device-code-activation.

useBranding · () => BrandingMembers

Este hook proporciona la configuración de marca, como el logotipo, los colores y los ajustes de tema que se muestran en la pantalla device-code-activation.

Example

import { useBranding } from '@auth0/auth0-acul-react/device-code-activation';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

Este hook proporciona datos relacionados con el cliente, como id, name y logoUrl, para la pantalla device-code-activation.

Example

import { useClient } from '@auth0/auth0-acul-react/device-code-activation';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si la activación del dispositivo está asociada a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

import { useOrganization } from '@auth0/auth0-acul-react/device-code-activation';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

Este hook contiene datos sobre la pantalla actual en el flujo de autenticación.

Example

import { usePrompt } from '@auth0/auth0-acul-react/device-code-activation';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

Este hook contiene detalles específicos de la pantalla device-code-activation, incluida su configuración y contexto.

Example

import { useScreen } from '@auth0/auth0-acul-react/device-code-activation';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

Este hook contiene datos relacionados con el inquilino, como id y los metadatos asociados.

Example

import { useTenant } from '@auth0/auth0-acul-react/device-code-activation';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla device-code-activation, como las conexiones activas y el estado actual del flujo.

Example

import { useTransaction } from '@auth0/auth0-acul-react/device-code-activation';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

Este hook contiene los datos no confiables que se pasan a la pantalla, como un código de dispositivo rellenado previamente desde los parámetros de la URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/device-code-activation';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Este hook proporciona información sobre el usuario activo, incluidos username, email y los métodos de autenticación disponibles.

Example

import { useUser } from '@auth0/auth0-acul-react/device-code-activation';
function UserProfile() {
  const user = useUser();
}

useDeviceCodeActivation · DeviceCodeActivationMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla device-code-activation.

​

Métodos

continueMethod · Promise<void>

Este método envía el código del dispositivo introducido por el usuario para autorizar el dispositivo.

Example

import { useDeviceCodeActivation } from '@auth0/auth0-acul-react/device-code-activation';

function DeviceCodeForm() {
  const { continueMethod } = useDeviceCodeActivation();
  return (
    <button onClick={() => continueMethod({ code: 'ABCD-1234' })}>
      Activate Device
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

DeviceCodeActivationContinueOptions.

code · string · requerido

El código del dispositivo introducido por el usuario para autorizar su dispositivo.

​

Hooks comunes/de utilidad

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración simplificada del contexto de marca.

useChangeLanguage · Hooks

Este hook devuelve una función para cambiar el idioma de visualización en la pantalla actual de ACUL.

useCurrentScreen · Hooks

Este hook obtiene el contexto y el estado de la pantalla actual.

useErrors · Hooks

Este hook lee y gestiona los errores del servidor, del cliente y del desarrollador en la pantalla.