PhoneIdentifierChallenge

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

La clase PhoneIdentifierChallenge implementa la funcionalidad de la pantalla phone-identifier-challenge. Esta pantalla solicita al usuario que introduzca el código de verificación enviado a su número de teléfono para confirmar su identidad.

​

Constructores

Cree una instancia del administrador de la pantalla PhoneIdentifierChallenge:

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.submitPhoneChallenge({
  code: '123456',
});

​

Propiedades

branding · BrandingMembers

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

client · ClientMembers

Proporciona configuraciones relacionadas con el cliente, como id, name y logoUrl, para la pantalla phone-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 del flujo de autenticación.

screen · ScreenMembersOnPhoneIdentifierChallenge

Contiene detalles específicos de la pantalla phone-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 phone-identifier-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 telefónico.

user · UserMembers

Detalles del usuario activo, incluidos username, email y roles.

​

Métodos

changeLanguage · Promise<void>

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

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
phoneIdentifierChallengeManager.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.

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 reenvía el código de verificación al número de teléfono del usuario.

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.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 PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
const { startResend } = phoneIdentifierChallengeManager.resendManager({
  timeoutSeconds: 30,
});
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

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

Callback que se invoca cuando expira el período de espera 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 PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.returnToPrevious();

submitPhoneChallenge · Promise<void>

Este método envía el código de verificación del teléfono para completar el desafío.

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.submitPhoneChallenge({
  code: '123456',
});

Parámetros del método

Mostrar Parámetros

options

PhoneChallengeOptions.

code · string · requerido

El código de verificación enviado al número de teléfono del usuario.

captcha? · string

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

switchToText · Promise<void>

Este método cambia el método de entrega del código de verificación a un mensaje de texto por SMS.

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.switchToText();

switchToVoice · Promise<void>

Este método cambia el método de entrega del código de verificación a una llamada de voz.

Example

import PhoneIdentifierChallenge from '@auth0/auth0-acul-js/phone-identifier-challenge';
const phoneIdentifierChallengeManager = new PhoneIdentifierChallenge();
await phoneIdentifierChallengeManager.switchToVoice();