LoginEmailVerification

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran login-email-verification de Universal Login.

La classe LoginEmailVerification implémente la fonctionnalité de l’écran login-email-verification. Cet écran invite l’utilisateur à saisir un code à usage unique envoyé à son adresse courriel afin de vérifier son identité au cours du processus de connexion.

​

Constructeurs

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

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.continueWithCode({
  code: '123456',
});

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des paramètres liés au client, comme id, name et logoUrl, pour l’écran login-email-verification.

organization · OrganizationMembers

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

prompt · PromptMembers

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

screen · ScreenMembers

Contient des détails propres à l’écran login-email-verification, notamment 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 login-email-verification, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Gère les données non fiables transmises au SDK, comme les entrées de l’utilisateur pendant la connexion.

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 LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.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 option est définie à 'session', la langue sélectionnée est enregistrée pour la durée de la session.

continueWithCode · Promise<void>

Cette méthode soumet le code de vérification par courriel saisi par l’utilisateur.

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.continueWithCode({
  code: '123456',
});

Paramètres de la méthode

Afficher Paramètres

options

ContinueWithCodeOptionPayload.

code · string · requis

Le code de vérification envoyé à l’adresse courriel de l’utilisateur.

getErrors · Error []

Cette méthode récupère dans le contexte le tableau d’erreurs de transaction, ou un tableau vide s’il n’y en a aucune. Elle renvoie un tableau d’objets d’erreur provenant du contexte de transaction.

resendCode · Promise<void>

Cette méthode demande l’envoi d’un nouveau code de vérification à l’adresse courriel de l’utilisateur.

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';
const loginEmailVerificationManager = new LoginEmailVerification();
loginEmailVerificationManager.resendCode();

resendManager · ResendControl

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

Example

import LoginEmailVerification from '@auth0/auth0-acul-js/login-email-verification';

const loginEmailVerificationManager = new LoginEmailVerification();
const { startResend } = loginEmailVerificationManager.resendManager({
  timeoutSeconds: 15,
  onStatusChange: (remainingSeconds, isDisabled) => {
    console.log(`Resend available in ${remainingSeconds}s, disabled: ${isDisabled}`);
  },
  onTimeout: () => {
    console.log('Resend is now available');
  }
});

// Appelez startResend lorsque l’utilisateur clique sur le bouton de renvoi
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 appelée chaque fois que le status du renvoi change; elle renvoie le nombre de secondes restantes et indique si la fonctionnalité de renvoi est actuellement désactivée.

onTimeout? · () => void

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