RedeemTicket

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

redeem-ticket 画面は、招待の承諾やメールアドレスの確認など、認証フローを続行するためにユーザーがチケットを引き換える必要がある場合に表示されます。

​

インポート

各画面には、それぞれ固有のフックとメソッドのセットがあります。SDK は各画面で partial import と root import をサポートしています。

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

Import Example

// root import
import { useRedeemTicket } from '@auth0/auth0-acul-react';

// partial import
import {
  useRedeemTicket,
  // コンテキストフック
  useUser,
  useTenant,
  useBranding,
  useClient,
  useOrganization,
  usePrompt,
  useScreen,
  useTransaction,
  useUntrustedData,
  // 共通フック
  useCurrentScreen,
  useAuth0Themes,
  useErrors,
  // ユーティリティフック
  useChangeLanguage,
  // メソッド
  continueMethod,
} from '@auth0/auth0-acul-react/redeem-ticket';

function RedeemTicketScreen() {
  const { continueMethod } = useRedeemTicket();
  return (
    <button onClick={() => continueMethod()}>Continue</button>
  );
}

​

Context Hooks

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembers

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

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

このフックは、URL の query string から事前入力されたパラメータなど、画面に渡された信頼できないデータを扱います。

Example

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

useUser · () => UserMembers

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

Example

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

useRedeemTicket · RedeemTicketMembers

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

​

メソッド

continueMethod · Promise<void>

このメソッドは redeem-ticket 画面でデフォルトのアクションを実行し、チケットの引き換え後に認証フローを続行します。

Example

import { useRedeemTicket } from '@auth0/auth0-acul-react/redeem-ticket';

function ContinueButton() {
  const { continueMethod } = useRedeemTicket();
  return (
    <button onClick={() => continueMethod()}>
      Continue
    </button>
  );
}

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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