LogoutComplete

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

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

​

インポート

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

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

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

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

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

このフックは、アクティブな接続や現在のフローの状態など、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

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

useErrors · Hooks

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