ユニバーサルエディターの呼び出し calls
デバッグ時に役立つユニバーサルエディターによってアプリに対して行われる様々なタイプの呼び出しについて説明します。
概要 overview
ユニバーサルエディターは、一連の定義された呼び出しを通じて実装されたアプリと通信します。エンドユーザーエクスペリエンスに対しては、透過的で、影響はありません。
ただし、開発者にとって、これらの呼び出しとその動作を理解することは、ユニバーサルエディターを使用してアプリケーションをデバッグする際に役立ちます。アプリを実装したにもかかわらず、期待どおりに動作しない場合は、ブラウザーで開発者ツールの「ネットワーク」タブを開いて、アプリのコンテンツを編集する場合に呼び出しを検査すると役立つ場合があります。
- 呼び出しの ペイロード には、更新する内容と更新方法の識別など、エディターによって更新される内容の詳細が含まれます。
- 応答 には、エディターサービスによって更新された内容の正確な詳細が含まれます。これは、エディターでコンテンツを簡単に更新できるようにするためです。
move
呼び出しなどの特定の場合には、ページ全体を更新する必要があります。
呼び出しが正常に完了すると、リクエストと応答のペイロードを含むイベントがトリガーされます。これは、独自のアプリ用にカスタマイズできます。詳しくは、ユニバーサルエディターイベントドキュメントを参照してください。
ユニバーサルエディターがアプリに対して行う呼び出しのタイプのリストと、サンプルのペイロードおよび応答を次に示します。
アップデート update
ユニバーサルエディターを使用してアプリ内のコンテンツを編集すると、update
呼び出しが発生します。update
により変更が保持されます。
ペイロードには、JCR に書き戻す内容の詳細が含まれます。
resource
:更新する JCR パスprop
:更新する JCR プロパティtype
:更新するプロパティの JCR 値タイプvalue
:更新するデータ
code language-json |
---|
|
code language-json |
---|
|
詳細 details
ユニバーサルエディターでアプリを読み込み、アプリのコンテンツを取得すると、details
呼び出しが発生します。
ペイロードには、レンダリングされるデータと、ユニバーサルエディターでレンダリングできるようにデータが表す内容(スキーマ)の詳細が含まれます。
- コンポーネントの場合、データのスキーマはアプリで定義されているので、ユニバーサルエディターは
data
オブジェクトのみを取得します。 - コンテンツフラグメントの場合、コンテンツフラグメントモデルは JCR で定義されているので、ユニバーサルエディターは
schema
オブジェクトも取得します。
code language-json |
---|
|
code language-json |
---|
|
追加 add
ユニバーサルエディターを使用してアプリに新しいコンポーネントを配置すると、add
呼び出しが発生します。
ペイロードには、コンテンツを追加する場所を含む path
オブジェクトが含まれます。
また、各プラグインに保存されるコンテンツのエンドポイント固有の詳細に関する追加オブジェクトを含む content
オブジェクトも含まれます。 例えば、アプリが AEM および Magento のコンテンツに基づいている場合、ペイロードには各システムのデータオブジェクトが含まれます。
code language-json |
---|
|
code language-json |
---|
|
移動 move
ユニバーサルエディターを使用してアプリ内でコンポーネントを移動すると、move
呼び出しが発生します。
ペイロードには、コンポーネントの場所を定義する from
オブジェクトと、コンポーネントの移動場所を定義する to
オブジェクトが含まれます。
code language-json |
---|
|
code language-json |
---|
|
削除 remove
ユニバーサルエディターを使用してアプリ内のコンポーネントを削除すると、remove
呼び出しが発生します。
ペイロードには、削除されるオブジェクトのパスが含まれます。
code language-json |
---|
|
code language-json |
---|
|
公開 publish
ユニバーサルエディターの「公開」ボタンをクリックして、編集したコンテンツを公開すると、publish
呼び出しが発生します。
ユニバーサルエディターはコンテンツを反復して、公開する必要がある参照のリストを生成します。
code language-json |
---|
|
code language-json |
---|
|