27 Reference sady SDK pro weby

JavaScript SDK (sada SDK pro weby) pro službu Oracle Content Management obsahuje sadu funkcí, které umožňují komponentám mít více integrované prostředí se službou Oracle Content Management.

Sada SDK pro weby je dostupná ke stažení na serveru Oracle Content Management:

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

Definice aplikačního programovacího rozhraní (API) pro weby pokrývají všechny definované prostory názvů globálního objektu SitesSDK:

Hlavním účelem sady SDK pro weby je umožnit uživatelům sestavovat aplikace a provádět jejich správu. Poskytuje několik funkcí, mezi které patří:

Komunikace napříč vloženým rámcem a přes hranice domény
- Umožňuje komponentě komunikovat se stránkou bez ohledu na to, kde je komponenta hostována.
- Zahrnuje účast v životním cyklu modelu stránky:
  - vytvoření komponenty
  - generování komponenty pomocí uložených vlastností
  - aktualizace komponenty a uložení změn
  - odstranění komponenty ze stránky
- Ukládá a načítá vlastní nastavení používaná ke konfiguraci komponenty pro použití na stránce.
- Používá komunikaci mezi komponentami k účasti na aktivaci triggerů a akcích.
Geometrické rady pro stránku (netýká se vlastních komponent)
- Umožňuje stránce dynamicky změnit velikost vloženého rámce, když o tuto změnu požádá komponenta.
- Výsledkem je, že se komponenta jeví jako součást stránky a stránka se posouvá v reakci na události změny velikosti komponenty (bez posuvníků).
Povědomí komponenty o tom, kdy je volána službou Oracle Content Management
- Komunikace mezi komponentou a stránkou obsahuje token podepsaný soukromým klíčem.
- Sada SDK pro weby umožňuje komponentě dekódovat token a usnadnit ověření volajícího.

Funkce sady SDK pro weby zahrnete poskytnutím známé cesty skriptu. Například:

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

Sada SDK pro weby obsahuje tyto globální objekty:

SitesSDK
SitesSDK.Utils

SitesSDK

Globální objekt SitesSDK lze použít v koncových bodech generování a nastavení.

Příkaz	Úloha
SitesSDK.getProperty(propertyName, callback)	Vrátí hodnotu uvedené vlastnosti z hostitelského webu.
SitesSDK.setProperty(propertyName, propertyValue)	Nastaví hodnotu uvedené vlastnosti na `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Vrátí hodnotu uvedené vlastnosti webu z hostitelského webu. Například by mohla načíst aktuální návrh tématu, který je používán hostitelským webem.
SitesSDK.publish(messageType, payload)	Odešle zprávu na server a přijme `messageType` a objekt JSON jako datovou část.
SitesSDK.subscribe(messageType, callback)	Služba listener pro zprávy odesílané z hostitelského webu. Volání je asynchronní. Jedná se o zpětná volání v jazyku JavaScript, takže funkce by měla používat uzávěr jazyka JavaScript nebo vhodně svázat funkci, aby měla přístup k příslušnému kontextu.

SitesSDK.Utils

Prostor názvů SitesSDK.Utils obsahuje funkce utilit, které lze volat všemi koncovými body komponenty služby Oracle Content Management. Tento prostor názvů je dostupný pro panel Nastavení vzdálené komponenty, nikoli však vložené místní komponenty.

Upozornění:

Tyto funkce nejsou společností Oracle oficiálně podporovány; jsou zamýšleny jako ukázkové implementace. Používáte je na vlastní nebezpečí.

Příkaz	Úloha
SitesSDK.Utils.Logger	Vrací objekt logger používaný sadou SDK pro weby. Lze nastavit jednu z těchto úrovní protokolu: debug (ladění) log (protokolování) info (informace) error (chyba) warn (varování)
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Přidá aktuální návrh tématu webu ke komponentě.
Utils.getStyle(elem,styleProp)	Metoda utility, která vypočítá výšku vloženého rámce.