27 Referência do Sites SDK

O Oracle Content Management JavaScript SDK (Sites SDK) tem um conjunto de funções que permitem uma experiência mais integrada dos componentes com o Oracle Content Management.

O Sites SDK está disponível para ser descarregado a partir do servidor do Oracle Content Management:

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

As definições da Interface de Programação de Aplicações (API) de Sites abrangem todos os namespaces definidos do objeto global SitesSDK:

O objetivo principal do Sites SDK é permitir aos utilizadores criar e gerir aplicações. Fornece várias funcionalidades:

Comunicação além dos limites do domínio e da moldura inline
- Permite que um componente comunique com uma página independentemente do local onde o componente está alojado
- Inclui a participação no ciclo de vida do modelo da página:
  - criar o componente
  - renderizar o componente com as propriedades armazenadas
  - atualizar o componente e gravar essas alterações
  - apagar o componente da página
- Armazena e obtém as definições customizadas utilizadas para configurar um componente para utilização numa página
- Utiliza a comunicação intercomponentes para participar nos triggers e ações
Sugestões de geometria para uma página (não se aplica a componentes customizados)
- Permite que uma página redimensione dinamicamente a moldura inline quando receber essa indicação de um componente
- Como resultado, um componente parece fazer parte de uma página e a página é deslocada em resposta aos eventos de redimensionamento do componente (sem barras de deslocação)
Reconhecimento do componente de quando é chamado pelo Oracle Content Management
- A comunicação entre um componente e uma página contém um token assinado por uma chave privada.
- O Sites SDK permite a um componente descodificar o token e facilitar a verificação do chamador.

Pode incluir as funções do Sites SDK fornecendo um percurso conhecido do script. Por exemplo:

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

O Sites SDK tem estes objetos globais:

SitesSDK
SitesSDK.Utils

SitesSDK

O objeto global SitesSDK pode ser utilizado nos endpoints de renderização e de definições.

Comando	Tarefa
SitesSDK.getProperty(propertyName, callback)	Obtém o valor da propriedade nomeada a partir do site do host.
SitesSDK.setProperty(propertyName, propertyValue)	Define o valor da propriedade nomeada como `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Obtém um valor da propriedade do site nomeada a partir do site do host. Por exemplo, pode extrair o design do tema atual que está a ser utilizado pelo site do host.
SitesSDK.publish(messageType, payload)	Envia uma mensagem para o servidor e aceita um objeto `messageType` e JSON como payload.
SitesSDK.subscribe(messageType, callback)	Um listener de mensagens para as mensagens despachadas a partir do site do host. A chamada é assíncrona. Estas são callbacks de JavaScript, pelo que a função deve utilizar um JavaScript Closure ou associar de modo apropriado a função para garantir que tem acesso ao contexto adequado.

SitesSDK.Utils

O namespace SitesSDK.Utils tem funções de utilitário que podem ser chamadas por todos os endpoints de um componente do Oracle Content Management. Este namespace está disponível para a secção Definições de um componente remoto, mas não para o componente local inline.

Atenção:

Estas funções não são suportadas oficialmente pela Oracle; servem de implementações de exemplo. Utilize-as por sua conta e risco.

Comando	Tarefa
SitesSDK.Utils.Logger	Devolve o objeto do registo no diário a ser utilizado pelo Sites SDK. O nível de registo no diário pode ser definido como um dos seguintes: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Acrescenta o design do tema do site atual a um componente.
Utils.getStyle(elem,styleProp)	Um método do utilitário que calcula a altura da moldura inline.