27 Sites SDK — opis

Oracle Content Management JavaScript SDK (Sites SDK) zawiera zestaw funkcji umożliwiających składnikom pełniejszą integrację z Oracle Content Management.

Sites SDK można pobrać z serwera Oracle Content Management:

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

Definicje Sites API (Application Programming Interface) obejmują wszystkie zdefiniowane przestrzenie nazw globalnego obiektu SitesSDK:

Główny zadaniem Sites SDK jest umożliwienie użytkownikom konstruowania aplikacji i zarządzania nimi. Oferuje kilka możliwości:

Komunikacja między ramką wstawkową a obszarem domeny
- Umożliwia składnikowi komunikowanie się ze stroną bez względu na to, gdzie składnik jest hostowany
- Uwzględnia uczestnictwo w cyklu życia modelu strony:
  - tworzenie składnika
  - renderowanie składnika przy użyciu składowanych właściwości
  - aktualizowanie składnika i zapisywanie dokonanych zmian
  - usuwanie składnika ze strony
- Przechowuje i pobiera ustawienia niestandardowe, używane do konfigurowania składnika do użycia na stronie
- Używa komunikacji między składnikami niezbędnej dla wyzwalaczy i czynności
Podpowiedzi dot. geometrii strony (nie dotyczy składników niestandardowych)
- Umożliwia stronie dynamiczną zmianę rozmiaru ramki wstawkowej, gdy zostanie to zlecone przez składnik
- Daje w wyniku składnik wyglądający jak część strony oraz stronę przesuwającą się w odpowiedzi na zdarzenia zmiany rozmiaru składnika (bez pasków przewijania)
Rozpoznawanie przez składniki, że są wywoływane przez Oracle Content Management
- Komunikacja między składnikiem a stroną obejmuje token podpisany kluczem prywatnym.
- Sites SDK umożliwia składnikowi zdekodowanie tokenu oraz ułatwia weryfikację wywołującego.

Funkcje Sites SDK dołącza się, podając znaną ścieżkę skryptu. Na przykład:

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

Sites SDK zawiera następujące obiekty globalne:

SitesSDK
SitesSDK.Utils

SitesSDK

Globalny obiekt SitesSDK może być używany w punktach końcowych renderowania i ustawień.

Polecenie	Zadanie
SitesSDK.getProperty(propertyName, callback)	Uzyskuje wartość nazwanej właściwości z serwisu-hosta.
SitesSDK.setProperty(propertyName, propertyValue)	Ustawia wartość nazwanej właściwości na `propertyValue`.
SitesSDK.getSiteProperty(propertyName, callback)	Uzyskuje wartość nazwanej właściwości serwisu z serwisu-hosta. Na przykład może pobrać bieżący projekt motywu używany przez serwis-host.
SitesSDK.publish(messageType, payload)	Wysyła komunikat do serwera i przyjmuje `messageType` oraz obiekt JSON jako ładunek (payload).
SitesSDK.subscribe(messageType, callback)	Nasłuch komunikatów rozsyłanych z serwisu-hosta. Wywołanie jest asynchroniczne. Są to wywołania zwrotne JavaScript, a zatem funkcja powinna używać domknięcia (closure) JavaScript albo odpowiednio powiązać funkcję, tak aby miała dostęp do odpowiedniego kontekstu.

SitesSDK.Utils

Przestrzeń nazw SitesSDK.Utils zawiera funkcje narzędziowe, które mogą być wywoływane przez wszystkie punkty końcowe składnika Oracle Content Management. Jest dostępna dla panelu "Ustawienia" dla składnika odległego, lecz nie jest dostępna dla wstawkowego składnika lokalnego.

Ostrzeżenie:

Te funkcje nie są oficjalnie obsługiwane przez Oracle; służą jedynie jako przykładowe implementacje. Używanie tych funkcji odbywa się na wyłączne ryzyko bieżącego użytkownika.

Polecenie	Zadanie
SitesSDK.Utils.Logger	Zwraca obiekt logger używany przez Sites SDK. Poziom rejestrowania w dzienniku można ustawić na jeden z następujących: debug log info error warn
SitesSDK.Utils.addSiteThemeDesign(cssUrl)	Dodaje do składnika motyw z bieżącego serwisu.
Utils.getStyle(elem,styleProp)	Metoda obliczająca wysokość ramki wstawkowej.