LoginPasswordlessEmailCode

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

La clase LoginPasswordlessEmailCode implementa la funcionalidad de la pantalla login-passwordless-email-code. Esta pantalla solicita el correo electrónico y el code del usuario.

​

Constructores

Cree una instancia del administrador de la pantalla LoginPasswordlessEmailCode:

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.submitCode({
  code: '123456',
});

​

Propiedades

branding · BrandingMembers

Proporciona configuraciones relacionadas con la marca, como el tema y los ajustes.

client · ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla login-passwordless-email-code.

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 · ScreenMembersOnLoginPasswordlessEmailCode

Contiene detalles específicos de la pantalla login-passwordless-email-code, incluida su configuración y contexto.

tenant · TenantMembers

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

transaction · TransactionMembersOnLoginPasswordlessEmailCode

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

untrustedData · UntrustedDataMembers

Gestiona los datos no confiables que se pasan al SDK, como los datos introducidos por el usuario durante el inicio de sesión.

user · UserMembers

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 LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.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.

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

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

getErrors · Error []

Este método obtiene el array de errores de la transacción desde el contexto, o un array vacío si no existe ninguno. Devuelve un array de objetos de error del contexto de la transacción.

resendCode · Promise<void>

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

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.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 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 LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';

const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
const { startResend } = loginPasswordlessEmailCodeManager.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 hace 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

Función 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

Función 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 continúa el proceso de inicio de sesión con el code enviado por correo electrónico.

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.submitCode({
  code: '123456',
});

Parámetros del método

Mostrar Parámetros

options

SubmitCodeOptions.

code · string | number · requerido

El code introducido por el usuario.

captcha? · string

El code de captcha o la respuesta del proveedor de captcha. Esta propiedad es obligatoria si tu inquilino de Auth0 tiene habilitada la Detección de bots.

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

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

switchConnection · Promise<void>

Este método cambia entre una conexión de base de datos (contraseña) y una conexión sin contraseña (OTP por correo electrónico/SMS).

Example

import LoginPasswordlessEmailCode from '@auth0/auth0-acul-js/login-passwordless-email-code';
const loginPasswordlessEmailCodeManager = new LoginPasswordlessEmailCode();
loginPasswordlessEmailCodeManager.switchConnection({
  connection: 'email',
});

Parámetros del método

Mostrar Parámetros

options

SwitchConnectionOptionsEmailCode.

connection · string · requerido

El nombre de la conexión a la que quieres cambiar. Usa 'email' o 'sms' para sin contraseña, o el nombre de una conexión de base de datos para la autenticación basada en contraseña.

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

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