DeviceCodeConfirmation

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

La pantalla device-code-confirmation se muestra durante el flujo de autorización de dispositivos. Muestra al usuario un código para confirmar y le solicita que apruebe o rechace la solicitud de activación del dispositivo.

​

Importación

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

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

Import Example

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

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

function DeviceCodeConfirmationScreen() {
  const { confirm, cancel } = useDeviceCodeConfirmation();
  return (
    <>
      <button onClick={() => confirm()}>Confirm</button>
      <button onClick={() => cancel()}>Cancel</button>
    </>
  );
}

​

Hooks de contexto

Hooks específicos de la pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla device-code-confirmation. Impórtalos desde @auth0/auth0-acul-react/device-code-confirmation.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

Este hook proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla device-code-confirmation.

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si la confirmació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-confirmation';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnDeviceCodeConfirmation

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

Example

import { useScreen } from '@auth0/auth0-acul-react/device-code-confirmation';
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-confirmation';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook proporciona los datos no confiables que se pasan a la pantalla, como un código de dispositivo precompletado a partir de parámetros de URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/device-code-confirmation';
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-confirmation';
function UserProfile() {
  const user = useUser();
}

useDeviceCodeConfirmation · DeviceCodeConfirmationMembers

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

​

Métodos

cancel · Promise<void>

Este método cancela el flujo de código del dispositivo y rechaza la solicitud de activación.

Example

import { useDeviceCodeConfirmation } from '@auth0/auth0-acul-react/device-code-confirmation';

function CancelButton() {
  const { cancel } = useDeviceCodeConfirmation();
  return (
    <button onClick={() => cancel()}>
      Cancel
    </button>
  );
}

confirm · Promise<void>

Este método confirma el código del dispositivo y aprueba la solicitud de activación.

Example

import { useDeviceCodeConfirmation } from '@auth0/auth0-acul-react/device-code-confirmation';

function ConfirmButton() {
  const { confirm } = useDeviceCodeConfirmation();
  return (
    <button onClick={() => confirm()}>
      Confirm
    </button>
  );
}

​

Hooks comunes y de utilidad

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Este hook devuelve una función para cambiar el idioma que se muestra 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 administra los errores del servidor, del cliente y del desarrollador que se muestran en la pantalla.