EmailIdentifierChallenge

Describe todas las propiedades y los métodos disponibles para personalizar la pantalla email-identifier-challenge de Universal Login.

La clase EmailIdentifierChallenge implementa la funcionalidad de la pantalla email-identifier-challenge. Esta pantalla solicita al usuario que introduzca un código de verificación enviado a su correo electrónico para confirmar su identidad.

​

Constructores

Crea una instancia del administrador de la pantalla EmailIdentifierChallenge:

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.submitEmailChallenge({ code: 'your-code' });

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones de marca, como el tema y otros ajustes.

client · ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla email-identifier-challenge.

organization · OrganizationMembers

Proporciona información sobre la organización del usuario, como id y name.

prompt · PromptMembers

Contiene datos sobre la pantalla actual en el flujo de autenticación.

screen · ScreenMembersOnEmailIdentifierChallenge

Contiene detalles específicos de la pantalla email-identifier-challenge, incluida su configuración y contexto.

tenant · TenantMembers

Contiene datos relacionados con el inquilino, como id y los metadatos asociados.

transaction · TransactionMembers

Proporciona datos específicos de la transacción para la pantalla email-identifier-challenge, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembers

Gestiona los datos no confiables que se pasan al SDK, como la entrada del usuario durante el flujo de desafío por correo electrónico.

user · UserMembers

Contiene detalles del usuario activo, incluidos username, email y roles.

​

Métodos

changeLanguage · Promise<void>

Este método cambia el idioma de visualización de la página de Universal Login.

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
emailIdentifierChallengeManager.changeLanguage({
  language: 'fr',
});

Parámetros del método

Mostrar Parámetros

options

LanguageChangeOptions.

language · string · requerido

El código de configuración regional del idioma deseado (por ejemplo, 'en', 'fr', 'es').

persist? · "session"

Cuando se establece en 'session', el idioma seleccionado se conserva durante toda la sesión.

getErrors · Error []

Este método recupera del contexto el arreglo de errores de la transacción, o un arreglo vacío si no hay ninguno.

resendCode · Promise<void>

Este método reenvía el código de verificación a la dirección de correo electrónico del usuario.

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.resendCode();

resendManager · ResendControl

Este método proporciona funcionalidad de reenvío con gestión del tiempo de espera. Devuelve un objeto ResendControl con un método startResend() que activa el reenvío y aplica un período de espera antes de que el usuario pueda volver a reenviar.

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
const { startResend } = emailIdentifierChallengeManager.resendManager({
  timeoutSeconds: 15,
});
await startResend();

Parámetros del método

Mostrar Parámetros

options

StartResendOptions.

timeoutSeconds? · number

La duración del período de espera, en segundos, antes de que el usuario pueda reenviar el código de nuevo.

onStatusChange? · OnStatusChangeCallback

Función de devolución de llamada que se invoca cada vez que cambia el estado del reenvío; devuelve los segundos restantes e indica si la funcionalidad de reenvío está deshabilitada en ese momento.

onTimeout? · () => void

Función de devolución de llamada que se invoca cuando el período de espera vence y el reenvío vuelve a estar disponible.

returnToPrevious · Promise<void>

Este método lleva al usuario de vuelta a la pantalla anterior.

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.returnToPrevious();

submitEmailChallenge · Promise<void>

Este método envía el código de verificación por correo electrónico para completar el desafío.

Example

import EmailIdentifierChallenge from '@auth0/auth0-acul-js/email-identifier-challenge';
const emailIdentifierChallengeManager = new EmailIdentifierChallenge();
await emailIdentifierChallengeManager.submitEmailChallenge({ code: 'your-code' });

Parámetros del método

Mostrar Parámetros

options

EmailChallengeOptions.

code · string · requerido

El código de verificación enviado a la dirección de correo electrónico del usuario.

captcha? · string

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