27 Referência do Sites SDK

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

O Sites SDK está disponível para download no servidor do Oracle Content Management:

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

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

A finalidade principal do Sites SDK é permitir que os usuários criem e gerenciem aplicativos. Ele fornece diversas funcionalidades:

Comunicação entre limites de iframe e domínio
- Permite que um componente se comunique com uma página, não importa onde ele esteja hospedado
- Inclui a participação no ciclo de vida do modelo de página:
  - criando o componente
  - renderizando o componente com propriedades armazenadas
  - atualizando o componente e salvando as alterações
  - excluindo o componente da página
- Armazena e recupera definições personalizadas usadas para configurar um componente para uso em uma página
- Usa a comunicação intercomponentes para participar de triggers e ações
Dicas de geometria para uma página (não se aplica a componentes personalizados)
- Permite que uma página redimensione dinamicamente o iframe quando foi instruído a assim proceder por um componente
- Resulta no aparecimento de um componente para fazer parte de uma página e na movimentação da página em resposta aos eventos de redimensionamento do componente (sem barras de rolagem)
Detecção do componente de quando ele é 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 que um componente decodifique o token e facilite a verificação do chamador.

Você inclui as funções do Sites SDK fornecendo um caminho 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 usado em pontos finais de renderização e definições.

Comando	Tarefa
SitesSDK.getProperty(propertyName, callback)	Obtém o valor da propriedade nomeada do site host.
SitesSDK.setProperty(propertyName, propertyValue)	Define como `propertyValue` o valor da propriedade nomeada.
SitesSDK.getSiteProperty(propertyName, callback)	Obtém um valor de propriedade nomeada do site, com base no site host. Por exemplo, poderia extrair o design do tema atual que está sendo usado pelo site host.
SitesSDK.publish(messageType, payload)	Envia uma mensagem ao servidor e aceita um `messageType` e objeto JSON como payload.
SitesSDK.subscribe(messageType, callback)	Um listener das mensagens enviadas do site host. A chamada é assíncrona. Tratam-se de chamadas JavaScript; por isso, a função deve usar o JavaScript Closure ou fazer binding adequadamente da função para garantir que ela tenha acesso ao contexto apropriado.

SitesSDK.Utils

O namespace SitesSDK.Utils tem funções de utilitário que podem ser chamadas por todos os pontos finais de um componente do Oracle Content Management. Esse namespace está disponível no painel Definições de um componente remoto, mas não do componente local em linha.

Cuidado:

Essas funções não são oficialmente suportadas pela Oracle; elas se destinam a implementações de amostra. Use-as por sua conta e risco.

Comando	Tarefa
SitesSDK.Utils.Logger	Retorna o objeto logger que está sendo usado pelo Sites SDK. O nível de log pode ser definido como um destes: depuração log informações erro advertência
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Adiciona o design do tema do site atual a um componente.
Utils.getStyle(elem,styleProp)	Um método de utilitário que calcula a altura do iframe.