27 Reference til Sites-SDK

Oracle Content Management-JavaScript-SDK (Sites-SDK) har et sæt funktioner, der gør det muligt for komponenter at give en mere integreret oplevelse med Oracle Content Management.

Sites-SDK kan downloades fra Oracle Content Management-serveren:

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

Sites-API-definitioner (Application Programming Interface) dækker alle definerede navneområder for det globale objekt SitesSDK:

Hovedformålet med Sites-SDK er at give brugerne mulighed for at opbygge og håndtere applikationer. Den indeholder en række funktioner:

Kommunikation på tværs af inline-ramme og domænegrænser
- Gør det muligt for en komponent at kommunikere med en side, uanset hvor komponenten er hostet
- Omfatter deltagelse i sidemodellens livscyklus:
  - oprettelse af komponenten
  - gengivelse af komponenten med gemte egenskaber
  - opdatering af komponenten og lagring af disse ændringer
  - sletning af komponenten på siden
- Gemmer og henter tilpassede indstillinger, der bruges til at konfigurere en komponent til brug på en side
- Bruger kommunikation mellem komponenter for at deltage i triggere og handlinger
Geometritip til en side (gælder ikke for tilpassede komponenter)
- Gør det muligt for en side at ændre størrelsen af inline-rammen dynamisk, når en komponent giver den besked om det
- Medfører, at en komponent ser ud til at være en del af en side, og siden flyttes som svar på begivenheder for ændring af komponentstørrelse (uden rullepaneler)
Komponent er opmærksom på, hvornår den kaldes af Oracle Content Management
- Kommunikation mellem en komponent og en side indeholder et token, der er signeret af en privat nøgle.
- Med Sites-SDK kan en komponent afkode tokenet og foretage verificering af opkalderen.

Du medtager Sites-SDK-funktioner ved at angive en kendt sti til scriptet. Eksempel:

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

Sites-SDK har disse globale objekter:

SitesSDK
SitesSDK.Utils

SitesSDK

Det globale SitesSDK-objekt kan bruges i slutpunkter for gengivelse og indstillinger.

Kommando	Opgave
SitesSDK.getProperty(propertyName, callback)	Henter værdien af den navngivne egenskab fra værtssitet.
SitesSDK.setProperty(propertyName, propertyValue)	Angiver værdien af den navngivne egenskab til `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Henter egenskabsværdien af et navngivet site fra værtssitet. Den kan for eksempel hente det aktuelle temadesign, der bruges af værtssitet.
SitesSDK.publish(messageType, payload)	Sender en meddelelse til serveren og accepterer et `messageType`- og et JSON-objekt som payload.
SitesSDK.subscribe(messageType, callback)	En meddelelse-listener for meddelelser, der afsendes fra værtssitet. Kaldet er asynkront. Dette er JavaScript-callbacks, så funktionen skal bruge JavaScript Closure eller tilknytte funktionen på en passende måde for at sikre, at den har adgang til det relevante indhold.

SitesSDK.Utils

SitesSDK.Utils-navneområdet har hjælpeprogramfunktioner, der kan kaldes af alle slutpunkter for en Oracle Content Management-komponent. Dette navneområde er tilgængeligt i indstillingspanelet for en ekstern komponent, men ikke for en lokal inline-komponent.

Forsigtig:

Disse funktioner understøttes ikke officielt af Oracle. De er beregnet som eksempelimplementeringer. Brug dem for egen regning.

Kommando	Opgave
SitesSDK.Utils.Logger	Returnerer det logger-objekt, som bruges af Sites-SDK. Logniveauet kan angives til et af disse: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Føjer det aktelle sitetemadesign til en komponent.
Utils.getStyle(elem,styleProp)	En hjælpeprogrammetode, der beregner højden af inline-rammen.