ログアウトの中止

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

logout-aborted 画面は、ユーザーがログアウトの試行をキャンセルまたは拒否した場合に表示されます。

​

インポート

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

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

Import Example

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

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

function LogoutAbortedScreen() {
  const screen = useLogoutAborted();
  // これは表示専用の画面です — 使用可能なアクションはありません。
  return <p>Logout was cancelled.</p>;
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

このフックは、logout-aborted 画面の id、name、logoUrl など、クライアントに関連する構成を提供します。

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

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

Example

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

useScreen · () => ScreenMembers

このフックには、構成やコンテキストを含む logout-aborted 画面固有の詳細が含まれます。

Example

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

useTenant · () => TenantMembers

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

Example

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

useTransaction · () => TransactionMembers

このフックは、アクティブな接続や現在のフローの state など、logout-aborted 画面のトランザクション固有のデータを提供します。

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useLogoutAborted · LogoutAbortedMembers

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

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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