LoginEmailVerification

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

login-email-verification 画面では、ログインフロー中の本人確認のために、メールアドレスに送信された確認コードを入力するようユーザーに求めます。

​

インポート

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

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

Import Example

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

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

function LoginEmailVerificationForm() {
  const { continueWithCode } = useLoginEmailVerification();
  return (
    <button onClick={() => continueWithCode({ code: '123456' })}>
      Verify
    </button>
  );
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

このフックは、URL のクエリ文字列のパラメータなど、画面に渡される信頼できないデータを扱います。

Example

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

useUser · () => UserMembers

このフックは、username、email、利用可能な認証方法など、現在アクティブなユーザーの詳細情報を提供します。

Example

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

useLoginEmailVerification · LoginEmailVerificationMembers

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

​

メソッド

continueWithCode · Promise<void>

このメソッドは、ユーザーが入力した確認コードを送信し、メールアドレスの確認を進めます。

Example

import { useLoginEmailVerification } from '@auth0/auth0-acul-react/login-email-verification';

function VerifyEmail() {
  const { continueWithCode } = useLoginEmailVerification();
  return (
    <button onClick={() => continueWithCode({ code: '123456' })}>
      Verify
    </button>
  );
}

メソッドのパラメーター

表示 パラメーター

options

ContinueWithCodeOptionPayload。

code · string · 必須

ユーザーのメールアドレスに送信された確認コード。

resendCode · Promise<void>

このメソッドは、ユーザーのメールアドレスに新しい確認コードを送信するようリクエストします。

Example

import { useLoginEmailVerification } from '@auth0/auth0-acul-react/login-email-verification';

function ResendCode() {
  const { resendCode } = useLoginEmailVerification();
  return (
    <button onClick={() => resendCode()}>
      Resend Code
    </button>
  );
}

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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

useResend · Hooks

このフックは、コード再送時の再送待機状態と利用可否を管理します。