InterstitialCaptcha

Describe los hooks y métodos disponibles para personalizar la pantalla interstitial-captcha de Universal Login.

La pantalla interstitial-captcha se muestra cuando se requiere una verificación CAPTCHA durante el flujo de autenticación. Solicita al usuario que complete el CAPTCHA antes de continuar.

​

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.
• La importación desde la raíz te permite cargar todas las pantallas desde un único paquete, lo que resulta útil cuando quieres una compilación unificada para gestionar todas las pantallas posibles.

Import Example

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

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

function InterstitialCaptchaScreen() {
  const { submitCaptcha } = useInterstitialCaptcha();
  return (
    <button onClick={() => submitCaptcha({ captcha: 'token' })}>Submit</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 interstitial-captcha. Impórtalos desde @auth0/auth0-acul-react/interstitial-captcha.

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

Este hook proporciona la configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla interstitial-captcha.

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si la verificación CAPTCHA tiene alcance de Organización. Devuelve null cuando no hay contexto de Organización.

Example

import { useOrganization } from '@auth0/auth0-acul-react/interstitial-captcha';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>Sin contexto de Organización</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/interstitial-captcha';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook expone los datos no confiables que se pasan a la pantalla, como los parámetros precargados de las cadenas de consulta de la URL.

Example

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

useInterstitialCaptcha · InterstitialCaptchaMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla interstitial-captcha.

​

Métodos

submitCaptcha · Promise<void>

Este método envía el token del CAPTCHA para completar la verificación y continuar el flujo de autenticación.

Example

import { useInterstitialCaptcha } from '@auth0/auth0-acul-react/interstitial-captcha';

function SubmitButton() {
  const { submitCaptcha } = useInterstitialCaptcha();
  return (
    <button onClick={() => submitCaptcha({ captcha: 'token' })}>
      Continue
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

SubmitCaptchaOptions.

captcha · string · requerido

El token de respuesta del CAPTCHA.

​

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 de la pantalla actual de ACUL.

useCurrentScreen · Hooks

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

useErrors · Hooks

Este hook permite leer y gestionar los errores del servidor, del cliente y del desarrollador en la pantalla.