コンテンツフラグメントセレクター - 関連プロパティ content-fragment-selector-related-properties

マイクロフロントエンドコンテンツフラグメントセレクターを使用すると、リポジトリ内のコンテンツフラグメントを参照または検索し、アプリケーションで使用できます。

次のプロパティを使用して、コンテンツフラグメントセレクターのレンダリング方法と使用方法をカスタマイズできます。

コンテンツフラグメントセレクターのプロパティ content-fragment-selector-properties

Property
タイプ
必須
デフォルト
説明
imsToken
文字列
いいえ
認証に使用される IMS トークンです。
repoId
文字列
いいえ
認証に使用されるリポジトリ ID です。
orgId
文字列
はい
認証に使用される組織 ID です。
locale
文字列
いいえ
ロケールデータです。
env
環境
いいえ
コンテンツフラグメントセレクターのデプロイメント環境です。
filters
FragmentFilter
いいえ
コンテンツフラグメントのリストに適用するフィルターです。デフォルトでは、/content/dam の下にあるフラグメントが表示されます。デフォルト値:{ folder: "/content/dam" }
isOpen
ブール値
はい
false
セレクターを開くまたは閉じることをトリガーするフラグです。
onDismiss
() => void
はい
Dismiss を選択した際に呼び出される関数です。
onSubmit
({ contentFragments: {id: string, path: string}[], domainNames: string[] }) => void
はい

1 つ以上のコンテンツフラグメントを選択した後に Select を使用した際に呼び出される関数です。

関数は、以下を受け取ります。

  • id フィールドと path フィールドを含む、選択したコンテンツフラグメント
  • リポジトリのプログラム ID と環境 ID に関連するドメイン名(ステータスが readytier がパブリッシュ)

ドメイン名がない場合は、パブリッシュインスタンスがフォールバックドメインとして使用されます。

theme
「light」または「dark」
いいえ
コンテンツフラグメントセレクターのテーマです。デフォルトのテーマは、UnifiedShell 環境のテーマに設定されています。
selectionType
「single」または「multiple」
いいえ
single
FragmentSelector の選択を制限するために使用できる選択タイプです。
dialogSize
「fullscreen」または「fullscreenTakeover」
いいえ
fullscreen
ダイアログのサイズを制御するオプションのプロパティです。
waitForImsToken
ブール値
いいえ
false
コンテンツフラグメントセレクターが SUSI フローのコンテキストでレンダリングされ、imsToken の準備が整うまで待機する必要があるかどうかを示します。
imsAuthInfo
ImsAuthInfo
いいえ
ログインしたユーザーの IMS 認証情報を含むオブジェクトです。
runningInUnifiedShell
ブール値
いいえ
コンテンツフラグメントセレクターが UnifiedShell の下で実行されているか、スタンドアロンで実行されているかを示します。
readonlyFilters
ResourceReadonlyFiltersField
いいえ
コンテンツのリストに適用できる読み取り専用フィルターです - 削除できません。

ImsAuthProps プロパティ imsauthprops-properties

ImsAuthProps プロパティは、コンテンツフラグメントセレクターが imsToken を取得するのに使用する認証情報とフローを定義します。これらのプロパティを設定すると、認証フローの動作を制御し、様々な認証イベントのリスナーを登録できます。

プロパティ名
説明
imsClientId
認証目的で使用される IMS クライアント ID を表す文字列値。この値はアドビが指定し、アドビの AEM CS 組織に固有です。
imsScope
認証で使用されるスコープについて説明します。スコープは、組織のリソースに対するアプリケーションのアクセスレベルを決定します。複数のスコープは、コンマで区切ることができます。
redirectUrl
認証後にユーザーがリダイレクトされる URL を表します。この値は通常、アプリケーションの現在の URL に設定されます。redirectUrl を指定していない場合、ImsAuthServiceimsClientId の登録に使用した redirectUrl を使用します。
modalMode
認証フローをモーダル(ポップアップ)に表示するかどうかを示すブール値。true に設定すると、認証フローがポップアップで表示されます。false に設定すると、認証フローはページ全体をリロードして表示されます。
メモ: UX を向上させるために、ユーザーがブラウザーのポップアップを無効にしている場合は、この値を動的に制御できます。
onImsServiceInitialized
Adobe IMS 認証サービスを初期化する際に呼び出されるコールバック関数。この関数は、Adobe IMS サービスを表すオブジェクトである service という 1 つのパラメーターを受け取ります。詳しくは、ImsAuthService を参照してください。
onAccessTokenReceived
Adobe IMS 認証サービスから imsToken を受信する際に呼び出されるコールバック関数。この関数は、アクセストークンを表す文字列である imsToken という 1 つのパラメーターを受け取ります。
onAccessTokenExpired
アクセストークンの有効期限が切れる際に呼び出されるコールバック関数。この関数は通常、新しい認証フローをトリガーして新しいアクセストークンを取得するために使用されます。
onErrorReceived
認証中にエラーが発生する際に呼び出されるコールバック関数。この関数は、エラータイプとエラーメッセージという 2 つのパラメーターを受け取ります。エラータイプはエラータイプを表す文字列で、エラーメッセージはエラーメッセージを表す文字列です。

ImsAuthService プロパティ imsauthservice-properties

ImsAuthService クラスは、コンテンツフラグメントセレクターの認証フローを処理します。これは、Adobe IMS 認証サービスから imsToken を取得する役割を果たします。imsToken は、ユーザーを認証し、Adobe Experience Manager(AEM)CS リポジトリへのアクセスを認証するのに使用されます。ImsAuthService は、ImsAuthProps プロパティを使用して認証フローを制御し、様々な認証イベントのリスナーを登録します。便利な registerContentFragmentSelectorAuthService 関数を使用して、ImsAuthService インスタンスをコンテンツフラグメントセレクターに登録できます。ImsAuthService クラスでは、次の関数を使用できます。ただし、registerContentFragmentSelectorAuthService 関数を使用している場合は、これらの関数を直接呼び出す必要はありません。

関数名
説明
isSignedInUser
ユーザーが現在サービスにログインしているかどうかを判断し、それに応じてブール値を返します。
getImsToken
現在ログインしているユーザーの認証 imsToken を取得します。これは、アセット​ レンディション ​の生成など、他のサービスへのリクエストを認証するのに使用できます。
signIn
ユーザーのログインプロセスを開始します。この関数は、ImsAuthProps を使用して、ポップアップまたはページ全体のリロードで認証を表示します。
signOut
ユーザーをサービスからログアウトし、認証トークンを無効にし、保護されたリソースにアクセスするには再度ログインするようにリクエストします。この関数を呼び出すと、現在のページがリロードされます。
refreshToken
現在ログインしているユーザーの認証トークンを更新して、トークンの有効期限切れを防ぎ、保護されたリソースに中断なくアクセスできるようになります。後続のリクエストに使用できる新しい認証トークンを返します。
recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab