27 Popis súpravy Sites SDK

Súprava Oracle Content Management JavaScript SDK (Sites SDK) obsahuje množinu funkcií, ktoré umožňujú integrovanejšie prostredie komponentov so službou Oracle Content Management.

Sites SDK je možné stiahnuť na serveri Oracle Content Management:

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

Definície rozhrania Sites API (Application Programming Interface) zahŕňajú všetky definované priestory názvov globálneho objektu SitesSDK:

Hlavným účelom súpravy Sites SDK je umožniť používateľom vytvárať a spravovať aplikácie. Poskytuje niekoľko funkcií:

Komunikácia medzi hranicami vloženého rámu a domény
- Umožňuje komponentu komunikovať so stránkou bez ohľadu na to, kde je komponent hosťovaný.
- Zahŕňa účasť v životnom cykle modelu stránky:
  - vytvorenie komponentu
  - vykreslenie komponentu s uloženými vlastnosťami
  - aktualizácia komponentu a uloženie zmien
  - odstránenie komponentu zo stránky
- Uloží a vyvolá vlastné nastavenia použité na konfiguráciu komponentu na použitie na stránke.
- Využíva komunikáciu medzi komponentmi na účasť v spúšťačoch a akciách.
Tipy týkajúce sa geometrie na stránke (nevzťahuje sa na vlastné komponenty)
- Umožňuje stránke dynamicky meniť veľkosť vloženého rámu na základe pokynov z komponentu.
- Výsledkom je komponent zobrazený ako súčasť stránky a pohyb stránky v odpovedi na udalosti zmeny veľkosti komponentu (bez posúvačov).
Schopnosť komponentu rozpoznať volanie zo služby Oracle Content Management
- Komunikácia medzi komponentom a stránkou obsahuje token podpísaný súkromným kľúčom.
- Sites SDK umožňuje komponentu dekódovať token a vykonať overenie volajúceho.

Funkcie súpravy Sites SDK zahrniete zadaním známej cesty skriptu. Príklad:

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

Sites SDK obsahuje tieto globálne objekty:

SitesSDK
SitesSDK.Utils

SitesSDK

Globálny objekt SitesSDK možno použiť v koncových bodoch vykreslenia a nastavení.

Príkaz	Úloha
SitesSDK.getProperty(propertyName, callback)	Načíta hodnotu pomenovanej vlastnosti z hostiteľskej lokality.
SitesSDK.setProperty(propertyName, propertyValue)	Nastaví hodnotu pomenovanej vlastnosti na `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Načíta hodnotu pomenovanej vlastnosti lokality z hostiteľskej lokality. Môže napríklad vyvolať aktuálny návrh motívu, ktorý používa hostiteľská lokalita.
SitesSDK.publish(messageType, payload)	Odošle správu na server a akceptuje typ správy `messageType` a objekt JSON ako payload.
SitesSDK.subscribe(messageType, callback)	Prijímač správ pre správy odoslané z lokality hostiteľa. Volanie je asynchrónne. Toto sú spätné volania JavaScriptu, takže funkcia by mala použiť JavaScript Closure alebo je potrebné vytvoriť vhodné viazanie funkcie, aby mala prístup k príslušnému kontextu.

SitesSDK.Utils

Priestor názvov SitesSDK.Utils má funkcie utilít, ktoré možno volať zo všetkých koncových bodov komponentu Oracle Content Management. Tento priestor názvov je k dispozícii pre panel Nastavenia pre vzdialený komponent, ale nie pre vnorený lokálny komponent.

Pozor:

Tieto funkcie spoločnosť Oracle oficiálne nepodporuje. Slúžia len ako vzorové implementácie. Používate ich na vlastné riziko.

Príkaz	Úloha
SitesSDK.Utils.Logger	Vracia objekt loggera, ktorý používa súprava Sites SDK. Úroveň protokolovania možno nastaviť na jednu z týchto možností: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Pridá návrh motívu aktuálnej lokality do komponentu.
Utils.getStyle(elem,styleProp)	Metóda utility, ktorá vypočíta výšku vloženého rámu.