27 Referens till SDK:t för webbplatser

SDK:t för JavaScript för Oracle Content Management (SDK:t för webbplatser) har en uppsättning funktioner som gör att komponenter kan få en mer integrerad upplevelse med Oracle Content Management.

SDK:t för webbplatser finns tillgängligt för nedladdning från servern för Oracle Content Management:

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

Definitionerna i API-gränssnittet (Application Programming Interface) för webbplatser omfattar alla definierade namnrymder för det globala objektet SitesSDK:

Huvudsyftet med SDK:er för webbplatser är att ge användare möjlighet att bygga och hantera applikationer. Det tillhandahåller flera funktioner:

Kommunikation mellan iframes och över domängränser
- Gör det möjligt för en komponent att kommunicera med en sida, oavsett var komponenten hyses
- Inkluderar medverkan i sidmodellens livscykel:
  - skapa komponenten
  - återge komponenten med lagrade egenskaper
  - uppdatera komponenten och spara de här ändringarna
  - ta bort komponenten från sidan
- Lagrar och hämtar anpassade inställningar som används för att konfigurera en komponent för användning på en sida
- Använder kommunikation mellan komponenter för att delta i triggrar och åtgärder
Geometritips till en sida (gäller inte för anpassade komponenter)
- Gör det möjligt för en sida att dynamiskt ändra storlek på iframen när en komponent säger till den att göra det
- Resulterar i att en komponent ser ut att vara en del av en sida, och att sidan rör sig som svar på händelser där komponentens storlek ändras (inga rullningslister)
Komponentmedvetenhet om när den anropas av Oracle Content Management
- Kommunikationen mellan en komponent och en sida innehåller ett token signerat av en privat nyckel.
- SDK:t för webbplatser gör det möjligt för en komponent att avkoda token och underlätta verifiering av anroparen.

Du inkluderar funktioner från SDK:er för webbplatser genom att ange en känd sökväg till skriptet. Exempel:

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

SDK:t för webbplatser har följande globala objekt:

SitesSDK
SitesSDK.Utils

SitesSDK

Det globala objektet SitesSDK kan användas i slutpunkter för återgivning och inställningar.

Kommando	Uppgift
SitesSDK.getProperty(propertyName, callback)	Hämtar värdet för den namngivna egenskapen från värdplatsen.
SitesSDK.setProperty(propertyName, propertyValue)	Anger `propertyValue` som värde för den namngivna egenskapen.
SitesSDK.getSiteProperty(propertyName, callback)	Hämtar värdet för en namngiven webbplatsegenskap från värdplatsen. Den skulle till exempel kunna hämta den aktuella temadesign som används av värdplatsen.
SitesSDK.publish(messageType, payload)	Skickar ett meddelande till servern, och accepterar ett `messageType`- och JSON-objekt som nyttolast.
SitesSDK.subscribe(messageType, callback)	En meddelandeavlyssnare för meddelanden som skickas från värdplatsen. Anropet är asynkront. De här är JavaScript-återanrop, så funktionen ska använda JavaScript Closure eller på lämpligt sätt binda funktionen för att säkerställa att den har åtkomst till lämplig kontext.

SitesSDK.Utils

Namnrymden SitesSDK.Utils har verktygsfunktioner som kan anropas av alla slutpunkter för en komponent i Oracle Content Management. Den här namnrymden är tillgänglig för inställningspanelen för en fjärrkomponent, men inte för den infogade lokala komponenten.

Varning:

Dessa funktioner stöds inte officiellt av Oracle. De är avsedda att användas som exempelimplementeringar. Använd dem på egen risk.

Kommando	Uppgift
SitesSDK.Utils.Logger	Returnerar det loggningsobjekt som används av SDK:t för webbplatser. Följande värden kan anges för loggningsnivån: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Lägger till den aktuella webbplatstemadesignen i en komponent.
Utils.getStyle(elem,styleProp)	En verktygsmetod som beräknar iframens höjd.