DeviceCodeActivationAllowed

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

device-code-activation-allowed 画面は、ユーザーがデバイスを正常に有効化した後に表示されます。デバイスが認可され、有効化フローが完了したことを示します。

​

インポート

各画面には、それぞれ固有のフックとメソッドがあります。SDK は、各画面で partial import と root import をサポートしています。

• partial import を使用すると、特定の用途に必要なコードだけを取り込めます。
• root import を使用すると、単一のバンドルからすべての画面を読み込めるため、想定されるすべての画面を 1 つの統合ビルドで扱いたい場合に便利です。

Import Example

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

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

function DeviceCodeActivationAllowedScreen() {
  const { screen } = useDeviceCodeActivationAllowed();
  return <p>Device successfully activated on {screen.name}</p>;
}

​

コンテキストフック

device-code-activation-allowed 画面で、Auth0 のコンテキストデータへの読み取り専用アクセスを提供する、画面にスコープが設定されたフックです。@auth0/auth0-acul-react/device-code-activation-allowed からインポートします。

useBranding · () => BrandingMembers

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

Example

import { useBranding } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function CustomTheme() {
  const branding = useBranding();
}

useClient · () => ClientMembers

このフックは、device-code-activation-allowed 画面の id、name、logoUrl など、クライアント関連の設定を提供します。

Example

import { useClient } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function AppInfo() {
  const client = useClient();
}

useOrganization · () => OrganizationMembers

このフックは、デバイスアクティベーションが組織にスコープが設定されている場合に、ユーザーの組織に関する情報を提供します。組織コンテキストが存在しない場合は null を返します。

Example

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

usePrompt · () => PromptMembers

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

Example

import { usePrompt } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function FlowInfo() {
  const prompt = usePrompt();
}

useScreen · () => ScreenMembers

このフックには、設定やコンテキストを含む device-code-activation-allowed 画面固有の詳細が含まれます。

Example

import { useScreen } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function ScreenDebug() {
  const screen = useScreen();
}

useTenant · () => TenantMembers

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

Example

import { useTenant } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function TenantInfo() {
  const tenant = useTenant();
}

useTransaction · () => TransactionMembers

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

Example

import { useTransaction } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function TransactionInfo() {
  const transaction = useTransaction();
}

useUntrustedData · () => UntrustedDataMembers

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

Example

import { useUntrustedData } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function PrefilledForm() {
  const untrustedData = useUntrustedData();
}

useUser · () => UserMembers

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

Example

import { useUser } from '@auth0/auth0-acul-react/device-code-activation-allowed';
function UserProfile() {
  const user = useUser();
}

useDeviceCodeActivationAllowed · DeviceCodeActivationAllowedMembers

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

​

共通/ユーティリティ Hooks

useAuth0Themes · Hooks

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

useChangeLanguage · Hooks

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

useCurrentScreen · Hooks

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

useErrors · Hooks

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