27 サイトSDKリファレンス

Oracle Content Management JavaScript SDK (サイトSDK)には、コンポーネントがOracle Content Managementと統合されたエクスペリエンスを持つことを実現する一連の機能があります。

サイトSDKは、Oracle Content Managementサーバーからダウンロードできます:

http://{server}/_sitesclouddelivery/renderer/app/sdk/js/sites.min.js

サイトのアプリケーション・プログラミング・インタフェース(API)定義は、グローバル・オブジェクトSitesSDKのすべての定義済ネームスペースに対応しています:

• SitesSDK.getProperty('componentAssets', callback)

• SitesSDK.getProperty(propertyName, callback)

• SitesSDK.getSiteProperty(propertyName, callback)

• SitesSDK.setProperty('componentAssets’, [assets])

• SitesSDK.setProperty(propertyName, propertyValue)

• SitesSDK.filePicker({options}, callback)

• SitesSDK.openDocumentPicker(options)

• SitesSDK.publish(messageType, payload)

• SitesSDK.subscribe(messageType, callback)

• SitesSDK.Utils.addSiteThemeDesign(cssUrl)

• SitesSDK.Utils.Logger

サイトSDKの主要目的は、ユーザーがアプリケーションを構築および管理できるようにすることです。次の複数の機能が用意されています:

• インライン・フレームおよびドメインの境界をまたぐやり取り

  • コンポーネントがホストされている場所に関係なく、コンポーネントがページとやり取りできるようにします

  • 次のページ・モデル・ライフ・サイクルへの参加が含まれます:

    • コンポーネントの作成

    • 格納されたプロパティによるコンポーネントのレンダリング

    • コンポーネントの更新およびそれらの変更内容の保存

    • ページからのコンポーネントの削除

  • ページ内で使用するために、コンポーネントの構成に使用されるカスタム設定を格納および取得します

  • コンポーネント間のやり取りを使用してトリガーとアクションに関与します

• ページへのジオメトリ・ヒント(カスタム・コンポーネントには当てはまらない)

  • コンポーネントによって指示されたときにページでインライン・フレームを動的にサイズ変更できるようにします

  • コンポーネントがページの一部として表示されるようになり、コンポーネントのサイズ変更イベントに応じてページが移動されるようになります(スクロール・バーなし)

• Oracle Content Managementによっていつ呼び出されたかに関するコンポーネントの認識

  • コンポーネントとページとの間のやり取りには、秘密キーによって署名されたトークンが含まれています。

  • サイトSDKにより、コンポーネントで、トークンをデコードすることや、呼出し元の確認を容易にすることができます。

スクリプトの既知のパスを提供することにより、サイトSDKの関数を含めます。例:

<script type="text/javascript" 
src="<sdk_install_dir_path_prefix>/sites.min.js">
</script>

サイトSDKには、次のグローバル・オブジェクトがあります:

• SitesSDK

• SitesSDK.Utils