เอกสารอ้างอิง API ของปลั๊กอิน Cordova

example

var pushwoosh = cordova.require("pushwoosh-cordova-plugin.PushNotification");

// ควรเรียกใช้ก่อน pushwoosh.onDeviceReady
document.addEventListener('push-notification', function(event) {
  var notification = event.notification;
  // จัดการการเปิดพุชที่นี่
});

// เริ่มต้น Pushwoosh ซึ่งจะทริกเกอร์การแจ้งเตือนแบบพุชที่รอดำเนินการทั้งหมดเมื่อเริ่มต้น
pushwoosh.onDeviceReady({
  appid: "XXXXX-XXXXX",
  projectid: "XXXXXXXXXXXXXXX",
  serviceName: "XXXX"
});

pushwoosh.registerDevice(
  function(status) {
    var pushToken = status.pushToken;
      // จัดการการลงทะเบียนที่สำเร็จที่นี่
  },
  function(status) {
    // จัดการข้อผิดพลาดในการลงทะเบียนที่นี่
  }
);

onDeviceReady

PushNotification.prototype.onDeviceReady = function( config )

[android, ios, wp8, windows]
เริ่มต้นปลั๊กอิน Pushwoosh และทริกเกอร์ข้อความพุชเริ่มต้น ควรเรียกใช้ทุกครั้งที่เปิดแอป

config.appid – รหัสแอปพลิเคชัน Pushwoosh

config.projectid – หมายเลขโปรเจกต์ GCM สำหรับแพลตฟอร์ม Android

config.serviceName – ชื่อบริการ MPNS สำหรับแพลตฟอร์ม wp8

example

// เริ่มต้น Pushwoosh ด้วย projectid: "GOOGLE_PROJECT_NUMBER", appid : "PUSHWOOSH_APP_ID", serviceName : "WINDOWS_PHONE_SERVICE" ซึ่งจะทริกเกอร์การแจ้งเตือนแบบพุชที่รอดำเนินการทั้งหมดเมื่อเริ่มต้น
pushwoosh.onDeviceReady({
    appid : "XXXXX-XXXXX",
    projectid: "XXXXXXXXXXXXXXX",
    serviceName: "XXXX"
});

registerDevice

PushNotification.prototype.registerDevice = function( success, fail )

[android, ios, wp8, windows]
ลงทะเบียนอุปกรณ์สำหรับการแจ้งเตือนแบบพุชและดึง Push Token

success – callback เมื่อสำเร็จ Push token จะถูกส่งเป็นพารามิเตอร์ “status.pushToken” ไปยัง callback นี้

fail – callback เมื่อเกิดข้อผิดพลาด

example

pushwoosh.registerDevice(
    function(status) {
        alert("Registered with push token: " + status.pushToken);
    },
    function(error) {
        alert("Failed to register: " +  error);
    }
);

unregisterDevice

PushNotification.prototype.unregisterDevice = function(  success, fail  )

[android, ios, wp8, windows]
ยกเลิกการลงทะเบียนอุปกรณ์จากการรับการแจ้งเตือนแบบพุช

success – callback เมื่อสำเร็จ

fail – callback เมื่อเกิดข้อผิดพลาด

setTags

PushNotification.prototype.setTags = function(  config, success, fail  )

[android, ios, wp8, windows]
ตั้งค่าแท็กสำหรับอุปกรณ์

พารามิเตอร์

config – อ็อบเจกต์ที่มีแท็กอุปกรณ์ที่กำหนดเอง

success – callback เมื่อสำเร็จ Push token จะถูกส่งเป็นพารามิเตอร์ “status.pushToken” ไปยัง callback นี้

fail – callback เมื่อเกิดข้อผิดพลาด

example

// ตั้งค่าแท็ก: “deviceName” ด้วยค่า “hello” และ “deviceId” ด้วยค่า 10
pushwoosh.setTags({deviceName:"hello", deviceId:10},
    function() {
        console.warn('setTags success');
    },
    function(error) {
        console.warn('setTags failed');
    }
);

// ตั้งค่าแท็กรายการ "MyTag" ด้วยค่า (อาร์เรย์) "hello", "world"
pushwoosh.setTags({"MyTag":["hello", "world"]});

getTags

PushNotification.prototype.getTags = function(  success, fail  )

[android, ios, wp8, windows]
ส่งคืนแท็กสำหรับอุปกรณ์รวมถึงแท็กเริ่มต้น

success – callback เมื่อสำเร็จ รับแท็กเป็นพารามิเตอร์

fail – callback เมื่อเกิดข้อผิดพลาด

pushwoosh.getTags(
    function(tags) {
        console.warn('tags for the device: ' + JSON.stringify(tags));
    },
    function(error) {
        console.warn('get tags error: ' + JSON.stringify(error));
    }
);

getPushToken

PushNotification.prototype.getPushToken = function(  success  )

[android, ios, wp8, windows]
ส่งคืน push token หากมีอยู่ โปรดทราบว่า token จะมาใน callback ของฟังก์ชัน registerDevice ด้วย

success – callback เมื่อสำเร็จ

pushwoosh.getPushToken(
    function(token) {
        console.warn('push token: ' + token);
    }
);

getPushwooshHWID

PushNotification.prototype.getPushwooshHWID = function(  success  )

[android, ios, wp8, windows]
ส่งคืน Pushwoosh HWID ที่ใช้สำหรับการสื่อสารกับ Pushwoosh API

success – callback ของ getPushwooshHWID

pushwoosh.getPushwooshHWID(
    function(token) {
        console.warn('Pushwoosh HWID: ' + token);
    }
);

getRemoteNotificationStatus

PushNotification.prototype.getRemoteNotificationStatus = function(  callback, error  )

[android, ios]
ส่งคืนสถานะโดยละเอียดของการอนุญาตการแจ้งเตือนแบบพุช

callback – callback เมื่อสำเร็จ รับอ็อบเจกต์ที่มีคุณสมบัติดังต่อไปนี้:

{
  "enabled" : แฟล็กเปิดใช้งานการแจ้งเตือน
  "pushBadge" : ได้รับอนุญาตสำหรับ badges (iOS เท่านั้น)
  "pushAlert" : ได้รับอนุญาตสำหรับ alert (iOS เท่านั้น)
  "pushSound" : ได้รับอนุญาตสำหรับ sound (iOS เท่านั้น)
}

error — callback เมื่อเกิดข้อผิดพลาด

setApplicationIconBadgeNumber

PushNotification.prototype.setApplicationIconBadgeNumber = function(  badgeNumber  )

[android, ios]
ตั้งค่าหมายเลข badge ของไอคอนแอปพลิเคชัน

badgeNumber – หมายเลข badge ของไอคอน

getApplicationIconBadgeNumber

PushNotification.prototype.getApplicationIconBadgeNumber = function(  callback  )

[android, ios]
ส่งคืนหมายเลข badge ของไอคอนแอปพลิเคชัน

callback – callback เมื่อสำเร็จ

pushwoosh.getApplicationIconBadgeNumber(function(badge){ alert(badge);} );

addToApplicationIconBadgeNumber

PushNotification.prototype.addToApplicationIconBadgeNumber = function( badgeNumber )

[android, ios]
เพิ่มค่าให้กับ badge ของไอคอนแอปพลิเคชัน

badgeNumber — หมายเลข badge ของไอคอนที่เพิ่มขึ้น

getLaunchNotification

PushNotification.prototype.getLaunchNotification = function(  callback  )

[android, ios]
ส่งคืน payload ของการแจ้งเตือนแบบพุชหากแอปถูกเริ่มจากการตอบสนองต่อการแจ้งเตือนแบบพุช หรือ null

callback – callback เมื่อสำเร็จ

clearLaunchNotification

PushNotification.prototype.clearLaunchNotification = function(  callback  )

[android, ios]
ล้างการแจ้งเตือนการเปิดแอป getLaunchNotification() จะส่งคืน null หลังจากการเรียกนี้

setUserId

PushNotification.prototype.setUserId = function(  userId  )

[android, ios]
ตั้งค่าตัวระบุผู้ใช้– Facebook ID, ชื่อผู้ใช้, อีเมล หรือ User ID อื่นๆ ซึ่งจะช่วยให้สามารถจับคู่ข้อมูลและอีเวนต์กับอุปกรณ์ต่างๆ ของผู้ใช้ได้

userId – ตัวระบุผู้ใช้แบบสตริง

postEvent

PushNotification.prototype.postEvent = function( event, attributes )

[android, ios]
โพสต์อีเวนต์สำหรับ In-App Messages ซึ่งสามารถทริกเกอร์การแสดง In-App message ตามที่ระบุใน Pushwoosh Control Panel

event – อีเวนต์ที่จะทริกเกอร์

attributes – อ็อบเจกต์ที่มีแอตทริบิวต์อีเวนต์เพิ่มเติม

pushwoosh.setUserId("XXXXXX");
pushwoosh.postEvent("buttonPressed", { "buttonNumber" : 4, "buttonLabel" : "banner" });

createLocalNotification

PushNotification.prototype.createLocalNotification = function( config, success, fail )

[android, ios]
กำหนดเวลาการแจ้งเตือนในเครื่อง

config.msg – ข้อความแจ้งเตือน

config.seconds – การหน่วงเวลาการแจ้งเตือนเป็นวินาที

config.userData – ข้อมูลเพิ่มเติมที่จะส่งในการแจ้งเตือน

success – callback เมื่อสำเร็จ

fail – callback เมื่อเกิดข้อผิดพลาด

pushwoosh.createLocalNotification({msg:"Your pumpkins are ready!", seconds:30, userData:{}})

clearLocalNotification

PushNotification.prototype.clearLocalNotification = function()

[android]
ล้างการแจ้งเตือนในเครื่องที่รอดำเนินการทั้งหมดที่สร้างโดย createLocalNotification

clearNotificationCenter

PushNotification.prototype.clearNotificationCenter = function()

[android]
ล้างการแจ้งเตือนทั้งหมดที่แสดงใน Android Notification Center

setMultiNotificationMode

PushNotification.prototype.setMultiNotificationMode = function( success, fail )

[android]
อนุญาตให้แสดงการแจ้งเตือนหลายรายการใน Android Notification Center

setSingleNotificationMode

PushNotification.prototype.setSingleNotificationMode = function(  success,
fail  )

[android]
อนุญาตให้แสดงเฉพาะการแจ้งเตือนล่าสุดใน Android Notification Center

setSoundType

PushNotification.prototype.setSoundType = function( type, success, fail )

[android]
ตั้งค่าเสียงเริ่มต้นสำหรับการพุชที่เข้ามา

type – ประเภทเสียง (0 – ค่าเริ่มต้น, 1 – ไม่มีเสียง, 2 – เสมอ)

setVibrateType

PushNotification.prototype.setVibrateType = function(type, success, fail )

[android]
ตั้งค่าโหมดการสั่นเริ่มต้นสำหรับการพุชที่เข้ามา

type – ประเภทการสั่น (0 – ค่าเริ่มต้น, 1 – ไม่มีการสั่น, 2 – เสมอ)

setLightScreenOnNotification

PushNotification.prototype.setLightScreenOnNotification = function( on, success, fail )

[android]
เปิดหน้าจอเมื่อมีการแจ้งเตือนมาถึง

on – เปิด/ปิดการปลดล็อกหน้าจอ (ปิดใช้งานโดยค่าเริ่มต้น)

setEnableLED

PushNotification.prototype.setEnableLED = function( on, success, fail )

[android]
เปิดใช้งานไฟ LED กะพริบเมื่อมีการแจ้งเตือนมาถึงและหน้าจอปิดอยู่

on – เปิด/ปิดการกะพริบของ LED (ปิดใช้งานโดยค่าเริ่มต้น)

setColorLED

PushNotification.prototype.setColorLED = function( color, success, fail )

[android]
ตั้งค่าสีของไฟ LED ใช้กับ setEnableLED

color – สี LED ในรูปแบบจำนวนเต็ม ARGB

getPushHistory

PushNotification.prototype.getPushHistory = function(  success  )

[android]
ส่งคืนอาร์เรย์ของการแจ้งเตือนแบบพุชที่ได้รับ

success – callback เมื่อสำเร็จ

pushwoosh.getPushHistory(function(pushHistory) {
    if(pushHistory.length == 0)
        alert("no push history");
    else
        alert(JSON.stringify(pushHistory));
});

pushwoosh.clearPushHistory();

clearPushHistory

PushNotification.prototype.clearPushHistory = function()

[android]
ล้างประวัติการพุช

cancelAllLocalNotifications

PushNotification.prototype.cancelAllLocalNotifications = function( callback )

[ios]
ล้างการแจ้งเตือนในเครื่องทั้งหมดจากศูนย์การแจ้งเตือน

presentInboxUI

[android, ios]
เปิดหน้าจอ Inbox

PushNotification.prototype.presentInboxUI = function()

setCommunicationEnabled

เมธอดแบบไบนารีที่เปิด/ปิดการสื่อสารทั้งหมดกับ Pushwoosh ค่าบูลีน false จะยกเลิกการสมัครรับการแจ้งเตือนแบบพุชของอุปกรณ์และหยุดการดาวน์โหลดข้อความในแอป ค่า true จะให้ผลตรงกันข้าม

PushNotification.prototype.setCommunicationEnabled = function(enable, success, fail)

removeAllDeviceData

ลบข้อมูลทั้งหมดเกี่ยวกับอุปกรณ์

PushNotification.prototype.removeAllDeviceData = function()

push-receive

[android, ios]
อีเวนต์การรับการแจ้งเตือนแบบพุช จะถูกยิงเมื่อแอปพลิเคชันได้รับการแจ้งเตือนแบบพุชในเบื้องหน้าหรือเบื้องหลัง แอปพลิเคชันที่ปิดอยู่จะไม่ได้รับอีเวนต์นี้

คุณสมบัติของอีเวนต์

message – (string) ข้อความแจ้งเตือนแบบพุช

userdata – (object/array) ข้อมูลที่กำหนดเองของการแจ้งเตือนแบบพุช

onStart – (boolean) เป็นการแจ้งเตือนการเปิดแอปหรือไม่

foreground – (boolean) การแจ้งเตือนได้รับในเบื้องหน้าหรือไม่

android – (object) payload การแจ้งเตือนเฉพาะของ Android

ios – (object) payload การแจ้งเตือนเฉพาะของ iOS

windows – (object) payload การแจ้งเตือนเฉพาะของ Windows

document.addEventListener('push-receive',
  function(event) {
    var userData = event.notification.userdata;

    if (typeof(userData) != "undefined") {
      // จัดการข้อมูลการแจ้งเตือนที่กำหนดเอง
      console.warn('user data: ' + JSON.stringify(userData));
    }
  }
);

การแจ้งเตือนเบื้องหน้า

โดยค่าเริ่มต้น ปลั๊กอิน Pushwoosh จะไม่แสดงการแจ้งเตือนในเบื้องหน้าและจะทริกเกอร์อีเวนต์ push-receive โดยอัตโนมัติ ดู คู่มือการปรับแต่งปลั๊กอิน สำหรับการควบคุมพฤติกรรมนี้

push-notification

[android, ios, wp8, windows]
อีเวนต์การยอมรับการแจ้งเตือนแบบพุช จะถูกยิงเมื่อผู้ใช้แตะที่การแจ้งเตือนแบบพุช

document.addEventListener('push-notification',
  function(event) {
    var message = event.notification.message;
    var userData = event.notification.userdata;

    if (typeof(userData) != "undefined") {
      console.warn('user data: ' + JSON.stringify(userData));
    }
  }
);

คุณสมบัติของอีเวนต์

เหมือนกับ push-receive

additionalAuthorizationOptions

[ios เท่านั้น]
ให้ตัวเลือกการอนุญาตการแจ้งเตือนเพิ่มเติม notification authorization options ควรเรียกใช้ก่อนที่จะเรียก registerDevice

pushwoosh.additionalAuthorizationOptions({
  "UNAuthorizationOptionCriticalAlert" : 1,
  "UNAuthorizationOptionProvisional": 0 // ตั้งค่าเป็น 0 หรือไม่ต้องระบุตัวเลือกหากคุณไม่ต้องการเพิ่มลงในแอปของคุณ
});