MfaSmsList

Describe todos los hooks y métodos disponibles para personalizar la pantalla mfa-sms-list de Universal Login.

La pantalla mfa-sms-list muestra una lista de números de teléfono inscritos y permite al usuario seleccionar uno para recibir un code de verificación por SMS.

​

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

Import Example

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

// importación parcial
import {
  useMfaSmsList,
  // Hooks de contexto
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks comunes
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks de utilidad
  useChangeLanguage,
  // Métodos
  backAction,
  selectPhoneNumber,
} from "@auth0/auth0-acul-react/mfa-sms-list";

function MfaSmsListScreen() {
  const { selectPhoneNumber } = useMfaSmsList();
  return (
    <button onClick={() => selectPhoneNumber({ index: 0 })}>
      Use This Phone Number
    </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 mfa-sms-list. Impórtelos desde @auth0/auth0-acul-react/mfa-sms-list.

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 mfa-sms-list.

Example

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

useClient · () => ClientMembers

Este hook proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla mfa-sms-list.

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTransaction · () => TransactionMembers

Este hook proporciona datos específicos de la transacción para la pantalla mfa-sms-list, como el estado actual del flujo de MFA.

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useMfaSmsList · MfaSmsListMembers

Este hook devuelve todos los métodos y el contexto disponibles en la pantalla mfa-sms-list.

​

Métodos

backAction · Promise<void>

Este método vuelve a la pantalla anterior del flujo de MFA.

Example

import { useMfaSmsList } from '@auth0/auth0-acul-react/mfa-sms-list';

function BackButton() {
  const { backAction } = useMfaSmsList();
  return (
    <button onClick={() => backAction()}>
      Go Back
    </button>
  );
}

selectPhoneNumber · Promise<void>

Este método selecciona un número de teléfono de la lista de inscritos para usarlo en el desafío por SMS.

Example

import { useMfaSmsList } from '@auth0/auth0-acul-react/mfa-sms-list';

function PhoneNumberSelector() {
  const { selectPhoneNumber } = useMfaSmsList();
  return (
    <button onClick={() => selectPhoneNumber({ index: 0 })}>
      Use This Phone Number
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

MfaSmsListOptions.

index · number · requerido

El índice del número de teléfono que se va a seleccionar.

​

Hooks comunes y utilitarios

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 lee y administra los errores del servidor, del cliente y del desarrollador en la pantalla.