PhoneIdentifierEnrollment

Describe todos los hooks y métodos disponibles para personalizar la pantalla phone-identifier-enrollment de Universal Login.

La pantalla phone-identifier-enrollment se muestra cuando un usuario necesita inscribir su número de teléfono como identificador. Permite al usuario seleccionar su método de verificación preferido (SMS o llamada telefónica) y continuar con el proceso de inscripción o volver al paso anterior.

​

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 permite incluir solo el código necesario para tu caso de uso específico.
• La importación raíz permite cargar todas las pantallas desde un único paquete, lo que resulta útil cuando quieres una compilación unificada que admita todas las pantallas posibles.

Import Example

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

// importación parcial
import {
  usePhoneIdentifierEnrollment,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  continuePhoneEnrollment,
  returnToPrevious,
} from '@auth0/auth0-acul-react/phone-identifier-enrollment';

function PhoneIdentifierEnrollmentScreen() {
  const { continuePhoneEnrollment } = usePhoneIdentifierEnrollment();
  return (
    <button onClick={() => continuePhoneEnrollment({ type: 'text' })}>Send Code via SMS</button>
  );
}

​

Hooks de contexto

Hooks con alcance de pantalla que proporcionan acceso de solo lectura a los datos de contexto de Auth0 en la pantalla phone-identifier-enrollment. Impórtalos desde @auth0/auth0-acul-react/phone-identifier-enrollment.

useBranding · () => BrandingMembers

Este hook proporciona configuraciones de marca, como el logotipo, los colores y los ajustes del tema que se muestran en la pantalla phone-identifier-enrollment.

Example

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

useClient · () => ClientMembers

Este hook proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla phone-identifier-enrollment.

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembersOnPhoneIdentifierEnrollment

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Este hook expone datos no confiables que se pasan a la pantalla, como parámetros rellenados previamente desde la cadena de consulta de la URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

import { useUser } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function UserProfile() {
  const user = useUser();
}

usePhoneIdentifierEnrollment · PhoneIdentifierEnrollmentMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla phone-identifier-enrollment.

​

Métodos

continuePhoneEnrollment · Promise<void>

Este método envía el método de verificación telefónica preferido del usuario y continúa el flujo de inscripción.

Example

import { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react/phone-identifier-enrollment';

function EnrollButton() {
  const { continuePhoneEnrollment } = usePhoneIdentifierEnrollment();
  return (
    <button onClick={() => continuePhoneEnrollment({ type: 'text' })}>
      Enviar código por SMS
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

PhoneEnrollmentOptions.

type · "text" | "voice" · requerido

El método de entrega del código de verificación. Use “text” para SMS o “voice” para una llamada telefónica.

returnToPrevious · Promise<void>

Este método devuelve al usuario al paso anterior del flujo de autenticación.

Example

import { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react/phone-identifier-enrollment';

function BackButton() {
  const { returnToPrevious } = usePhoneIdentifierEnrollment();
  return (
    <button onClick={() => returnToPrevious()}>
      Atrás
    </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.