PhoneIdentifierEnrollment

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

La clase PhoneIdentifierEnrollment implementa la funcionalidad de la pantalla phone-identifier-enrollment. Esta pantalla permite a los usuarios inscribir un número de teléfono como identificador seleccionando el método de entrega de verificación que prefieran.

​

Constructores

Crea una instancia del administrador de la pantalla PhoneIdentifierEnrollment:

Example

import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();
await phoneIdentifierEnrollmentManager.continuePhoneEnrollment({
  type: 'voice',
});

​

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-enrollment.

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

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

untrustedData · UntrustedDataMembers

Gestiona datos no confiables que se pasan al SDK, como los datos introducidos por el usuario durante el flujo de inscripción del teléfono.

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 PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();
phoneIdentifierEnrollmentManager.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.

continuePhoneEnrollment · Promise<void>

Este método continúa el proceso de inscripción del teléfono con el método de entrega seleccionado.

Example

import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();
await phoneIdentifierEnrollmentManager.continuePhoneEnrollment({
  type: 'voice',
});

Parámetros del método

Mostrar Parámetros

options

PhoneEnrollmentOptions.

type · "text" | "voice" · requerido

El método de entrega del código de verificación.

getErrors · Error []

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

returnToPrevious · Promise<void>

Este método devuelve al usuario a la pantalla anterior.

Example

import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();
await phoneIdentifierEnrollmentManager.returnToPrevious();