PhoneIdentifierChallenge

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

La pantalla phone-identifier-challenge se muestra cuando un usuario necesita verificar su número de teléfono al introducir un código de un solo uso. Permite al usuario enviar el código, reenviarlo, alternar entre la entrega por SMS y voz, o volver al paso anterior.

​

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.

• Usar la importación parcial te permite incluir solo el código que necesitas para tu caso de uso específico.
• Usar 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 desde la raíz
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react';

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

function PhoneIdentifierChallengeScreen() {
  const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => submitPhoneChallenge({ code: '123456' })}>Verify</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 phone-identifier-challenge. Impórtalos desde @auth0/auth0-acul-react/phone-identifier-challenge.

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 phone-identifier-challenge.

Example

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

Example

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

useOrganization · () => OrganizationMembers

Este hook proporciona información sobre la Organización del usuario si el desafío telefónico está limitado a una Organización. Devuelve null cuando no hay contexto de Organización.

Example

import { useOrganization } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</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/phone-identifier-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnPhoneIdentifierChallenge

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

Example

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

useTransaction · () => TransactionMembers

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

Example

import { useTransaction } from '@auth0/auth0-acul-react/phone-identifier-challenge';
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 cadenas de consulta de URL.

Example

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

useUser · () => UserMembers

Este hook ofrece 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-challenge';
function UserProfile() {
  const user = useUser();
}

usePhoneIdentifierChallenge · PhoneIdentifierChallengeMembers

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

​

Métodos

submitPhoneChallenge · Promise<void>

Este método envía el código de un solo uso ingresado por el usuario para verificar su número de teléfono y continuar el flujo de autenticación.

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function VerifyButton() {
  const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => submitPhoneChallenge({ code: '123456' })}>
      Verify
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

PhoneChallengeOptions.

code · string · requerido

El código de verificación enviado al número de teléfono del usuario.

captcha? · string

El token de respuesta de CAPTCHA, si CAPTCHA está habilitado para este inquilino.

resendCode · Promise<void>

Este método reenvía el código de un solo uso al número de teléfono del usuario.

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function ResendButton() {
  const { resendCode } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}

returnToPrevious · Promise<void>

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

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function BackButton() {
  const { returnToPrevious } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => returnToPrevious()}>
      Back
    </button>
  );
}

switchToText · Promise<void>

Este método cambia el método de entrega de la verificación telefónica a un mensaje de texto SMS.

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function SwitchToSmsButton() {
  const { switchToText } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => switchToText()}>
      Send via SMS
    </button>
  );
}

switchToVoice · Promise<void>

Este método cambia el método de entrega de la verificación telefónica a una llamada de voz.

Example

import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function SwitchToVoiceButton() {
  const { switchToVoice } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => switchToVoice()}>
      Send via Voice Call
    </button>
  );
}

​

Hooks comunes y de utilidad

useAuth0Themes · Hooks

Este hook obtiene las opciones del tema actual con la configuración consolidada 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 en la pantalla.

useResend · Hooks

Este hook administra el estado y el temporizador del período de espera para el reenvío del método resendCode.