メインコンテンツへスキップ
phone-identifier-challenge 画面は、ユーザーがワンタイムコードを入力して電話番号を確認する必要がある場合に表示されます。この画面では、ワンタイムコードの送信、再送、SMS 配信と音声通話配信の切り替え、または前の手順への戻り操作を行えます。
ACUL Phone Identifier Challenge

​
インポート

各画面には、それぞれ固有のフックとメソッドのセットがあります。SDK は、各画面で 部分インポート と ルートインポート をサポートしています。
  • 部分インポートを使用すると、特定のユースケースに必要なコードだけを含めることができます。
  • ルートインポートを使用すると、単一のバンドルからすべての画面を読み込めるため、想定されるすべての画面を 1 つのビルドで処理したい場合に便利です。
Import Example
// ルートインポート
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react';

// 部分インポート
import {
  usePhoneIdentifierChallenge,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  useResend,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  submitPhoneChallenge,
  resendCode,
  returnToPrevious,
  switchToText,
  switchToVoice,
} from '@auth0/auth0-acul-react/phone-identifier-challenge';

function PhoneIdentifierChallengeScreen() {
  const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => submitPhoneChallenge({ code: '123456' })}>Verify</button>
  );
}

​
コンテキストフック

phone-identifier-challenge 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープのフックです。@auth0/auth0-acul-react/phone-identifier-challenge からインポートします。
​
useBranding
() => BrandingMembers
このフックは、phone-identifier-challenge 画面に表示されるロゴ、色、テーマ設定などのブランディング構成を提供します。
Example
import { useBranding } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function CustomTheme() {
  const branding = useBranding();
}
​
useClient
() => ClientMembers
このフックは、phone-identifier-challenge 画面に関する id、name、logoUrl などのクライアント関連の構成を提供します。
Example
import { useClient } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function AppInfo() {
  const client = useClient();
}
​
useOrganization
() => OrganizationMembers
このフックは、電話番号チャレンジが組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は null を返します。
Example
import { useOrganization } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function OrgSelector() {
  const organization = useOrganization();
  if (!organization) {
    return <p>No Organization context</p>;
  }
}
​
usePrompt
() => PromptMembers
このフックには、認証フローにおける現在のプロンプトに関するデータが含まれます。
Example
import { usePrompt } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function FlowInfo() {
  const prompt = usePrompt();
}
​
useScreen
() => ScreenMembersOnPhoneIdentifierChallenge
このフックには、設定やコンテキストなど、phone-identifier-challenge 画面固有の詳細が含まれます。
Example
import { useScreen } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function ScreenDebug() {
  const screen = useScreen();
}
​
useTenant
() => TenantMembers
このフックには、id や関連するメタデータなど、テナントに関するデータが含まれます。
Example
import { useTenant } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function TenantInfo() {
  const tenant = useTenant();
}
​
useTransaction
() => TransactionMembers
このフックは、アクティブな接続や現在のフロー状態など、phone-identifier-challenge 画面に関するトランザクション固有のデータを提供します。
Example
import { useTransaction } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function TransactionInfo() {
  const transaction = useTransaction();
}
​
useUntrustedData
() => UntrustedDataMembers
このフックは、URL のクエリ文字列から事前入力されたパラメーターなど、画面に渡される信頼できないデータを扱います。
Example
import { useUntrustedData } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}
​
useUser
() => UserMembers
このフックは、username、email、利用可能な認証方法など、現在のユーザーに関する情報を提供します。
Example
import { useUser } from '@auth0/auth0-acul-react/phone-identifier-challenge';
function UserProfile() {
  const user = useUser();
}
​
usePhoneIdentifierChallenge
PhoneIdentifierChallengeMembers
このフックは、phone-identifier-challenge 画面で使用できるすべてのメソッドとコンテキストを返します。

​
メソッド

​
submitPhoneChallenge
Promise<void>
このメソッドは、ユーザーが入力したワンタイムコードを送信して電話番号を確認し、認証フローの次のステップに進みます。
Example
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function VerifyButton() {
  const { submitPhoneChallenge } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => submitPhoneChallenge({ code: '123456' })}>
      Verify
    </button>
  );
}
メソッドのパラメーター
​
resendCode
Promise<void>
このメソッドは、ユーザーの電話番号にワンタイムコードを再送信します。
Example
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function ResendButton() {
  const { resendCode } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}
​
returnToPrevious
Promise<void>
このメソッドは、ユーザーを認証フローの前のステップに戻します。
Example
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function BackButton() {
  const { returnToPrevious } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => returnToPrevious()}>
      Back
    </button>
  );
}
​
switchToText
Promise<void>
このメソッドは、電話番号確認の送信方法を SMS テキストメッセージに切り替えます。
Example
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function SwitchToSmsButton() {
  const { switchToText } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => switchToText()}>
      Send via SMS
    </button>
  );
}
​
switchToVoice
Promise<void>
このメソッドは、電話番号確認の送信方法を音声通話に切り替えます。
Example
import { usePhoneIdentifierChallenge } from '@auth0/auth0-acul-react/phone-identifier-challenge';

function SwitchToVoiceButton() {
  const { switchToVoice } = usePhoneIdentifierChallenge();
  return (
    <button onClick={() => switchToVoice()}>
      Send via Voice Call
    </button>
  );
}

​
共通/ユーティリティ フック

​
useAuth0Themes
Hooks
このフックは、ブランディングコンテキストからフラット化された設定を含む現在のテーマオプションを取得します。
​
useChangeLanguage
Hooks
このフックは、現在の ACUL 画面の表示言語を変更する関数を返します。
​
useCurrentScreen
Hooks
このフックは、現在の画面のコンテキストと state を取得します。
​
useErrors
Hooks
このフックは、画面上のサーバー、クライアント、開発者のエラーを読み取り、管理します。
​
useResend
Hooks
このフックは、resendCode メソッドの再送クールダウンの状態とタイマーを管理します。