27 Siteler Yazılım Geliştirme Kiti Referansı

Oracle Content Management JavaScript Yazılım Geliştirme Kitinde (Siteler Yazılım Geliştirme Kiti), bileşenlerin Oracle Content Management ile daha entegre bir deneyimi olmasını sağlayan bir dizi fonksiyon bulunur.

Siteler Yazılım Geliştirme Kiti, Oracle Content Management sunucusundan indirilebilir:

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

Siteler Uygulama Programı Arabirimi tanımları, SitesSDK global nesnesinin tüm tanımlı ad alanlarını kapsar:

Siteler Yazılım Geliştirme Kitinin temel amacı, kullanıcıların uygulamaları oluşturmalarını ve yönetmelerini sağlamaktır. Birkaç özellik sağlar:

  • Satır içi çerçeve ve etki alanı sınırları arasında iletişim

    • Bir bileşenin nerede barındırıldığı fark etmeksizin bir sayfayla iletişim kurmasını sağlar

    • Sayfa modeli yaşam döngüsüne katılımı içerir:
      • bileşeni oluşturma

      • bileşeni saklanan niteliklerle görüntüleme

      • bileşeni güncelleme ve bu değişiklikleri kaydetme

      • bileşeni sayfadan silme

    • Bir bileşeni bir sayfada kullanılmak üzere konfigüre etmek için kullanılan özel ayarları saklar ve alır

    • Tetikleyicilere ve eylemlere katılmak için bileşenler arası iletişimi kullanır

  • Bir sayfa için geometri ipuçları (özel bileşenler için geçerli değildir)

    • Bir bileşen tarafından yapması istendiğinde bir sayfanın satır içi çerçeveyi dinamik olarak yeniden boyutlandırmasını sağlar

    • Bir bileşenin, bir sayfanın parçası olarak görünmesine ve bileşenin yeniden boyutlandırma olaylarına karşılık olarak sayfanın taşınmasına neden olur (kaydırma çubuğu yok)

  • Oracle Content Management tarafından çağrıldığında bileşen farkındalığı

    • Bir bileşen ile bir sayfa arasındaki iletişim, özel anahtarla imzalanmış bir belirteç içerir.

    • Siteler Yazılım Geliştirme Kiti, bir bileşenin belirtecin kodunu çözmesini ve çağrıyı yapanın doğrulanmasını kolaylaştırmasını sağlar.

Siteler Yazılım Geliştirme Kiti fonksiyonlarını, komut listesinin bilinen bir dizin yolunu sağlayarak dahil edersiniz. Örneğin:

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

Siteler Yazılım Geliştirme Kitinde şu global nesneler vardır:

  • SitesSDK

  • SitesSDK.Utils

SitesSDK

SitesSDK global nesnesi, görüntüleme ve ayarlar uç noktalarında kullanılabilir.

Komut Görev

SitesSDK.getProperty(propertyName, callback)

Ana bilgisayar sitesinden adlandırılmış niteliğin değerini alır.

SitesSDK.setProperty(propertyName, propertyValue)

Adlandırılmış niteliğin değerini propertyValue olarak ayarlar.

SitesSDK.getSiteProperty(propertyName, callback)

Ana bilgisayar sitesinden adlandırılmış bir site nitelik değeri alır. Örneğin, ana bilgisayar sitesi tarafından kullanılan geçerli tema tasarımını getirebilir.

SitesSDK.publish(messageType, payload)

Sunucuya bir mesaj gönderir ve veri yükü olarak bir messageType ve JSON nesnesi kabul eder.

SitesSDK.subscribe(messageType, callback)

Ana bilgisayar sitesinden dağıtılan mesajlara yönelik bir mesaj izleyicisi. Çağrı zamanuyumsuzdur. Bunlar JavaScript geri aramalarıdır; dolayısıyla fonksiyon JavaScript Kapanışı kullanmalı veya uygun bağlama erişimi olmasını sağlamak için fonksiyonu uygun şekilde bağlamalıdır.

SitesSDK.Utils

SitesSDK.Utils ad alanında, bir Oracle Content Management bileşeninin tüm uç noktaları tarafından çağrılabilen hizmet programı fonksiyonları vardır. Bu ad alanı bir uzak bileşene yönelik Ayarlar paneli için kullanılabilir, ancak satır içi yerel bileşen için kullanılamaz.

Dikkat:

Bu fonksiyonlar Oracle tarafından resmi olarak desteklenmez. Örnek uygulamalar olarak tasarlanmışlardır. Bunları kullanmanın sorumluluğu size aittir.
Komut Görev

SitesSDK.Utils.Logger

Siteler Yazılım Geliştirme Kiti tarafından kullanılan günlük kayıtçısı nesnesini döndürür. Günlük düzeyi şunlardan birine ayarlanabilir:
  • debug

  • log

  • info

  • error

  • warn

SitesSDK.Utils.addSiteThemeDesign(cssUrl)

Geçerli site teması tasarımını bir bileşene ekler.

Utils.getStyle(elem,styleProp)

Satır içi çerçevenin yüksekliğini hesaplayan bir hizmet programı yöntemi.