RedeemTicket

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

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

​

インポート

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

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

Import Example

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

// 部分インポート
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>
  );
}

​

コンテキストフック

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

このフックは、チケットの引き換えが組織スコープである場合に、ユーザーの組織に関する情報を提供します。組織のコンテキストが存在しない場合は 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

このフックには、認証フローにおける現在のプロンプトに関するデータが含まれます。

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 画面のトランザクション固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

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

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

useErrors · Hooks

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