27 Referinţe pentru SDK-ul Sites

SDK-ul JavaScript din Oracle Content Management (SDK-ul site-uri) conţine un set de funcţii prin utilizarea cărora componentele pot oferi o experienţă mai bine integrată cu Oracle Content Management.

SDK-ul site-uri poate fi descărcat de pe serverul Oracle Content Management:

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

Definiţiile pentru interfaţa de programare a aplicaţiilor Sites acoperă toate numele de spaţiu definite ale obiectului global SitesSDK:

Principalul scop al SDK-ului Sites este de a permite utilizatorilor să construiască şi să administreze aplicaţii. Acesta oferă mai multe caracteristici:

  • Comunicarea dincolo de limitele cadrelor inline şi domeniilor

    • Permite unei componente să comunice cu o pagină indiferent de locul în care este găzduită componenta

    • Include participarea la ciclul de viaţă al modelelor de pagini:
      • crearea componentei

      • randarea componentei cu proprietăţile stocate

      • actualizarea componentei şi salvarea modificărilor respective

      • ştergerea componentei din pagină

    • Stochează şi preia setările personalizate utilizate pentru configurarea unei componente care urmează să fie utilizată într-o pagină

    • Utilizează comunicarea inter-componente pentru încorporarea în triggere şi acţiuni

  • Indicaţii geometrice pentru o pagină (nu se aplică pentru componentele personalizate)

    • Permite unei pagini să redimensioneze în mod dinamic cadrul inline atunci când primeşte o instrucţiune în acest sens de la o componentă

    • Rezultatul este faptul că o componentă pare a face parte dintr-o pagină şi că pagina reacţionează ca răspuns la evenimentele de redimensionare ale componentei (fără bare de derulare)

  • Notorietatea componentei cu privire la apelarea acesteia de către Oracle Content Management

    • Comunicarea dintre o componentă şi o pagină conţine un token semnat printr-o cheie privată.

    • SDK-ul Sites permite unei componente să decodifice tokenul şi să faciliteze verificarea apelantului.

Pentru a include funcţiile SDK-ului Sites, trebuie să furnizaţi o cale cunoscută către script. De exemplu:

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

SDK-ul Sites conţine următoarele obiecte globale:

  • SitesSDK

  • SitesSDK.Utils

SitesSDK

Obiectul global SitesSDK poate fi integrat în punctele finale pentru randare şi setări.

Comandă Sarcină

SitesSDK.getProperty(propertyName, callback)

Preia valoarea proprietăţii denumite de la site-ul gazdă.

SitesSDK.setProperty(propertyName, propertyValue)

Setează valoarea proprietăţii denumite la propertyValue.

SitesSDK.getSiteProperty(propertyName, callback)

Preia o proprietate denumită a site-ului de la site-ul gazdă. De exemplu, ar putea prelua designul de temă pe care îl utilizează în prezent site-ul gazdă.

SitesSDK.publish(messageType, payload)

Trimite un mesaj către server şi acceptă un parametru messageType şi un obiect JSON drept payload.

SitesSDK.subscribe(messageType, callback)

Un listener pentru mesajele transmise de site-ul gazdă. Apelul este asincron. Acestea sunt reapelări JavaScript, astfel că funcţia trebuie să utilizeze JavaScript Closure sau să fie asociată în mod corect, pentru a se asigura că are acces la contextul corespunzător.

SitesSDK.Utils

Spaţiul de nume SitesSDK.Utils oferă funcţii de utilitar pe care le pot apela toate punctele finale ale unei componente Oracle Content Management. Acest spaţiu de nume este disponibil pentru panoul Setări aferent unei componente la distanţă, însă nu şi pentru componentele locale inline.

Atenţie:

Aceste funcţii nu sunt acceptate în mod oficial de către Oracle; acestea servesc drept exemple de implementări. Utilizaţi-le pe propriul risc.
Comandă Sarcină

SitesSDK.Utils.Logger

Returnează obiectul programului de jurnalizare pe care îl utilizează SDK-ul Sites. Puteţi seta nivelul de jurnalizare la una dintre următoarele:
  • remediere erori

  • jurnal

  • informaţii

  • eroare

  • avertizare

SitesSDK.Utils.addSiteThemeDesign(cssUrl)

Adaugă designul actual al temei site-ului la o componentă.

Utils.getStyle(elem,styleProp)

O metodă de utilitar care calculează înălţimea cadrului inline.