RedeemTicket

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

La classe RedeemTicket implémente la fonctionnalité de l’écran redeem-ticket. Cet écran s’affiche lorsqu’un utilisateur doit échanger un ticket pour poursuivre le flux d’authentification.

​

Constructeurs

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

Example

import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket';
const redeemTicketManager = new RedeemTicket();
await redeemTicketManager.continue();

​

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 redeem-ticket.

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 redeem-ticket, 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 redeem-ticket, comme les identifiants actifs et les états du flux.

untrustedData · UntrustedDataMembers

Contient les données non fiables transmises au SDK, comme les données saisies par l’utilisateur pendant le flux d’échange de ticket.

user · UserMembers

Détails sur 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 RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket';
const redeemTicketManager = new RedeemTicket();
redeemTicketManager.changeLanguage({
  language: 'fr',
});

Paramètres de la méthode

Afficher Paramètres

options

LanguageChangeOptions.

language · string · requis

Le code de langue souhaité (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 durée de la session.

continue · Promise<void>

Cette méthode exécute l’action par défaut de l’écran redeem-ticket, ce qui fait continuer le flux d’authentification.

Example

import RedeemTicket from '@auth0/auth0-acul-js/redeem-ticket';
const redeemTicketManager = new RedeemTicket();
await redeemTicketManager.continue();

getErrors · Error []

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