27 Sivustojen SDK:n ohje

Oracle Content Management -palvelun JavaScript-SDK (sivustojen SDK) sisältää joukon funktioita, joiden avulla komponentit voi integroida paremmin Oracle Content Management -palveluun.

Sivustojen SDK:n voi noutaa Oracle Content Management -palvelimesta:

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

Sivustojen Application Programming Interface (API) -määritykset kattavat kaikki SitesSDK-yleisobjektin määritetyt nimialueet:

Sivustojen SDK:n päätarkoitus on antaa käyttäjille mahdollisuus sovellusten luontiin ja hallintaan. Se tarjoaa useita toimintoja:

Sisäisten kehysten ja toimialueen rajojen välinen viestintä
- Komponentti voi viestiä sivun kanssa riippumatta siitä, missä komponentin pääkone sijaitsee.
- Sisältää sivumallin elinkaareen osallistumisen:
  - komponentin luonti
  - komponentin muodostus tallennetuilla ominaisuuksilla
  - komponentin päivitys ja muutosten tallennus
  - komponentin poisto sivulta
- Tallentaa ja hakee räätälöidyt asetukset, joilla komponentti määritetään sivulla käytettäväksi
- Toimii osana herättimiä ja toimia käyttämällä komponenttien välistä viestintää
Geometriavihjeet sivulle (ei koske räätälöityjä komponentteja)
- Sivu voi muuttaa sisäisen kehyksen kokoa dynaamisesti, kun komponentti pyytää sitä
- Tämän vuoksi komponentti näyttää sivun osalta ja sivu siirtyy, kun komponentin koko muuttuu (ei vierityspalkkeja)
Komponentin tietoisuus siitä, että Oracle Content Management kutsuu sitä
- Komponentin ja sivun väliseen viestintään sisältyy merkki, joka on allekirjoitettu yksityisellä avaimella.
- Sivustojen SDK:n avulla komponentti voi purkaa merkin koodauksen ja auttaa kutsujan tarkistuksessa.

Sivustojen SDK:n funktioita voi lisätä määrittämällä tunnetun komentosarjan polun. Esimerkki:

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

Sivustojen SDK sisältää seuraavat yleisobjektit:

SitesSDK
SitesSDK.Utils

SitesSDK

SitesSDK-yleisobjektia voi käyttää muodostuksen ja asetusten loppupisteissä.

Komento	Tehtävä
SitesSDK.getProperty(propertyName, callback)	Hakee nimetyn ominaisuuden arvon pääsivustosta.
SitesSDK.setProperty(propertyName, propertyValue)	Asettaa nimetyn ominaisuuden arvoksi `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Hakee nimetyn sivuston ominaisuuden arvon pääsivustosta. Tätä voi käyttää esimerkiksi pääsivustossa sillä hetkellä käytetyn teeman rakenteen hakuun.
SitesSDK.publish(messageType, payload)	Lähettää sanoman palvelimeen ja hyväksyy `messageType`-objektin sekä JSON-objektin tieto-osana.
SitesSDK.subscribe(messageType, callback)	Pääsivustosta lähetettyjen sanomien kuuntelija. Kutsu on asynkroninen. Vastakutsut ovat JavaScript -vastakutsuja, joten varmista, että funktio voi käyttää asianmukaista kontekstia. Tämän voi tehdä käyttämällä JavaScript-sulkeumaa tai sitomalla funktion asianmukaisesti.

SitesSDK.Utils

SitesSDK.Utils-nimialue sisältää apufunktioita, joita kaikki Oracle Content Management -komponentin päätepisteet voivat kutsua. Tämä nimialue on käytettävissä Asetukset-paneelissa etäkomponenteille mutta ei sisäisille paikallisille komponenteille.

Huomio::

Oracle ei tue näitä funktioita virallisesti. Ne on tarkoitettu esimerkkitoteutuksiksi. Voit käyttää niitä omalla vastuulla.

Komento	Tehtävä
SitesSDK.Utils.Logger	Palauttaa lokiinkirjausobjektin, jota sivustojen SDK käyttää. Lokiinkirjaustasoksi voi valita jonkin seuraavista: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Lisää nykyisen sivuston teeman rakenteen komponenttiin.
Utils.getStyle(elem,styleProp)	Apumenetelmä, joka laskee sisäisen kehyksen korkeuden.