サイト・レンダリングAPI

Oracle Content Managementの「サイト・レンダリングAPI」 (SCSRenderAPI)は、すべてのOracle Content Management webページに存在するウィンドウ・グローバル・オブジェクトです。これは主にページのスロットおよびコンポーネントのレンダリングを担当し、テーマ・レイアウトに存在するJavaScriptコードのインタフェースを提供します。テーマまたはコンポーネントを開発者として作業している場合、これらのイベントと関数が表示されることがあります。runtime SCSRenderAPIでは表示モードとプレビュー表示モードがレンダリングされますが、「設計時」 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イベントを処理することで、Sites Rendering APIの可用性をリスニングできます。