PhoneIdentifierEnrollment

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran phone-identifier-enrollment de Universal Login.

La classe PhoneIdentifierEnrollment implémente la fonctionnalité de l’écran phone-identifier-enrollment. Cet écran permet aux utilisateurs d’enregistrer un numéro de téléphone comme identifiant en sélectionnant leur mode de livraison de vérification préféré.

​

Constructeurs

Créez une instance du gestionnaire de l’écran PhoneIdentifierEnrollment :

Example

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

​

Propriétés

branding · BrandingMembers

Fournit des configurations liées à l’image de marque, comme le thème d’image de marque et les paramètres.

client · ClientMembers

Fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran phone-identifier-enrollment.

organization · OrganizationMembers

Fournit des renseignements sur l’Organization de l’utilisateur, comme id et name.

prompt · PromptMembers

Contient des données sur le prompt actuel dans le flux d’authentification.

screen · ScreenMembersOnPhoneIdentifierEnrollment

Contient des renseignements propres à l’écran phone-identifier-enrollment, y compris sa configuration et son contexte. L’objet screen.data expose trois champs facultatifs : phone, messageType et username. Utilisez screen.data?.username pour afficher le nom d’utilisateur associé à la session d’enrôlement actuelle.

tenant · TenantMembers

Contient des données liées au tenant, comme id et les métadonnées associées.

transaction · TransactionMembers

Fournit des données propres à la transaction pour l’écran phone-identifier-enrollment, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Traite les données non fiables transmises au SDK, comme les entrées utilisateur pendant le flux d’enrôlement du téléphone.

user · UserMembers

Contient les détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode change la langue d’affichage de la page Universal Login.

Example

import PhoneIdentifierEnrollment from '@auth0/auth0-acul-js/phone-identifier-enrollment';
const phoneIdentifierEnrollmentManager = new PhoneIdentifierEnrollment();
phoneIdentifierEnrollmentManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue correspondant à la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsqu’elle est définie à 'session', la langue sélectionnée est enregistrée pour toute la durée de la session.

continuePhoneEnrollment · Promise<void>

Cette méthode poursuit le processus d’enrôlement du téléphone avec le mode de livraison sélectionné.

Example

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

Paramètres de la méthode

Afficher Paramètres

options

PhoneEnrollmentOptions.

type · "text" | "voice" · requis

Le mode de livraison du code de vérification.

getErrors · Error []

Cette méthode récupère le tableau des erreurs de transaction à partir du contexte, ou un tableau vide s’il n’y en a aucune.

returnToPrevious · Promise<void>

Cette méthode ramène l’utilisateur à l’écran précédent.

Example

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