27 Sites SDK referenciaanyag

Az Oracle Content Management JavaScript SDK (Sites SDK) olyan függvények készletét tartalmazza, amelyek sokkal integráltabb kapcsolatot tesznek lehetővé az összetevők és az Oracle Content Management között.

A Sites SDK az Oracle Content Management kiszolgálójáról tölthető le:

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

A Sites Application Programming Interface (API) definíciói a globális SitesSDK objektum összes definiált névterületére kiterjednek:

A Sites SDK legfőbb célja, hogy lehetővé tegye a felhasználók számára az alkalmazások létrehozását és kezelését. Számos funkciót kínál:

Kommunikáció a belső keret és a tartomány határai között
- Lehetővé teszi, hogy egy összetevő kommunikáljon egy oldallal attól függetlenül, hogy hol található az összetevő
- Magában foglalja az oldalmodell életciklusában való részvételt:
  - az összetevő létrehozása
  - az összetevő megjelenítése a tárolt tulajdonságokkal együtt
  - az összetevő módosítása és a módosítások mentése
  - az összetevő törlése az oldalról
- Egy oldalon használni kívánt összetevő konfigurálásához szükséges egyéni beállításokat tárolja és olvassa be
- Az összetevők közötti kommunikáció segítségével vesz részt a triggerekben és a műveletekben
Geometriai tippek egy oldalhoz (az egyéni összetevőkre nem vonatkozik)
- Lehetővé teszi, hogy egy oldal dinamikusan átméretezze a belső keretet, ha egy összetevő erre kéri
- Azt eredményezi, hogy egy összetevő egy oldal részeként jelenik meg, és az oldal áthelyeződik az összetevő átméretezési eseményeire válaszul (nincs görgetősáv)
Az összetevő bizonyossága arról, hogy mikor hívja meg az Oracle Content Management
- Az összetevő és az oldal közötti kommunikáció egy személyes kulccsal aláírt tokent tartalmaz
- A Sites SDK lehetővé teszi, hogy az összetevő dekódolja a tokent és megkönnyítse a hívó ellenőrzését.

A parancsfájl ismert elérési útjának megadásával biztosítsa a Sites SDK függvényeit. Például:

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

A Sites SDK három globális objektumot tartalmaz:

SitesSDK
SitesSDK.Utils

SitesSDK

A SitesSDK globális objektum a megjelenítésben és a beállítási végpontoknál használható.

Parancs	Feladat
SitesSDK.getProperty(propertyName, callback)	A megnevezett tulajdonság értékét olvassa be a gazdawebhelyről.
SitesSDK.setProperty(propertyName, propertyValue)	A megnevezett tulajdonság értékét `propertyValue` értékre állítja be.
SitesSDK.getSiteProperty(propertyName, callback)	Egy megnevezett webhelytulajdonság értékét olvassa be a gazdawebhelyről. Például beolvashatja a gazdawebhely által éppen használt aktuális tématervet.
SitesSDK.publish(messageType, payload)	Üzenetet küld a kiszolgálónak, és egy `messageType` és egy JSON objektumot fogad el tartalomként.
SitesSDK.subscribe(messageType, callback)	A gazdawebhelyről küldött üzenetekhez használt üzenetfigyelő. A hívás aszinkron. Ezek JavaScript visszahívások, így a függvénynek JavaScript lezárót vagy megfelelő kötést kell használnia annak biztosítására, hogy hozzáférjen a megfelelő környezethez.

SitesSDK.Utils

A SitesSDK.Utils névterület olyan segédprogrami függvényeket tartalmaz, amelyeket egy Oracle Content Management szolgáltatásbeli összetevő összes végpontja meghívhat. Ez a névterület egy távoli összetevő Beállítások panelje számára elérhető, de a belső helyi összetevő számára nem.

Vigyázat:

Az Oracle hivatalosan nem támogatja ezeket a függvényeket, csupán mintamegvalósításokként szolgálnak. Saját kockázatára használhatja azokat.

Parancs	Feladat
SitesSDK.Utils.Logger	A Sites SDK által használt naplózó objektumot adja vissza. A naplózási szint a következő értékek egyikére állítható be: hibakeresés napló információ hiba figyelmeztetés
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	A webhely aktuális tématervét hozzáadja egy összetevőhöz.
Utils.getStyle(elem,styleProp)	Olyan segédprogrambeli metódus, amely kiszámítja a belső keret magasságát.