PhoneIdentifierEnrollment

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

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

​

Constructeurs

Créez une instance du gestionnaire d’é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 et les paramètres associés.

client · ClientMembers

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

organization · OrganizationMembers

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

prompt · PromptMembers

Contient des données sur l’invite en cours dans le flux d’authentification.

screen · ScreenMembersOnPhoneIdentifierEnrollment

Contient des détails propres à l’écran phone-identifier-enrollment, notamment sa configuration et son contexte.

tenant · TenantMembers

Contient des données liées au locataire, 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

Gère les données non fiables transmises au SDK, comme les données saisies par l’utilisateur pendant le flux d’inscription du numéro de téléphone.

user · UserMembers

Détails de l’utilisateur actif, y compris username, email et roles.

​

Méthodes

changeLanguage · Promise<void>

Cette méthode modifie 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 paramètres régionaux de la langue souhaitée (par exemple, 'en', 'fr', 'es').

persist? · "session"

Lorsque cette valeur est définie sur 'session', la langue sélectionnée est conservée pendant toute la session.

continuePhoneEnrollment · Promise<void>

Cette méthode poursuit le processus d’inscription du téléphone avec la méthode d’envoi sélectionnée.

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

La méthode d’envoi du code de vérification.

getErrors · Error []

Cette méthode renvoie le tableau des erreurs de transaction du contexte, ou un tableau vide s’il n’y en a aucune.

returnToPrevious · Promise<void>

Cette méthode fait revenir 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();