AcceptInvitation

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

La pantalla accept-invitation aparece cuando se invita a un usuario a unirse a una Organización. Permite al usuario aceptar la invitación y continuar con el flujo de autenticación.

​

Importación

Cada pantalla tiene su propio conjunto de Hooks y métodos. El SDK admite la importación parcial y la 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 específico.
• La importación raíz te permite cargar todas las pantallas desde un único paquete, lo que resulta útil cuando quieres una compilación unificada que gestione todas las pantallas posibles.

Import Example

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

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

function AcceptInvitationScreen() {
  const { acceptInvitation } = useAcceptInvitation();
  return (
    <button onClick={() => acceptInvitation()}>Accept Invitation</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 accept-invitation. Impórtalos desde @auth0/auth0-acul-react/accept-invitation.

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 accept-invitation.

Example

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización a la que se ha invitado al usuario a unirse. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnAcceptInvitation

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useAcceptInvitation · AcceptInvitationMembers

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

​

Métodos

acceptInvitation · Promise<void>

Este método registra la aceptación por parte del usuario de la invitación a la organización y continúa con el flujo de autenticación.

Example

import { useAcceptInvitation } from '@auth0/auth0-acul-react/accept-invitation';

function AcceptButton() {
  const { acceptInvitation } = useAcceptInvitation();
  return (
    <button onClick={() => acceptInvitation()}>
      Accept Invitation
    </button>
  );
}

​

Hooks comunes y de utilidad

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración plana 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 permite leer y administrar los errores del servidor, del cliente y del desarrollador en la pantalla.