LogoutAborted

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>;
}

​

コンテキストHooks

logout-aborted 画面で Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面スコープのHooksです。@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

このフックには、authentication flow における現在の prompt に関するデータが含まれています。

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

このフックは、アクティブな接続や現在のフローの状態など、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 画面で利用できるすべてのメソッドとコンテキストを返します。

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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