EmailVerificationResult

Universal Login の email-verification-result 画面をカスタマイズするために利用できる、すべてのフックとメソッドについて説明します。

email-verification-result 画面は、ユーザーがメール確認プロセスを完了した後に表示されます。確認が成功したか、失敗したかが表示されます。

​

インポート

各画面には、それぞれ固有のフックとメソッドがあります。SDK は、各画面で部分インポートとルートインポートをサポートしています。

• 部分インポートを使用すると、特定のユースケースに必要なコードだけを含めることができます。
• ルートインポートを使用すると、1 つのバンドルからすべての画面を読み込めるため、あらゆる画面に対応できる単一のビルドを使いたい場合に便利です。

Import Example

// ルートインポート
import { useEmailVerificationResult } from '@auth0/auth0-acul-react';

// 部分インポート
import {
  useEmailVerificationResult,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
} from '@auth0/auth0-acul-react/email-verification-result';

function EmailVerificationResultScreen() {
  const { screen } = useEmailVerificationResult();
  return <p>{screen.name}</p>;
}

​

コンテキストフック

email-verification-result 画面で、Auth0 のコンテキストデータへの読み取り専用アクセスを提供する画面スコープのフックです。@auth0/auth0-acul-react/email-verification-result からインポートします。

useBranding · () => BrandingMembers

このフックは、email-verification-result 画面に表示されるロゴ、色、テーマ設定などのブランディング設定を提供します。

Example

import { useBranding } from '@auth0/auth0-acul-react/email-verification-result';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

このフックは、email-verification-result 画面における id、name、logoUrl などのクライアント関連の設定を提供します。

Example

import { useClient } from '@auth0/auth0-acul-react/email-verification-result';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

このフックは、メール確認が組織スコープの場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は null を返します。

Example

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

usePrompt · () => PromptMembers

このフックには、認証フロー内の現在の prompt に関するデータが含まれます。

Example

import { usePrompt } from '@auth0/auth0-acul-react/email-verification-result';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembersOnEmailVerificationResult

このフックには、設定やコンテキストなど、email-verification-result 画面に固有の詳細が含まれます。

Example

import { useScreen } from '@auth0/auth0-acul-react/email-verification-result';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

このフックには、id や関連するメタデータなど、テナントに関するデータが含まれます。

Example

import { useTenant } from '@auth0/auth0-acul-react/email-verification-result';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

このフックは、アクティブな接続や現在のフローの状態など、email-verification-result 画面における transaction 固有のデータを提供します。

Example

import { useTransaction } from '@auth0/auth0-acul-react/email-verification-result';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

このフックは、URL のクエリ文字列から事前入力されたパラメータなど、画面に渡される信頼されていないデータを扱います。

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/email-verification-result';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

このフックは、username、email、利用可能な認証方法など、現在のユーザーに関する詳細を提供します。

Example

import { useUser } from '@auth0/auth0-acul-react/email-verification-result';
function UserProfile() {
  const user = useUser();
}

useEmailVerificationResult · EmailVerificationResultMembers

このフックは、email-verification-result 画面で利用できるすべてのメソッドとコンテキストを返します。

​

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

useAuth0Themes · Hooks

このフックは、ブランディング コンテキストからフラット化された設定を含む現在のテーマオプションを取得します。

useChangeLanguage · Hooks

このフックは、現在の ACUL 画面の表示言語を変更する関数を返します。

useCurrentScreen · Hooks

このフックは、現在の画面のコンテキストと state を取得します。

useErrors · Hooks

このフックは、画面上のサーバー、クライアント、開発者のエラーを読み取り、管理します。