27 Referanse for SDK for områder

Oracle Content Management JavaScript SDK (Sites SDK) har et sett med funksjoner som gjør at komponenter kan ha en mer integrert opplevelse med Oracle Content Management.

Sites SDK er tilgjengelig for nedlasting fra Oracle Content Management-tjeneren:

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

Områdets API-definisjoner (Application Programming Interface) dekker alle definerte navneområder for det globale objektet SitesSDK:

Hovedhensikten med Sites SDK er å la brukere bygge og administrere applikasjoner. Det sørger for flere funksjoner:

Kommunikasjon på tvers av linjebundne rammer og domenegrenser
- Lar en komponent kommunisere med en side uansett hvem som er vert for komponenten
- Inkluderer deltakelse i sidemodellens livssyklus:
  - opprette komponenten
  - gjengi komponenten med lagrede egenskaper
  - oppdatere komponenten og lagre disse endringene
  - slette komponenten fra siden
- Lagrer og henter egendefinerte innstillinger som brukes til å konfigurere en komponent til bruk på en side
- Bruker kommunikasjon mellom komponenter til å ta del i utløsere og handlinger
Geometritips til en side (gjelder ikke for egendefinerte komponenter)
- Gjør de mulig med dynamisk endring av størrelsen på den linjebundne rammen når en komponent ber om det
- Resulterer i at komponenten ser ut til å være en del av en side, og siden flyttes som svar på komponentens størrelsesendringshendelser (ingen rullefelt)
Komponentens forståelse av at den kalles av Oracle Content Management
- Kommunikasjon mellom en komponent og en side inneholder et symbol som er signert av en privat nøkkel.
- Med Sites SDK kan en komponent dekode symbolet og muliggjøre verifisering av anroperen.

Du inkluderer funksjoner for Sites SDK ved å angi en bane som er kjent for skriptet. For eksempel:

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

Sites SDK har disse globale objektene:

SitesSDK
SitesSDK.Utils

SitesSDK

Det globale objektet SitesSDK kan brukes i gjengivelses- og innstillingssluttpunkter.

Kommando	Oppgave
SitesSDK.getProperty(propertyName, callback)	Henter verdien av den navngitte egenskapen fra vertsområdet.
SitesSDK.setProperty(propertyName, propertyValue)	Definerer verdien av den navngitte egenskapen til `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Henter egenskapsverdien for et navngitt område fra vertsområdet. Den kan for eksempel hente den gjeldende temautformingen som brukes av vertsområdet.
SitesSDK.publish(messageType, payload)	Sender en melding til tjenere, og godtar et `messageType`- og JSON-objekt som nyttelast.
SitesSDK.subscribe(messageType, callback)	En meldingslytter for meldinger som er fordelt fra vertsområdet. Kallet er asynkront. Disse er JavaScript-tilbakekall, og funksjonen bør derfor bruke JavaScript-avslutning eller binde funksjonen tilstrekkelig for å sikre at den har tilgang til den riktige konteksten.

SitesSDK.Utils

Navneområdet SitesSDK.Utils har verktøyfunksjoner som kan anropes av alle sluttpunkt for en Oracle Content Management-komponent. Dette navneområdet er tilgjengelig for ruten Innstillinger for en ekstern komponent, men ikke for den linjebundne lokale komponenten.

Forsiktig:

Disse funksjonene støttes offisielt ikke av Oracle. De er ment som eksempelimplementeringer. Bruk dem på egen risiko.

Kommando	Oppgave
SitesSDK.Utils.Logger	Returnerer loggerobjektet som brukes av Sites SDK. Loggnivået kan settes til én av disse: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Legger til det gjeldende områdets temautforming i en komponent.
Utils.getStyle(elem,styleProp)	En verktøymetode som beregner høyden på den linjebundne rammen.