SitesSDK.subscribe(messageType, callback)

Bu fonksiyon, ana bilgisayar sitesinden dağıtılan mesajlar için etkin bir mesaj izleyicisidir. Çağrı zamanuyumsuzdur.

Parametreler

Belirli tipteki bir mesaj yazılım geliştirme kiti tarafından alındığında kayıtlı geri çağırma uygulanır. Geri çağırma bir değer döndürürse o değer sayfaya geri döndürülür. Bu fonksiyona geri çağırma iletilmezse o belirli mesaj tipine yönelik herhangi bir kayıtlı izleyici de silinir.

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.

Ad Tip Açıklama

messageType

dize

Mesaj tipi:

  • SETTINGS_UPDATED

  • TRIGGER_ACTIONS

  • EXECUTE_ACTION

  • GET_ACTIONS

  • GET_TRIGGERS

  • COPY_CUSTOM_DATA

  • PASTE_CUSTOM_DATA

callback

fonksiyon

Ana bilgisayar sitesinden bir mesaj alındığındaki fonksiyon.

Mesaj Tipleri

Mesaj Tipi Açıklama
SETTINGS_UPDATED Bu mesaja abone olarak Ayarlar Panelinde herhangi bir değer değiştiğinde bilgilendirme alın. Genel olarak bileşen, kullanıcı arayüzünde gösterimini güncelleyerek yanıt verir.
TRIGGER_ACTIONS Bu mesajın yayımlanması bir tetikleyiciyi çalıştırır ve veri yükünü iletir.
EXECUTE_ACTION Bu mesaja abone olarak özel eylemleri idare edin. İzleyici genel olarak verilen eylemi gerçekleştirerek bu mesajı idare eder.
GET_ACTIONS Bu mesaja abone olarak bileşenin yürütebileceği eylem dizisini bildirin. Eylem dizisini döndürür.
GET_TRIGGERS Bu mesaja abone olarak bileşenin çalıştırabileceği tetikleyici dizisini bildirin. Tetikleyici dizisini döndürür.
COPY_CUSTOM_DATA Bu mesaja abone olarak panoya Özel Ayarlar Verisinin kopyalanmasını idare edin. Panoya konacak verileri temsil eden bir nesne döndürür.
PASTE_CUSTOM_DATA Bu mesaja abone olarak panodan Özel Ayarlar Verisinin yapıştırılmasını idare edin.

Kullanım

Bazı izleyiciler verilerin iletilmelerini bekler ve bazılarından veri döndürmesi beklenir.

Örnek 1:

Mesaj tipi EXECUTE_ACTION için bir mesaj izleyicisini kayıt edin:

SitesSDK.subscribe(SitesSDK.MESSAGE_TYPES.EXECUTE_ACTION, self.executeAction,self);

Kayıtlı callback fonksiyonu bağımsız bir değişkeni burada gösterildiği gibi kabul etmelidir:

// typical signature of a callback function registered with a message
// type
function (args) {
                var payload = args.detail.message.payload,
                                        action = args.detail.message.action,
                                        actionName =  action && action.actionName;

                // do something here with the payload data

        }

Örnek 2:

COPY_CUSTOM_DATA izleyicisi genel olarak bunun gibi bir kod ile uygulanır:

     // listen for COPY_CUSTOM_DATA request
     SitesSDK.subscribe(SitesSDK.MESSAGE_TYPES.COPY_CUSTOM_DATA,

copyCustomDataListener() yöntemi panoya kopyalanacak verileri temsil eden bir nesneyi döndürür, örneğin:

     // Handle Copy Style (save customSettingsData to the clipboard)
     self.copyCustomDataListener = function() {
         return {
             prop1: this.prop1(),
             prop2: this.prop2()
         };
     };

Örnek 3:

PASTE_CUSTOM_DATA isteği verileri kabul eder ancak herhangi bir şey döndürmesi gerekmez:

// listen for PASTE_CUSTOM_DATA request
SitesSDK.subscribe(SitesSDK.MESSAGE_TYPES.PASTE_CUSTOM_DATA, pasteCustomDataListener);

Bununla beraber:

// Handle Paste Style (apply customSettingsData from the clipboard)
self.pasteCustomDataListener = function(data) {
     ...
};