MfaSmsList

Décrit tous les Hooks et toutes les méthodes disponibles pour personnaliser l’écran mfa-sms-list de Universal Login.

L’écran mfa-sms-list affiche une liste des numéros de téléphone enregistrés et permet à l’utilisateur d’en sélectionner un pour recevoir un code de vérification par SMS.

​

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 à la racine pour chaque écran.

• L’importation partielle vous permet d’inclure uniquement le code nécessaire à votre cas d’utilisation.
• L’importation à la 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 gère tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useMfaSmsList,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  backAction,
  selectPhoneNumber,
} from "@auth0/auth0-acul-react/mfa-sms-list";

function MfaSmsListScreen() {
  const { selectPhoneNumber } = useMfaSmsList();
  return (
    <button onClick={() => selectPhoneNumber({ index: 0 })}>
      Use This Phone Number
    </button>
  );
}

​

Hooks de contexte

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

Ce hook fournit des paramètres liés à l’application, comme id, name et logoUrl, pour l’écran mfa-sms-list.

Example

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

useOrganization · () => OrganizationMembers

Ce hook fournit des renseignements sur l’Organisation de l’utilisateur si le flux MFA est défini pour une Organisation. Renvoie null lorsqu’aucun contexte d’Organisation n’est présent.

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembers

Ce hook contient des détails propres à l’écran mfa-sms-list, y compris sa configuration et son contexte.

Example

import { useScreen } from '@auth0/auth0-acul-react/mfa-sms-list';
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/mfa-sms-list';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

Ce hook fournit des données propres à la transaction pour l’écran mfa-sms-list, comme l’état actuel du flux MFA.

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook expose les données non fiables transmises à l’écran, comme les valeurs préremplies à partir des paramètres d’URL.

Example

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

useUser · () => UserMembers

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

Example

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

useMfaSmsList · MfaSmsListMembers

Ce hook retourne toutes les méthodes et tout le contexte disponibles dans l’écran mfa-sms-list.

​

Méthodes

backAction · Promise<void>

Cette méthode permet de revenir à l’écran précédent dans le flux MFA.

Example

import { useMfaSmsList } from '@auth0/auth0-acul-react/mfa-sms-list';

function BackButton() {
  const { backAction } = useMfaSmsList();
  return (
    <button onClick={() => backAction()}>
      Go Back
    </button>
  );
}

selectPhoneNumber · Promise<void>

Cette méthode sélectionne un numéro de téléphone dans la liste des numéros inscrits à utiliser pour le défi SMS.

Example

import { useMfaSmsList } from '@auth0/auth0-acul-react/mfa-sms-list';

function PhoneNumberSelector() {
  const { selectPhoneNumber } = useMfaSmsList();
  return (
    <button onClick={() => selectPhoneNumber({ index: 0 })}>
      Use This Phone Number
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

MfaSmsListOptions.

index · number · requis

L’index du numéro de téléphone à sélectionner.

​

Hooks communs/utilitaires

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

Ce hook renvoie une fonction permettant de modifier 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 côté serveur, côté client et de développement à l’écran.