MfaCountryCodes

Décrit tous les hooks et toutes les méthodes disponibles pour personnaliser l’écran mfa-country-codes de Universal Login.

L’écran mfa-country-codes permet aux utilisateurs de parcourir la liste et de sélectionner un indicatif de pays pour les flux d’inscription à la MFA ou de vérification par téléphone.

​

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 voulez un build unifié capable de gérer tous les écrans possibles.

Import Example

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

// importation partielle
import {
  useMfaCountryCodes,
  // Hooks de contexte
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // Hooks communs
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // Hooks utilitaires
  useChangeLanguage,
  // Méthodes
  goBack,
  selectCountryCode,
} from "@auth0/auth0-acul-react/mfa-country-codes";

function MfaCountryCodesScreen() {
  const { selectCountryCode } = useMfaCountryCodes();
  return (
    <button onClick={() => selectCountryCode({ country_code: 'US', phone_prefix: '+1' })}>
      Select +1 (US)
    </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 mfa-country-codes. Importez-les depuis @auth0/auth0-acul-react/mfa-country-codes.

useBranding · () => BrandingMembers

Ce hook fournit la configuration d’image de marque, comme le logo, les couleurs et les paramètres de thème affichés sur l’écran mfa-country-codes.

Example

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

useClient · () => ClientMembers

Ce hook fournit la configuration liée à l’application, comme id, name et logoUrl, pour l’écran mfa-country-codes.

Example

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

useOrganization · () => OrganizationMembers

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

Example

import { useOrganization } from '@auth0/auth0-acul-react/mfa-country-codes';
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/mfa-country-codes';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnMfaCountryCodes

Ce hook contient des détails propres à l’écran mfa-country-codes, y compris la liste des indicatifs de pays disponibles et le contexte actuel de l’écran.

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

Ce hook gère 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-country-codes';
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-country-codes';
function UserProfile() {
  const user = useUser();
}

useMfaCountryCodes · MfaCountryCodesMembers

Ce hook renvoie toutes les méthodes et le contexte disponibles à l’écran mfa-country-codes.

​

Méthodes

goBack · Promise<void>

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

Example

import { useMfaCountryCodes } from '@auth0/auth0-acul-react/mfa-country-codes';

function BackButton() {
  const { goBack } = useMfaCountryCodes();
  return (
    <button onClick={() => goBack()}>
      Back
    </button>
  );
}

selectCountryCode · Promise<void>

Cette méthode confirme l’indicatif de pays sélectionné et ramène l’utilisateur à l’écran d’inscription ou de vérification.

Example

import { useMfaCountryCodes } from '@auth0/auth0-acul-react/mfa-country-codes';

function CountryCodePicker() {
  const { selectCountryCode } = useMfaCountryCodes();
  return (
    <button onClick={() => selectCountryCode({ country_code: 'US', phone_prefix: '+1' })}>
      Select +1 (US)
    </button>
  );
}

Paramètres de la méthode

Afficher Paramètres

options

SelectCountryCodeOptions.

country_code · string · requis

L’indicatif de pays (p. ex. "US", "GB").

phone_prefix · string · requis

L’indicatif téléphonique (p. ex. "+1", "+44").

​

Hooks communs et utilitaires

useAuth0Themes · Hooks

Ce hook récupère les options du thème actuel avec une configuration aplatie depuis le 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 récupère le contexte et le state de l’écran actuel.

useErrors · Hooks

Ce hook permet de lire et de gérer les erreurs côté serveur, côté application et côté développeur sur l’écran.