RedeemTicket

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

La pantalla redeem-ticket se muestra cuando un usuario necesita canjear un ticket para continuar el flujo de autenticación, por ejemplo, durante la aceptación de una invitación o la verificación de correo electrónico.

​

Importación

Cada pantalla tiene su propio conjunto de hooks y métodos. El SDK admite importación parcial e 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 paquete, lo que resulta útil cuando necesitas una compilación unificada para gestionar todas las pantallas posibles.

Import Example

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

// importación parcial
import {
  useRedeemTicket,
  // 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/redeem-ticket';

function RedeemTicketScreen() {
  const { continueMethod } = useRedeemTicket();
  return (
    <button onClick={() => continueMethod()}>Continue</button>
  );
}

​

Hooks de contexto

Hooks de ámbito de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla redeem-ticket. Impórtalos desde @auth0/auth0-acul-react/redeem-ticket.

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 redeem-ticket.

Example

import { useBranding } from '@auth0/auth0-acul-react/redeem-ticket';
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 redeem-ticket.

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la organización del usuario si el canje del ticket está limitado a una organización. Devuelve null cuando no hay contexto de organización.

Example

import { useOrganization } from '@auth0/auth0-acul-react/redeem-ticket';
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/redeem-ticket';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useRedeemTicket · RedeemTicketMembers

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

​

Métodos

continueMethod · Promise<void>

Este método ejecuta la acción predeterminada en la pantalla redeem-ticket y continúa el flujo de autenticación una vez que se haya canjeado el ticket.

Example

import { useRedeemTicket } from '@auth0/auth0-acul-react/redeem-ticket';

function ContinueButton() {
  const { continueMethod } = useRedeemTicket();
  return (
    <button onClick={() => continueMethod()}>
      Continue
    </button>
  );
}

​

Hooks comunes/de utilidad

useAuth0Themes · Hooks

Este hook obtiene las opciones actuales del tema con la configuración consolidada desde el 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 gestiona los errores del servidor, del cliente y del desarrollador en la pantalla.