EmailOtpChallenge

Décrit tous les Hooks et toutes les méthodes disponibles pour personnaliser l’écran email-otp-challenge de Universal Login.

L’écran email-otp-challenge s’affiche lorsqu’un utilisateur doit vérifier son identité en saisissant un code à usage unique envoyé à son adresse courriel. Il permet à l’utilisateur de saisir le code ou d’en demander un nouveau.

​

Importation

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

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

Import Example

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

// importation partielle
import {
  useEmailOTPChallenge,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useResend,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  submitCode,
  resendCode,
} from '@auth0/auth0-acul-react/email-otp-challenge';

function EmailOtpChallengeScreen() {
  const { submitCode } = useEmailOTPChallenge();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>Submit</button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’organisation de l’utilisateur si le défi OTP s’applique à une organisation. Renvoie null lorsqu’aucun contexte d’organisation n’est présent.

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembersOnEmailOTPChallenge

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook traite 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/email-otp-challenge';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

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

useEmailOTPChallenge · EmailOTPChallengeMembers

Ce hook renvoie toutes les méthodes et le contexte disponibles pour l’écran email-otp-challenge.

​

Méthodes

resendCode · Promise<void>

Cette méthode renvoie le code à usage unique à l’adresse courriel de l’utilisateur.

Example

import { useEmailOTPChallenge } from '@auth0/auth0-acul-react/email-otp-challenge';

function ResendButton() {
  const { resendCode } = useEmailOTPChallenge();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}

submitCode · Promise<void>

Cette méthode transmet le code à usage unique saisi par l’utilisateur.

Example

import { useEmailOTPChallenge } from '@auth0/auth0-acul-react/email-otp-challenge';

function SubmitButton() {
  const { submitCode } = useEmailOTPChallenge();
  return (
    <button onClick={() => submitCode({ code: '123456' })}>
      Continue
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

OtpCodeOptions.

code · string · requis

Le code à usage unique saisi par l’utilisateur.

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

Ce hook permet d’obtenir les options du thème actuel avec une configuration aplatie à partir du contexte d’image de marque.

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

Ce hook permet d’obtenir le contexte et l’état de l’écran actuel.

useErrors · Hooks

Ce hook lit et gère les erreurs de serveur, d’application et de développeur à l’écran.

useResend · Hooks

Ce hook gère l’état de réenvoi et la logique de temporisation pour le code OTP par courriel.