27 Sites-SDK-Reference

Das Oracle Content Management-JavaScript-SDK (Sites-SDK) umfasst mehrere Funktionen, mit denen Sie eine besser integrierte Erfahrung für Komponenten mit Oracle Content Management ermöglichen können.

Das Sites-SDK kann vom Oracle Content Management-Server heruntergeladen werden:

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

Die Definitionen der Sites-API decken alle definierten Namespaces des globalen Objekts SitesSDK ab:

Das Sites-SDK soll in erster Linie Benutzern das Erstellen und Verwalten von Anwendungen ermöglichen. Es bietet mehrere Features:

Kommunikation über Inlineframe- und Domaingrenzen hinweg
- Komponenten können unabhängig von ihrem Hostort mit einer Seite kommunizieren
- Umfasst die Beteiligung am Seitenmodell-Lebenszyklus:
  - Erstellen der Komponente
  - Rendering der Komponente mit gespeicherten Eigenschaften
  - Aktualisieren der Komponente und Speichern dieser Änderungen
  - Löschen der Komponente von der Seite
- Speichert benutzerdefinierte Einstellungen für die Konfiguration einer Komponente auf einer Seite und ruft diese ab
- Verwendet komponentenübergreifende Kommunikation für die Beteiligung an Triggern und Aktionen
Geometriehinweise für eine Seite (gilt nicht für benutzerdefinierte Komponenten)
- Seiten können die Größe des Inlineframes dynamisch ändern, wenn sie von einer Komponente dazu angewiesen werden
- Komponenten werden als Teil einer Seite angezeigt, und die Seite bewegt sich bei Änderungen der Komponentengröße (keine Bildlaufleisten)
Komponente erkennt Aufruf durch Oracle Content Management
- Die Kommunikation zwischen einer Komponente und einer Seite enthält ein von einem Private Key signiertes Token.
- Mit dem Sites-SDK kann eine Komponente das Token decodieren und die Verifizierung des Aufrufers erleichtern.

Sie nehmen Funktionen des Sites-SDK auf, indem Sie einen bekannten Pfad des Skripts angeben. Beispiel:

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

Das Sites-SDK enthält die folgenden globalen Objekte:

SitesSDK
SitesSDK.Utils

SitesSDK

Das globale Objekt SitesSDK kann in Rendering- und Einstellungsendpunkten verwendet werden.

Befehl	Aufgabe
SitesSDK.getProperty(propertyName, callback)	Ruft den Wert der benannten Eigenschaft von der Hostsite ab.
SitesSDK.setProperty(propertyName, propertyValue)	Setzt den Wert der benannten Eigenschaft auf `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Ruft den Wert einer benannten Siteeigenschaft von der Hostsite ab. Sie können z.B. das aktuelle Theme-Design abrufen, das von der Hostsite verwendet wird.
SitesSDK.publish(messageType, payload)	Sendet eine Nachricht an den Server und akzeptiert einen `messageType` und ein JSON-Objekt als Payload.
SitesSDK.subscribe(messageType, callback)	Ein Nachrichten-Listener für Nachrichten von der Hostsite. Der Aufruf ist asynchron. Hierbei handelt es sich um JavaScript-Callbacks. Die Funktion sollte also JavaScript Closure verwenden oder angemessen gebunden werden, um den Zugriff auf den jeweiligen Kontext sicherzustellen.

SitesSDK.Utils

Der SitesSDK.Utils-Namespace umfasst Utilityfunktionen, die von allen Endpunkten einer Oracle Content Management-Komponente aufgerufen werden können. Dieser Namespace ist für den Einstellungsbereich für eine Remotekomponente, aber nicht für die lokale Inlinekomponente verfügbar.

Achtung:

Diese Funktionen werden nicht offiziell von Oracle unterstützt. Sie dienen lediglich als Beispielimplementierungen. Sie verwenden diese auf eigenes Risiko.

Befehl	Aufgabe
SitesSDK.Utils.Logger	Gibt das Logger-Objekt zurück, das vom Sites-SDK verwendet wird. Folgende Loggingebenen sind möglich: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Fügt das aktuelle Site-Theme-Design einer Komponente hinzu.
Utils.getStyle(elem,styleProp)	Eine Utilitymethode, die die Höhe des Inlineframes berechnet.