クエリフック
このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。
UIコンポーネントは、JS SDKパッケージで使用可能なクエリフックを使用してSitecore Search APIと通信します。このトピックでは、要求とクエリ結果を含むクエリ フック パターンについて説明し、JS SDKで使用できるさまざまなクエリ フックの一覧を示します。
Request
マーチャンダイジングウィジェットを設定してレンダリングするには、Reactフックを使用して、コンポーネントをWidgetProviderのReactQueryシングルトンにアタッチする必要があります。
SDKには、マーチャンダイジングウィジェットのタイプごとにクエリフックが用意されています。次の表では、SDKの一般的なクエリ フックについて説明します。
|
鍵 |
種類 |
形容 |
|---|---|---|
|
query |
Object |
使用するクエリ機能。ナロー結果に追加の要求値を設定できます。 |
|
widgetRef |
Object |
データを受信するReactコンポーネントを参照します。 |
|
actions |
Object |
ウィジェットがリクエストを設定するために使用するアクションまたはコールバック。各ウィジェットタイプには、独自のリストがあります。 |
|
state |
Object |
検索アルゴリズムによって使用されるウィジェットの状態を記述するパラメーター。 |
|
queryResult |
Object |
応答オブジェクトが含まれます。ウィジェットは、その値を読み取ることしかできません。 |
クエリ結果
queryResultクエリの実行中または実行後にのみ入力されます。これには、さまざまなステータス値と応答が含まれています。
|
鍵 |
種類 |
形容 |
|---|---|---|
|
isLoading |
ブーリアン |
trueの場合、クエリにはデータがなく、現在フェッチ中です。 |
|
isError |
ブーリアン |
trueの場合、クエリでエラーが発生しました。 |
|
isSuccess |
ブーリアン |
trueの場合、クエリは成功し、応答オブジェクトが使用可能です。 |
|
isFetching |
ブーリアン |
trueの場合、クエリはフェッチ中であり、バックグラウンドでのフェッチが含まれます。 |
|
data |
Object |
応答オブジェクト。 |
使用可能なクエリフック
アプリケーションでは、次のクエリフックを使用できます。
JS SDKには、ウィジェットをサポートするためのセカンダリ クエリ フック (ウィジェットやパンくずリストなど) も含まれています。