PhoneIdentifierEnrollment

Décrit tous les hooks et les méthodes disponibles pour personnaliser l’écran phone-identifier-enrollment de Universal Login.

L’écran phone-identifier-enrollment s’affiche lorsqu’un utilisateur doit inscrire un numéro de téléphone comme identifiant. Il lui permet de sélectionner sa méthode de vérification préférée (SMS ou appel vocal), puis de poursuivre le processus d’inscription ou de revenir à l’étape précédente.

​

Importation

Chaque écran a 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 voulez qu’un build unifié prenne en charge tous les écrans possibles.

Import Example

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

// importation partielle
import {
  usePhoneIdentifierEnrollment,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  continuePhoneEnrollment,
  returnToPrevious,
} from '@auth0/auth0-acul-react/phone-identifier-enrollment';

function PhoneIdentifierEnrollmentScreen() {
  const { continuePhoneEnrollment } = usePhoneIdentifierEnrollment();
  return (
    <button onClick={() => continuePhoneEnrollment({ type: 'text' })}>Send Code via SMS</button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

Ce hook fournit les configurations d’image de marque, comme le logo, les couleurs et les paramètres de thème affichés sur l’écran phone-identifier-enrollment.

Example

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

useClient · () => ClientMembers

Ce hook fournit des configurations liées au client, comme id, name et logoUrl, pour l’écran phone-identifier-enrollment.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit de l’information sur l’Organization de l’utilisateur si l’inscription du téléphone est associée à une Organization. Retourne null lorsqu’aucun contexte Organization n’est présent.

Example

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

usePrompt · () => PromptMembers

Ce hook contient des données sur le prompt actuel dans le flux d’authentification.

Example

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

useScreen · () => ScreenMembersOnPhoneIdentifierEnrollment

Ce hook contient des détails propres à l’écran phone-identifier-enrollment, y compris sa configuration et son contexte.

L’objet screen.data expose trois champs facultatifs : phone, messageType et username. Utilisez screen.data?.username pour afficher le nom d’utilisateur associé à la session d’inscription actuelle.

Example

import { useScreen } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function ScreenDebug() {
  const screen = useScreen();
  const username = screen.data?.username;
}

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère les données non fiables transmises à l’écran, comme des paramètres préremplis provenant de chaînes de requête d’URL.

Example

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

useUser · () => UserMembers

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

Example

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

usePhoneIdentifierEnrollment · PhoneIdentifierEnrollmentMembers

Ce hook retourne toutes les méthodes et tout le contexte disponibles sur l’écran phone-identifier-enrollment.

​

Méthodes

continuePhoneEnrollment · Promise<void>

Cette méthode envoie le mode de vérification téléphonique privilégié par l’utilisateur et poursuit l’inscription.

Example

import { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react/phone-identifier-enrollment';

function EnrollButton() {
  const { continuePhoneEnrollment } = usePhoneIdentifierEnrollment();
  return (
    <button onClick={() => continuePhoneEnrollment({ type: 'text' })}>
      Envoyer le code par SMS
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

PhoneEnrollmentOptions.

type · "text" | "voice" · requis

Le mode d’envoi du code de vérification. Utilisez “text” pour les SMS ou “voice” pour un appel téléphonique.

returnToPrevious · Promise<void>

Cette méthode ramène l’utilisateur à l’étape précédente du flux d’authentification.

Example

import { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react/phone-identifier-enrollment';

function BackButton() {
  const { returnToPrevious } = usePhoneIdentifierEnrollment();
  return (
    <button onClick={() => returnToPrevious()}>
      Retour
    </button>
  );
}

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

Ce hook récupère 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 sur 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 côté serveur, côté client et côté développeur sur l’écran.