> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# PhoneIdentifierEnrollment
> Universal Login の `phone-identifier-enrollment` 画面をカスタマイズするために利用できる、すべてのフックとメソッドについて説明します。
`phone-identifier-enrollment` 画面は、ユーザーが識別子として電話番号を登録する必要がある場合に表示されます。この画面では、希望する確認方法 (SMS または音声通話) を選択し、登録プロセスを続行するか、前の手順に戻ることができます。
## インポート
各画面には、それぞれ固有のフックとメソッドのセットがあります。SDK は、各画面で**部分インポート**と**ルートインポート**をサポートしています。
* 部分インポートを使用すると、特定のユースケースに必要なコードだけを含めることができます。
* ルートインポートを使用すると、単一のバンドルからすべての画面を読み込めるため、想定されるすべての画面に対応する統一ビルドが必要な場合に便利です。
```jsx Import Example theme={null}
// ルートインポート
import { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react';
// 部分インポート
import {
usePhoneIdentifierEnrollment,
// コンテキストフック
useUser,
useTenant,
useBranding,
useClient,
useOrganization,
usePrompt,
useScreen,
useTransaction,
useUntrustedData,
// 共通フック
useCurrentScreen,
useAuth0Themes,
useErrors,
// ユーティリティフック
useChangeLanguage,
// メソッド
continuePhoneEnrollment,
returnToPrevious,
} from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function PhoneIdentifierEnrollmentScreen() {
const { continuePhoneEnrollment } = usePhoneIdentifierEnrollment();
return (
continuePhoneEnrollment({ type: 'text' })}>Send Code via SMS
);
}
```
## コンテキストフック
`phone-identifier-enrollment` 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープのフックです。`@auth0/auth0-acul-react/phone-identifier-enrollment` からインポートします。
() => BrandingMembers }>
このフックは、`phone-identifier-enrollment` 画面に表示されるロゴ、色、テーマ設定などのブランディング設定を提供します。
```jsx Example theme={null}
import { useBranding } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function CustomTheme() {
const branding = useBranding();
}
```
() => ClientMembers }>
このフックは、`phone-identifier-enrollment` 画面で使用される `id`、`name`、`logoUrl` などのクライアント関連の設定を提供します。
```jsx Example theme={null}
import { useClient } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function AppInfo() {
const client = useClient();
}
```
() => OrganizationMembers }>
このフックは、電話番号の登録が組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は `null` を返します。
```jsx Example theme={null}
import { useOrganization } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function OrgSelector() {
const organization = useOrganization();
if (!organization) {
return No Organization context
;
}
}
```
() => PromptMembers }>
このフックには、認証フロー内の現在のプロンプトに関するデータが含まれます。
```jsx Example theme={null}
import { usePrompt } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function FlowInfo() {
const prompt = usePrompt();
}
```
() => ScreenMembersOnPhoneIdentifierEnrollment }>
このフックには、設定やコンテキストなど、`phone-identifier-enrollment` 画面に固有の詳細が含まれます。
```jsx Example theme={null}
import { useScreen } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function ScreenDebug() {
const screen = useScreen();
}
```
() => TenantMembers }>
このフックには、`id` や関連するメタデータなど、テナントに関するデータが含まれます。
```jsx Example theme={null}
import { useTenant } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function TenantInfo() {
const tenant = useTenant();
}
```
() => TransactionMembers }>
このフックは、アクティブな接続や現在のフローの状態など、`phone-identifier-enrollment` 画面のトランザクション固有のデータを提供します。
```jsx Example theme={null}
import { useTransaction } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function TransactionInfo() {
const transaction = useTransaction();
}
```
() => UntrustedDataMembers }>
このフックは、URL クエリ文字列から事前入力されたパラメーターなど、画面に渡される信頼できないデータを提供します。
```jsx Example theme={null}
import { useUntrustedData } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function PrefilledForm() {
const untrustedData = useUntrustedData();
}
```
() => UserMembers }>
このフックでは、現在のユーザーの詳細 (`username`、`email`、利用可能な認証方法など) を取得できます。
```jsx Example theme={null}
import { useUser } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function UserProfile() {
const user = useUser();
}
```
PhoneIdentifierEnrollmentMembers}>
このフックは、`phone-identifier-enrollment` 画面で利用可能なすべてのメソッドとコンテキストを返します。
## メソッド
このメソッドは、ユーザーが希望する電話による確認方法を送信し、登録フローを続行します。
```jsx Example theme={null}
import { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function EnrollButton() {
const { continuePhoneEnrollment } = usePhoneIdentifierEnrollment();
return (
continuePhoneEnrollment({ type: 'text' })}>
Send Code via SMS
);
}
```
**メソッドのパラメーター**
[PhoneEnrollmentOptions](/ja/docs/libraries/acul/react-sdk/API-Reference/Types/interfaces/PhoneEnrollmentOptions)。
確認コードの送信方法です。SMS の場合は "text"、音声通話の場合は "voice" を使用します。
このメソッドは、ユーザーを認証フローの前のステップに戻します。
```jsx Example theme={null}
import { usePhoneIdentifierEnrollment } from '@auth0/auth0-acul-react/phone-identifier-enrollment';
function BackButton() {
const { returnToPrevious } = usePhoneIdentifierEnrollment();
return (
returnToPrevious()}>
Back
);
}
```
## 共通/ユーティリティフック
useAuth0Themes} type="Hooks">
このフックは、ブランディングコンテキストから、フラット化された設定を含む現在のテーマオプションを取得します。
useChangeLanguage} type="Hooks">
このフックは、現在のACUL画面の表示言語を変更するための関数を返します。
useCurrentScreen} type="Hooks">
このフックは、現在の画面のコンテキストと状態を取得します。
useErrors} type="Hooks">
このフックは、画面上のサーバー、クライアント、開発者のエラーを読み取って管理します。
