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
站点应用程序编程接口 (Application Programming Interface, 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
全局对象可用于呈现和设置端点。
命令 | 任务 |
---|---|
从主机站点获取指定属性的值。 |
|
将指定属性的值设置为 |
|
从主机站点获取指定站点属性值。例如,它可以提取主机站点正在使用的当前主题设计。 |
|
向服务器发送消息,并接受 |
|
从主机站点发出的消息的消息监听程序。调用是异步进行的。这些是 JavaScript 回调,因此,该函数应使用 JavaScript 闭包或适当地绑定该函数,以确保它有权访问适当的上下文。 |
SitesSDK.Utils
SitesSDK.Utils
名称空间具有可由 Oracle Content Management 组件的所有端点调用的实用程序函数。此名称空间可用于远程组件的“设置”面板,但不可用于内嵌本地组件。
注意:
Oracle 官方不支持这些函数;它们用作示例实施。使用它们时需自担风险。命令 | 任务 |
---|---|
返回 Sites SDK 正在使用的日志记录程序对象。日志级别可以设置为以下级别之一:
|
|
将当前站点主题设计添加到组件。 |
|
Utils.getStyle(elem,styleProp) |
用于计算内嵌框架高度的实用程序方法。 |