LoginEmailVerification

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

La clase LoginEmailVerification implementa la funcionalidad de la pantalla login-email-verification. Esta pantalla solicita al usuario que introduzca un code de un solo uso enviado a su dirección de correo electrónico para verificar su identidad durante el proceso de inicio de sesión.

​

Constructores

Cree una instancia del administrador de la pantalla LoginEmailVerification:

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.continueWithCode({
  code: '123456',
});

​

Propiedades

branding · BrandingMembers

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

client · ClientMembers

Proporciona la configuración del cliente, como id, name y logoUrl, para la pantalla login-email-verification.

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 login-email-verification, incluida su configuración y contexto.

tenant · TenantMembers

Contiene datos del inquilino, como id y los metadatos asociados.

transaction · TransactionMembers

Proporciona datos específicos de la transacción para la pantalla login-email-verification, 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 inicio de sesión.

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 LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.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 mantiene durante toda la sesión.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

continueWithCode · Promise<void>

Este método envía el code de verificación por correo electrónico introducido por el usuario.

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.continueWithCode({
  code: '123456',
});

Parámetros del método

Mostrar Parámetros

options

ContinueWithCodeOptionPayload.

code · string · requerido

El code de verificación enviado al correo electrónico del usuario.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

getErrors · Error []

Este método recupera la matriz de errores de la transacción del contexto, o una matriz vacía si no existe ninguno. Devuelve una matriz de objetos de error del contexto de la transacción.

resendCode · Promise<void>

Este método solicita que se envíe un nuevo code de verificación a la dirección de correo electrónico del usuario.

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.resendCode();

Parámetros del método

Mostrar Parámetros

options

CustomOptions.

[`key`: `string`] · "string" | "number" | "boolean" | "undefined"

Campos personalizados adicionales con el prefijo ulp- (por ejemplo, 'ulp-custom-field').

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 LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';

const loginEmailVerificationManager = new LoginEmailVerification();
const { startResend } = loginEmailVerificationManager.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

// Llama a startResend cuando el usuario haga clic en el botón de reenvío
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 code.

onStatusChange? · OnStatusChangeCallback

Callback 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

Callback que se invoca cuando vence el período de espera y el reenvío vuelve a estar disponible.