RedeemTicket

Décrit tous les hooks et méthodes disponibles pour personnaliser l’écran redeem-ticket dans Universal Login.

L’écran redeem-ticket s’affiche lorsqu’un utilisateur doit utiliser un ticket pour poursuivre le flux d’authentification, par exemple lors de l’acceptation d’une invitation ou de la vérification du courriel.

​

Importation

Chaque écran possède son propre ensemble de hooks et de méthodes. Le SDK prend en charge l’import partiel et l’import racine pour chaque écran.

• L’import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’import racine vous permet de charger tous les écrans à partir d’un seul bundle, ce qui est utile si vous souhaitez qu’une build unifiée prenne en charge tous les écrans possibles.

Import Example

// import racine
import { useRedeemTicket } from '@auth0/auth0-acul-react';

// import partiel
import {
  useRedeemTicket,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Utility hooks
  useChangeLanguage,
  // Méthodes
  continueMethod,
} from '@auth0/auth0-acul-react/redeem-ticket';

function RedeemTicketScreen() {
  const { continueMethod } = useRedeemTicket();
  return (
    <button onClick={() => continueMethod()}>Continue</button>
  );
}

​

Hooks de contexte

Hooks propres à l’écran qui fournissent un accès en lecture seule aux données de contexte d’Auth0 pour l’écran redeem-ticket. Importez-les depuis @auth0/auth0-acul-react/redeem-ticket.

useBranding · () => BrandingMembers

Ce hook fournit les paramètres d’image de marque, comme le logo, les couleurs et les réglages du thème affichés sur l’écran redeem-ticket.

Example

import { useBranding } from '@auth0/auth0-acul-react/redeem-ticket';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

Ce hook fournit les configurations liées à l’application, comme id, name et logoUrl, pour l’écran redeem-ticket.

Example

import { useClient } from '@auth0/auth0-acul-react/redeem-ticket';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

Ce hook fournit des informations sur l’Organisation de l’utilisateur si l’échange du ticket est associé à une Organisation. Renvoie null lorsqu’aucun contexte d’Organisation n’est présent.

Example

import { useOrganization } from '@auth0/auth0-acul-react/redeem-ticket';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}

usePrompt · () => PromptMembers

Ce hook contient des données sur l’invite actuelle dans le flux d’authentification.

Example

import { usePrompt } from '@auth0/auth0-acul-react/redeem-ticket';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

Ce hook contient les détails propres à l’écran redeem-ticket, y compris sa configuration et son contexte.

Example

import { useScreen } from '@auth0/auth0-acul-react/redeem-ticket';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

Ce hook contient des données liées au locataire, comme id et les métadonnées associées.

Example

import { useTenant } from '@auth0/auth0-acul-react/redeem-ticket';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran redeem-ticket, comme les connexions actives et l’état actuel du flux.

Example

import { useTransaction } from '@auth0/auth0-acul-react/redeem-ticket';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

Ce hook fournit les données non fiables transmises à l’écran, comme les paramètres préremplis provenant de la chaîne de requête de l’URL.

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/redeem-ticket';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Ce hook fournit des détails sur l’utilisateur actif, notamment username, email et les méthodes d’authentification disponibles.

Example

import { useUser } from '@auth0/auth0-acul-react/redeem-ticket';
function UserProfile() {
  const user = useUser();
}

useRedeemTicket · RedeemTicketMembers

Ce hook renvoie toutes les méthodes et tout le contexte accessibles dans l’écran redeem-ticket.

​

Méthodes

continueMethod · Promise<void>

Cette méthode exécute l’action par défaut de l’écran redeem-ticket et poursuit le flux d’authentification une fois le ticket utilisé.

Example

import { useRedeemTicket } from '@auth0/auth0-acul-react/redeem-ticket';

function ContinueButton() {
  const { continueMethod } = useRedeemTicket();
  return (
    <button onClick={() => continueMethod()}>
      Continue
    </button>
  );
}

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration aplatie provenant du contexte d’image de marque.

useChangeLanguage · Hooks

Ce hook renvoie une fonction qui permet de changer la langue d’affichage de l’écran ACUL actuel.

useCurrentScreen · Hooks

Ce hook récupère le contexte et l’état de l’écran actuel.

useErrors · Hooks

Ce hook lit et gère les erreurs du serveur, du côté client et de développement à l’écran.