SitesSDK.subscribe(messageType, callback)

A függvény lényegében üzenetfigyelő a gazdawebhelyről küldött üzenetek számára. A hívás aszinkron.

Paraméterek

A regisztrált visszahívásra akkor kerül sor, amikor adott típusú üzenetet kap az SDK. Ha a visszahívás értéket ad vissza, akkor az érték visszakerül az oldalra. Ha a callback paraméter nincs átadva a függvénynek, akkor az adott üzenettípushoz tartozó regisztrált figyelőket törli a rendszer.

Ezek JavaScript visszahívások, így a függvénynek JavaScript lezárót vagy megfelelő kötést kell használnia annak biztosítására, hogy hozzáférjen a megfelelő környezethez.

Név Típus Leírás

messageType

karakterlánc

Üzenet típusa:

  • SETTINGS_UPDATED

  • TRIGGER_ACTIONS

  • EXECUTE_ACTION

  • GET_ACTIONS

  • GET_TRIGGERS

  • COPY_CUSTOM_DATA

  • PASTE_CUSTOM_DATA

callback

függvény

A függvény, amikor üzenet érkezik egy gazdawebhelyről.

Üzenettípusok

Üzenet típusa Leírás
SETTINGS_UPDATED Az üzenetre való feliratkozással értesítést kér, amikor valamelyik érték megváltozik a Beállítások panelen. Az összetevő jellemzően úgy válaszol, hogy frissíti megjelenítését a felhasználói felületen.
TRIGGER_ACTIONS Az üzenet közzététele triggert indít el, és adattörzset ad át.
EXECUTE_ACTION Az üzenetre való feliratkozással egyéni műveleteket kezelhet. A figyelő jellemzően az adott művelet végrehajtásával kezeli az üzenetet.
GET_ACTIONS Az üzenetre való feliratkozással az összetevő által végrehajtható műveletek tömbjét deklarálhatja. Műveletek tömbjét adja vissza.
GET_TRIGGERS Az üzenetre való feliratkozással az összetevő által indítható triggerek tömbjét deklarálhatja. Triggerek tömbjét adja vissza.
COPY_CUSTOM_DATA Az üzenetre való feliratkozással beállítások egyéni adatainak vágólapra másolását kezelheti. A vágólapra helyezendő adatokat tartalmazó objektumot ad vissza.
PASTE_CUSTOM_DATA Az üzenetre való feliratkozással beállítások egyéni adatainak vágólapról beillesztését kezelheti.

Használat

Egyes figyelők átadni kívánt adatokat várnak, míg mások visszaadni kívánt adatokat.

1. példa:

Üzenetfigyelő regisztrálása az EXECUTE_ACTION üzenettípusra:

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

A regisztrált callback függvénynek argumentumot kell fogadnia az alábbiak szerint:

// 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

        }

2. példa:

A COPY_CUSTOM_DATA figyelő jellemzően a következőhöz hasonló kóddal valósítható meg:

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

A copyCustomDataListener() metódus a vágólapra másolni kívánt adatokat tartalmazó objektumot ad vissza, például:

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

3. példa:

A PASTE_CUSTOM_DATA kérelem adatokat fogad, de semmit sem kell visszaadnia:

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

Ezzel együtt:

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