27 Ссылка на Sites SDK

Пакет Oracle Content Management JavaScript SDK (Sites SDK) содержит набор функций, которые позволяют компонентам более тесно взаимодействовать с Oracle Content Management.

Sites SDK можно выгрузить с сервера Oracle Content Management:

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

Определения 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 Closure или необходимо должным образом привязать функцию, чтобы обеспечить ее доступ к соответствующему контексту.

SitesSDK.Utils

Пространство имен SitesSDK.Utils имеет служебные функции, которые могут вызываться всеми конечными точками компонента Oracle Content Management. Это пространство имен доступно для панели "Настройки" удаленного компонента, но не встроенного локального компонента.

Внимание.:

Эти функции официально не поддерживаются компанией Oracle; они предназначены для использования в качестве примеров реализации. Используйте их на свой страх и риск.

Команда	Задача
SitesSDK.Utils.Logger	Возвращает объект регистратора, используемый комплектом Sites SDK. Можно установить один из следующих уровней журнала: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Добавляет текущий проекта темы сайта в компонент.
Utils.getStyle(elem,styleProp)	Служебный метод, который рассчитывает высоту встроенной рамки.