サイト・レンダリングAPI

Oracle Content Managementのサイト・レンダリングAPI (SCSRenderAPI)は、Oracle Content ManagementのすべてのWebページに存在するwindow-globalオブジェクトです。主に、ページのスロットやコンポーネントのレンダリングを行い、テーマ・レイアウトに存在するJavaScriptコードのインタフェースとなります。開発者としてテーマまたはコンポーネントの作業に当たっている場合に、これらのイベントや関数を見かける可能性があります。runtime SCSRenderAPIは、ビューやプレビューの表示モードをレンダリングし、design time SCSRenderAPIは、ナビゲーションや編集、注釈の表示モードをレンダリングします。

実行時、サイト・レンダリングAPIには、次に示す3つの汎用的な目的があります:

ページのスロットに、コンポーネントおよびコンテンツを移入する。
ページ・レイアウトにあるJavaScriptコードの情報リクエストに対応する。
ページレンダリング・プロセスのライフサイクル中にイベントを呼び出す。

設計時、サイト・レンダリングAPIには、次に示す4つの汎用的な目的があります:

ページのスロットに、コンポーネントおよびコンテンツを移入する。
ページ・レイアウトにあるJavaScriptコードの情報リクエストに対応する。
ページレンダリングおよび編集プロセスのライフサイクル中にイベントを呼び出す。
ページの編集や注釈を可能にするために、サイト・ビルダーとやり取りする。

サイト・レンダリングAPIは、テーマ・レイアウトに次のスクリプト・タグを配置することで、Oracle Content ManagementのWebページにロードされます:

<script data-main="/_sitescloud/renderer/renderer.js" src="/_sitescloud/renderer/require.js"></script>

これは通常、レイアウトの下部に配置されます。(このタグのURLは、設計時または実行時の適切な環境に合せて自動的に調整されます。)SCSRenderAPIオブジェクトは非同期でロードされます。カスタムのJavaScriptコードは、scsrenderstartイベントを処理することで、サイト・レンダリングAPIの可用性をリスニングできます。