27 Referentie Sites SDK

De Oracle Content Management JavaScript SDK (Sites SDK) bevat een functieset voor een betere integratie van componenten met Oracle Content Management.

De Sites SDK kan worden gedownload van de Oracle Content Management server:

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

De Sites API-definities (Application Programming Interface) dekken alle gedefinieerde naamruimten van het globale object SitesSDK:

Het hoofddoel van de Sites SDK is gebruikers in staat te stellen applicaties te bouwen en beheren. De Sites SDK bevat meerdere functies:

Communicatie over de grenzen van inline-frames en domeinen
- Hiermee wordt communicatie tussen een component en een pagina mogelijk, ongeacht waar de component wordt gehost.
- Dit omvat participatie in de levenscyclus van het paginamodel:
  - De component maken
  - De component weergeven met opgeslagen eigenschappen
  - De component bijwerken en uw wijzigingen opslaan
  - De component van de pagina verwijderen
- Hiermee worden aangepaste instellingen voor het configureren van een component voor gebruik in een pagina opgeslagen en opgehaald.
- Hierbij wordt communicatie tussen componenten gebruikt voor deelname in triggers en acties.
Geometriehints naar een pagina (niet van toepassing op aangepaste componenten)
- Hiermee kan de grootte van een inline-frame op een pagina dynamisch worden aangepast in opdracht van een component.
- Hierdoor lijkt de component onderdeel van een pagina en wordt de pagina aangepast in reactie op grootteaanpassingsactiviteit van de component (geen schuifbalken).
Component-bewustwording van wanneer deze wordt aangeroepen door Oracle Content Management
- Communicatie tussen een component en een pagina wordt voorzien van een token en ondertekend met een privésleutel.
- Met behulp van de Sites SDK kan het token door een component worden gedecodeerd en de aanroeper worden geverifieerd.

U neem Sites SDK functies op door een bekend pad van het script op te geven. Bijvoorbeeld:

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

De Sites SDK bevat deze globale objecten.

SitesSDK
SitesSDK.Utils

SitesSDK

Het globale object SitesSDK kan worden gebruikt in eindpunten voor weergave en instellingen.

Opdracht	Taak
SitesSDK.getProperty(propertyName, callback)	Hiermee wordt de waarde van de benoemde eigenschap opgehaald van de hostsite.
SitesSDK.setProperty(propertyName, propertyValue)	Hiermee wordt de waarde van de benoemde eigenschap ingesteld op `proptertyValue` (eigenschapswaarde).
SitesSDK.getSiteProperty(propertyName, callback)	Hiermee wordt de waarde van een benoemde site-eigenschap opgehaald van de hostsite. Zo kan bijvoorbeeld het huidige themaontwerp dat op de hostsite wordt gebruikt, worden opgehaald.
SitesSDK.publish(messageType, payload)	Hiermee wordt een bericht naar de server verzonden. Als payload kan een `messageType`- en JSON-object worden gebruikt.
SitesSDK.subscribe(messageType, callback)	Een listener voor berichten die worden verzonden vanaf de hostsite. De aanroep is asynchroon. Dit zijn JavaScript-callbacks, dus voor de functie moet JavaScript Closure worden gebruikt of moet hiermee de functie passend worden gebonden om ervoor te zorgen dat deze toegang heeft tot de juiste context.

SitesSDK.Utils

De naamruimte SitesSDK.Utils heeft hulpprogrammafuncties die kunnen worden aangeroepen door alle eindpunten van een Oracle Content Management component. Deze naamruimte is beschikbaar voor het paneel 'Instellingen' voor een externe component, maar niet voor de lokale inlinecomponent.

Let op:

Deze functies worden niet officieel ondersteund door Oracle; maar zijn bedoeld als voorbeeldimplementaties. U gebruikt deze op eigen risico.

Opdracht	Taak
SitesSDK.Utils.Logger	Hiermee wordt het logger-object geretourneerd dat door de Sites SDK wordt gebruikt. Het logniveau kan worden ingesteld op de volgende niveaus: debug (debuggen) log (loggen) info (informatie) error (fout) warn (waarschuwing)
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Hiermee wordt het huidige sitethemaontwerp toegevoegd aan een component.
Utils.getStyle(elem,styleProp)	Een hulpprogrammamethode waarmee de hoogte van het inline-frame wordt berekend.