LogoutComplete

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

logout-complete 画面は、ユーザーがログアウト処理を正常に完了すると表示されます。

​

インポート

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

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

Import Example

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

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

function LogoutCompleteScreen() {
  const screen = useLogoutComplete();
  // これは表示専用の画面です — 利用可能なアクションはありません。
  return <p>You have been signed out.</p>;
}

​

コンテキストフック

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

useBranding · () => BrandingMembers

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

Example

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

useClient · () => ClientMembers

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

Example

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

useOrganization · () => OrganizationMembers

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

Example

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

usePrompt · () => PromptMembers

このフックは、認証フロー内の現在のプロンプトに関するデータを提供します。

Example

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

useScreen · () => ScreenMembers

このフックは、設定やコンテキストなど、logout-complete 画面固有の詳細を提供します。

Example

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

useTenant · () => TenantMembers

このフックは、id や関連メタデータなど、テナントに関するデータを提供します。

Example

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

useTransaction · () => TransactionMembers

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

Example

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

useUntrustedData · () => UntrustedDataMembers

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

Example

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

useUser · () => UserMembers

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

Example

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

useLogoutComplete · LogoutCompleteMembers

このフックは、logout-complete 画面で利用可能なすべてのメソッドとコンテキストを返します。

​

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

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

このフックは、画面上のサーバー、クライアント、開発者の各エラーを参照および管理します。