MfaEmailList

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

La pantalla mfa-email-list muestra una lista de direcciones de correo electrónico disponibles para la verificación con MFA y permite al usuario seleccionar una.

​

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 una compilación unificada para gestionar todas las pantallas posibles.

Import Example

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

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

function MfaEmailListScreen() {
  const { selectMfaEmail } = useMfaEmailList();
  return (
    <button onClick={() => selectMfaEmail({ index: 0 })}>
      Select Email
    </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 mfa-email-list. Impórtalos desde @auth0/auth0-acul-react/mfa-email-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-email-list.

Example

import { useBranding } from '@auth0/auth0-acul-react/mfa-email-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-email-list.

Example

import { useClient } from '@auth0/auth0-acul-react/mfa-email-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 ámbito de Organización. Devuelve null cuando no hay contexto de Organización.

Example

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

useScreen · () => ScreenMembersOnMfaEmailList

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useMfaEmailList · MfaEmailListMembers

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

​

Métodos

goBack · Promise<void>

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

Example

import { useMfaEmailList } from '@auth0/auth0-acul-react/mfa-email-list';

function BackButton() {
  const { goBack } = useMfaEmailList();
  return (
    <button onClick={() => goBack()}>
      Volver
    </button>
  );
}

selectMfaEmail · Promise<void>

Este método selecciona una dirección de correo electrónico de la lista para usarla en la verificación de MFA.

Example

import { useMfaEmailList } from '@auth0/auth0-acul-react/mfa-email-list';

function EmailSelector() {
  const { selectMfaEmail } = useMfaEmailList();
  return (
    <button onClick={() => selectMfaEmail({ index: 0 })}>
      Usar este correo electrónico
    </button>
  );
}

Parámetros del método

Mostrar Parámetros

options

SelectMfaEmailOptions.

index · number · requerido

El índice de la dirección de correo electrónico que se va a seleccionar.

​

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