PhoneIdentifierEnrollment

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

L’écran phone-identifier-enrollment s’affiche lorsqu’un utilisateur doit inscrire un numéro de téléphone comme identifiant. Il permet à l’utilisateur de choisir 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.

​

Import

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.

• Un import partiel vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• Un import 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

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

// import partiel
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 propres à l’écran qui fournissent un accès en lecture seule aux données de contexte d’Auth0 sur l’écran phone-identifier-enrollment. Importez-les depuis @auth0/auth0-acul-react/phone-identifier-enrollment.

useBranding · () => BrandingMembers

Ce hook fournit les paramètres 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 les paramètres liés à l’application, 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 des informations sur l’Organisation de l’utilisateur si l’inscription du téléphone est limitée à une Organisation. Retourne null lorsqu’aucun contexte d’Organisation 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 l’invite actuelle 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.

Example

import { useScreen } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
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/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 expose 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/phone-identifier-enrollment';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

Ce hook fournit des informations sur l’utilisateur actif, y compris username, 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 renvoie toutes les méthodes et le contexte disponibles dans l’écran phone-identifier-enrollment.

​

Méthodes

continuePhoneEnrollment · Promise<void>

Cette méthode envoie la méthode de vérification par téléphone privilégiée par l’utilisateur et poursuit le flux d’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

La méthode 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 renvoie 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 et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration aplatie issue 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 du serveur, de l’application et du développeur à l’écran.