EmailOTPChallenge

Décrit toutes les propriétés et méthodes permettant de personnaliser l’écran email-otp-challenge de Universal Login.

La classe EmailOTPChallenge implémente les fonctionnalités de l’écran email-otp-challenge. Cet écran invite l’utilisateur à saisir un code à usage unique envoyé à son adresse courriel.

​

Constructeurs

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

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.submitCode({ code: '123456' });

​

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 email-otp-challenge.

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

Contient des détails propres à l’écran email-otp-challenge, y compris sa configuration et son contexte.

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 email-otp-challenge, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme les saisies de l’utilisateur pendant le flux de défi Email OTP.

user · UserMembers

Contient les 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 EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
emailOTPChallengeManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

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

persist? · "session"

Lorsqu’elle est définie sur 'session', la langue sélectionnée est conservée pendant toute la session.

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.

resendCode · Promise<void>

Cette méthode demande l’envoi d’un nouveau code OTP à l’adresse courriel.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.resendCode();

resendManager · ResendControl

Cette méthode fournit une fonctionnalité de renvoi avec gestion du délai d’expiration. Elle retourne un objet ResendControl avec une méthode startResend() qui déclenche le renvoi et impose une période d’attente avant que l’utilisateur puisse renvoyer le code de nouveau.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
const { startResend } = emailOTPChallengeManager.resendManager({
  timeoutSeconds: 15,
});
await startResend();

Paramètres de la méthode

Afficher Paramètres

options

StartResendOptions.

timeoutSeconds? · number

La durée de la période d’attente, en secondes, avant que l’utilisateur puisse renvoyer le code.

onStatusChange? · OnStatusChangeCallback

Fonction de rappel invoquée chaque fois que le statut du renvoi change; elle retourne le nombre de secondes restantes et indique si la fonctionnalité de renvoi est actuellement désactivée.

onTimeout? · () => void

Fonction de rappel invoquée lorsque la période d’attente prend fin et que le renvoi redevient possible.

submitCode · Promise<void>

Cette méthode soumet le code OTP saisi par l’utilisateur.

Example

import EmailOTPChallenge from '@auth0/auth0-acul-js/email-otp-challenge';
const emailOTPChallengeManager = new EmailOTPChallenge();
await emailOTPChallengeManager.submitCode({ code: '123456' });

Paramètres de la méthode

Afficher Paramètres

options

OtpCodeOptions.

code · string · requis

Le code OTP que l’utilisateur saisit pour le soumettre.