27 Sites SDK 參考資料

Oracle Content Management JavaScript SDK (Sites SDK) 提供一組函數,讓元件與 Oracle Content Management 的整合性更佳。

您可以從 Oracle Content Management 伺服器下載 Sites SDK:

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

Sites 應用程式設計介面 (API) 定義涵蓋 SitesSDK 全域物件的所有已定義命名空間:

Sites SDK 的主要目的是讓使用者可以建置及管理應用程式。它提供數項功能:

  • 跨內嵌框架和網域界限進行通訊

    • 無論代管位置在哪裡,元件都能與頁面進行通訊

    • 含括頁面模型生命週期:
      • 建立元件

      • 以儲存的特性呈現元件

      • 更新元件並儲存所做的變更

      • 刪除頁面中的元件

    • 儲存及擷取用來設定頁面中所用元件的自訂設定值

    • 使用元件間通訊來參與觸發程式和動作

  • 頁面的幾何提示 (不適用於自訂元件)

    • 頁面可依照元件指示,動態調整內嵌框架的大小

    • 元件顯示為頁面的一部分,頁面可移動以回應元件調整事件 (無捲軸)

  • 元件可感知 Oracle Content Management 的呼叫

    • 元件與頁面之間的通訊會有一個以私密金鑰簽署的權杖。

    • Sites SDK 可讓元件解碼權杖並加速呼叫者驗證。

若要包含 Sites SDK 函數,請提供已知的命令檔路徑。例如:

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

Sites SDK 包含以下的全域物件:

  • SitesSDK

  • SitesSDK.Utils

SitesSDK

SitesSDK 全域物件可在呈現和設定值端點中使用。

命令 工作

SitesSDK.getProperty(propertyName, callback)

從主機網站取得具名特性的值。

SitesSDK.setProperty(propertyName, propertyValue)

將具名特性的值設為 propertyValue

SitesSDK.getSiteProperty(propertyName, callback)

從主機網站取得具名的網站特性值。例如,可以擷取主機網站目前所使用的主題設計。

SitesSDK.publish(messageType, payload)

傳送訊息到伺服器,並接受 messageType 和 JSON 物件作為有效負載。

SitesSDK.subscribe(messageType, callback)

從主機網站分配之訊息的訊息監聽器。這是非同步呼叫。這些是 JavaScript 回呼,所以函數應使用 JavaScript 閉包或適當地連結函數,以確保能夠存取適當的內容。

SitesSDK.Utils

SitesSDK.Utils 命名空間包含 Oracle Content Management 元件之所有端點都可呼叫的公用程式函數。遠端元件的「設定值」面板提供此命名空間,內嵌本機元件的則沒有。

注意:

Oracle 並未正式支援這些函數;它們僅作為範例實行使用。若使用這些函數,需自行承擔風險。
命令 工作

SitesSDK.Utils.Logger

傳回 Sites SDK 目前使用的日誌記錄器物件。日誌層級可設為下列其中之一:
  • 除錯

  • 日誌

  • 資訊

  • 錯誤

  • 警告

SitesSDK.Utils.addSiteThemeDesign(cssUrl)

將目前的網站主題設計新增至元件。

Utils.getStyle(elem,styleProp)

計算內嵌框架高度的公用程式方法。