27 Informazioni di riferimento per il kit Sites SDK

Nel kit JavaScript SDK (Sites SDK) di Oracle Content Management è disponibile un set di funzioni che consente una maggiore integrazione dei componenti con Oracle Content Management.

Il kit Sites SDK può essere scaricato dal server di Oracle Content Management:

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

Le definizioni delle interfacce API (Application Programming Interface) Sites interessano tutti gli spazi di nomi definiti dell'oggetto globale SitesSDK:

Scopo principale del kit Sites SDK è consentire agli utenti di creare e gestire le applicazioni. Nel kit sono disponibili le funzioni riportate di seguito.

Comunicazione oltre i limiti dei frame in linea e dei domini
- Consente a un componente di comunicare con una pagina indipendentemente dal sistema in cui si trova
- Include la partecipazione al ciclo di vita del modello di pagina:
  - creazione del componente
  - rendering del componente con le proprietà memorizzate
  - aggiornamento del componente e salvataggio delle modifiche apportate
  - eliminazione del componente dalla pagina
- Memorizza e recupera le impostazioni personalizzate utilizzate per configurare un componente per l'utilizzo in una pagina
- Utilizza la comunicazione tra componenti per partecipare alla definizione di trigger e azioni
Suggerimenti di geometria in una pagina (non applicabili ai componenti personalizzati)
- Consente a una pagina di ridimensionare in modo dinamico il frame in linea quando riceve istruzioni specifiche da un componente
- Comporta la visualizzazione di un componente come parte di una pagina e lo spostamento della pagina in risposta agli eventi di ridimensionamento del componente (senza barre di scorrimento)
Il componente riconosce il momento in cui viene chiamato da Oracle Content Management
- La comunicazione tra un componente e una pagina prevede un token firmato mediante una chiave privata
- Il kit Sites SDK consente a un componente di decodificare il token di facilitare la verifica del chiamante

Per includere le funzioni del kit Sites SDK è necessario fornire un percorso conosciuto dello script. Ad esempio:

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

Il kit Sites SDK dispone degli oggetti globali seguenti:

SitesSDK
SitesSDK.Utils

SitesSDK

L'oggetto globale SitesSDK può essere utilizzato negli endpoint di rendering e delle impostazioni.

Comando	Task
SitesSDK.getProperty(propertyName, callback)	Ottiene il valore della proprietà specificata dal sito host.
SitesSDK.setProperty(propertyName, propertyValue)	Imposta il valore della proprietà specificata su `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Ottiene il valore della proprietà sito specificata dal sito host. Ad esempio, potrebbe recuperare la progettazione di tema corrente utilizzata dal sito host.
SitesSDK.publish(messageType, payload)	Invia un messaggio al server e accetta `messageType` e un oggetto JSON come payload.
SitesSDK.subscribe(messageType, callback)	Listener per i messaggi consegnati dal sito host. La chiamata è asincrona. Si tratta di callback JavaScript, pertanto la funzione deve usare JavaScript Closure oppure essere associata in modo adeguato tramite bind per ottenere l'accesso al contesto appropriato.

SitesSDK.Utils

Lo spazio di nomi SitesSDK.Utils include funzioni di utility che possono essere chiamate da tutti gli endpoint di un componente di Oracle Content Management. Questo spazio di nomi è disponibile per il pannello Impostazioni per un componente remoto, ma non per il componente locale in linea.

Attenzione:

Queste funzioni non sono ufficialmente supportate da Oracle e vengono fornite come implementazioni di esempio. L'uso di queste funzioni è pertanto a rischio dell'utente.

Comando	Task
SitesSDK.Utils.Logger	Restituisce l'oggetto logger utilizzato dal kit Sites SDK. Il livello di log può essere impostato su uno dei valori seguenti: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Aggiunge la progettazione del tema del sito corrente a un componente.
Utils.getStyle(elem,styleProp)	Metodo di utility che calcola l'altezza del frame in linea.