SitesSDK.subscribe(messageType, callback)

พารามิเตอร์

ระบบจะเรียกการเรียกกลับที่รีจิสเตอร์ เมื่อ SDK ได้รับข้อความประเภทที่กำหนด ถ้าการเรียกกลับแสดงค่า ค่าดังกล่าวจะถูกส่งกลับไปที่เพจ ถ้าไม่มีการส่งการเรียกกลับไปยังฟังก์ชันนี้ ลิสเทนเนอร์ที่รีจิสเตอร์สำหรับข้อความประเภทนั้นจะถูกลบ

รายการเหล่านี้เป็นการเรียกกลับของ JavaScript ดังนั้น ฟังก์ชันควรใช้ JavaScript Closure หรือเชื่อมโยงฟังก์ชันให้เหมาะสมเพื่อให้แน่ใจว่ามีสิทธิ์เข้าใช้คอนเท็กซ์ที่ถูกต้อง

ประเภทข้อความ

การใช้งาน

ลิสเทนเนอร์บางรายการต้องการให้มีการส่งข้อมูล แต่ลิสเทนเนอร์บางรายการจะส่งคืนข้อมูลเป็นผลลัพธ์

ตัวอย่าง 1:

รีจิสเตอร์ลิสเทนเนอร์ของข้อความสำหรับประเภทข้อความ EXECUTE_ACTION:

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

ฟังก์ชัน callback ที่รีจิสเตอร์จะต้องยอมรับอาร์กิวเมนต์ดังที่แสดงในส่วนนี้

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

โดยปกติ ลิสเทนเนอร์ COPY_CUSTOM_DATA จะมีการใช้งานกับรหัสดังนี้

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

เมทธอด copyCustomDataListener() จะแสดงผลออบเจกต์ซึ่งแทนข้อมูลที่จะคัดลอกไปยังคลิปบอร์ด เช่น:

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

ตัวอย่าง 3:

คำขอ PASTE_CUSTOM_DATA จะยอมรับข้อมูล แต่ไม่จำเป็นต้องแสดงข้อมูลใดๆ:

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

พร้อมกับ:

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