27 Referencia de SDK de Sites

El SDK (SDK de Sites) JavaScript de Oracle Content Management incluye un juego de funciones que permite a los componentes tener una experiencia más integrada con Oracle Content Management.

El SDK de Sites está disponible para su descarga desde el servidor de Oracle Content Management:

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

Las definiciones de la interfaz de programación de aplicaciones (API) de sitios cubren todos los espacios de nombres definidos del objeto global SitesSDK:

La finalidad principal del SDK de Sites es permitir a los usuarios crear y gestionar aplicaciones. Este proporciona varias funciones:

Comunicación en los límites de los marcos en línea y los dominios
- Permite a un componente comunicarse con una página independientemente de dónde esté alojado
- Incluye la participación en el ciclo de vida del modelo de página:
  - creación del componente
  - representación del componente con propiedades almacenadas
  - actualización del componente y guardado de dichos cambios
  - supresión del componente de la página
- Almacena y recupera la configuración personalizada utilizada para configurar un componente para utilizarla en una página
- Utiliza la comunicación entre componentes para formar parte de disparadores y acciones
La geometría indica una página (no se aplica a los componentes personalizados)
- Permite a una página cambiar el tamaño del marco en línea de forma dinámica cuando un componente le indica que lo haga
- Como resultado, el componente parecerá formar parte de una página y la página se moverá en respuesta a los eventos de cambio de tamaño del componente (sin barras de desplazamiento)
Conocimiento del componente de cuándo le llama Oracle Content Management
- La comunicación entre un componente y una página contiene un token firmado por una clave privada.
- El SDK de Sites permite a un componente descodificar el token y facilitar la verificación del emisor de la llamada.

Puede incluir funciones de SDK de Sites proporcionando una ruta de acceso conocida del script. Por ejemplo:

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

El SDK de Sites tiene los siguientes objetos globales:

SitesSDK
SitesSDK.Utils

SitesSDK

El objeto global SitesSDK se puede utilizar en puntos finales de representación y configuración.

Comando	Tarea
SitesSDK.getProperty(propertyName, callback)	Obtiene el valor de la propiedad especificada del sitio host.
SitesSDK.setProperty(propertyName, propertyValue)	Define el valor de la propiedad especificada en `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Obtiene el valor de una propiedad del sitio especificada del sitio host. Por ejemplo, puede recuperar el diseño de tema actual que está utilizando el sitio host.
SitesSDK.publish(messageType, payload)	Envía un mensaje al servidor y acepta un objeto `messageType` y JSON como carga útil.
SitesSDK.subscribe(messageType, callback)	Listener de mensajes para los mensajes distribuidos desde el sitio host. La llamada es asíncrona. A continuación se muestran devoluciones de llamada de JavaScript, por lo que la función debe utilizar un closure de JavaScript o se debe enlazar la función según sea necesario para garantizar que tiene acceso al contexto adecuado.

SitesSDK.Utils

El espacio de nombres SitesSDK.Utils tiene funciones de utilidad que pueden llamar todos los puntos finales de un componente de Oracle Content Management. Este espacio de nombres está disponible en el panel Configuración para un componente remoto, pero no para un componente local en línea.

Atención:

Estas funciones no están soportadas oficialmente por Oracle; han sido concebidas como implantaciones de ejemplo. Utilícelas bajo su propia responsabilidad.

Comando	Tarea
SitesSDK.Utils.Logger	Devuelve el objeto del registrador que está utilizando el SDK de Sites. El nivel de log se puede definir en una de las siguientes opciones: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Agrega el diseño de tema del sitio actual a un componente.
Utils.getStyle(elem,styleProp)	Método de utilidad que calcula la altura del marco en línea.