DeviceCodeActivation

Décrit toutes les propriétés et méthodes disponibles pour personnaliser l’écran device-code-activation d’Universal Login.

La classe DeviceCodeActivation implémente les fonctionnalités de l’écran device-code-activation. Cet écran s’affiche lorsque l’utilisateur doit saisir le code affiché sur son appareil pour l’activer.

​

Constructeurs

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

Example

import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation';
const deviceCodeActivationManager = new DeviceCodeActivation();
await deviceCodeActivationManager.continue({ code: 'ABCD-1234' });

​

Propriétés

branding · BrandingMembers

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

client · ClientMembers

Fournit des configurations liées à l’application, comme id, name et logoUrl, pour l’écran device-code-activation.

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

Contient des détails propres à l’écran device-code-activation, y compris 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 device-code-activation, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Contient les données non fiables transmises au SDK, comme les entrées de l’utilisateur pendant le flux d’activation du code d’appareil.

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 DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation';
const deviceCodeActivationManager = new DeviceCodeActivation();
deviceCodeActivationManager.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.

continue · Promise<void>

Cette méthode envoie le code d’appareil saisi par l’utilisateur pour finaliser l’activation.

Example

import DeviceCodeActivation from '@auth0/auth0-acul-js/device-code-activation';
const deviceCodeActivationManager = new DeviceCodeActivation();
await deviceCodeActivationManager.continue({ code: 'ABCD-1234' });

Paramètres de la méthode

Afficher Paramètres

options

DeviceCodeActivationContinueOptions.

code · string · requis

Le code d’appareil saisi par l’utilisateur.

getErrors · Error []

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