EmailOTPChallenge

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

La clase EmailOTPChallenge implementa la funcionalidad de la pantalla email-otp-challenge. Esta pantalla solicita al usuario que introduzca un OTP enviado a su correo electrónico.

​

Constructores

Cree una instancia del gestor de la pantalla EmailOTPChallenge:

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.submitCode({ code: '123456' });

​

Propiedades

branding · BrandingMembers

Proporciona la configuración relacionada con la marca, como el tema y sus ajustes.

client · ClientMembers

Proporciona la configuración relacionada con el cliente, como id, name y logoUrl, para la pantalla email-otp-challenge.

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

Contiene detalles específicos de la pantalla email-otp-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-otp-challenge, como identificadores activos y estados del flujo.

untrustedData · UntrustedDataMembers

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

user · UserMembers

Incluye detalles del usuario activo, como username, email y roles.

​

Métodos

changeLanguage · Promise<void>

Este método cambia el idioma mostrado en la página de Universal Login.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
emailOTPChallengeManager.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"

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

getErrors · Error []

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

resendCode · Promise<void>

Este método solicita que se envíe un nuevo código OTP al correo electrónico del usuario.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.resendCode();

resendManager · ResendControl

Este método proporciona la 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 EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
const { startResend } = emailOTPChallengeManager.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 volver a reenviar el código.

onStatusChange? · OnStatusChangeCallback

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

onTimeout? · () => void

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

submitCode · Promise<void>

Este método envía el código OTP introducido por el usuario.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.submitCode({ code: '123456' });

Parámetros del método

Mostrar Parámetros

options

OtpCodeOptions.

code · string · requerido

El código OTP que introduce el usuario para enviarlo.