कॉर्डोवा प्लगइन एपीआई संदर्भ

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 प्रोजेक्ट नंबर।

config.serviceName – wp8 प्लेटफॉर्म के लिए MPNS सेवा का नाम।

example

// projectid: "GOOGLE_PROJECT_NUMBER", appid : "PUSHWOOSH_APP_ID", serviceName : "WINDOWS_PHONE_SERVICE" के साथ Pushwoosh को इनिशियलाइज़ करें। यह स्टार्ट पर सभी लंबित पुश नोटिफिकेशन को ट्रिगर करेगा।
pushwoosh.onDeviceReady({
    appid : "XXXXX-XXXXX",
    projectid: "XXXXXXXXXXXXXXX",
    serviceName: "XXXX"
});

registerDevice

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

[android, ios, wp8, windows]
डिवाइस को पुश नोटिफिकेशन के लिए रजिस्टर करता है और एक पुश टोकन प्राप्त करता है।

success – सफलता कॉलबैक। पुश टोकन इस कॉलबैक में “status.pushToken” पैरामीटर के रूप में पास किया जाता है

fail – त्रुटि कॉलबैक

example

pushwoosh.registerDevice(
    function(status) {
        alert("पुश टोकन के साथ पंजीकृत: " + status.pushToken);
    },
    function(error) {
        alert("पंजीकरण में विफल: " +  error);
    }
);

unregisterDevice

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

[android, ios, wp8, windows]
डिवाइस को पुश नोटिफिकेशन प्राप्त करने से अनरजिस्टर करता है।

success – सफलता कॉलबैक

fail – त्रुटि कॉलबैक

setTags

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

[android, ios, wp8, windows]
डिवाइस के लिए टैग सेट करता है।

पैरामीटर्स

config – कस्टम डिवाइस टैग के साथ ऑब्जेक्ट

success – सफलता कॉलबैक। पुश टोकन इस कॉलबैक में “status.pushToken” पैरामीटर के रूप में पास किया जाता है

fail – त्रुटि कॉलबैक

example

// टैग सेट करता है: “deviceName” मान “hello” के साथ और “deviceId” मान 10 के साथ
pushwoosh.setTags({deviceName:"hello", deviceId:10},
    function() {
        console.warn('setTags सफल');
    },
    function(error) {
        console.warn('setTags विफल');
    }
);

// सूची टैग "MyTag" को मान (ऐरे) "hello", "world" के साथ सेट करता है
pushwoosh.setTags({"MyTag":["hello", "world"]});

getTags

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

[android, ios, wp8, windows]
डिवाइस के लिए डिफ़ॉल्ट टैग सहित टैग लौटाता है।

success – सफलता कॉलबैक। पैरामीटर के रूप में टैग प्राप्त करता है

fail – त्रुटि कॉलबैक

pushwoosh.getTags(
    function(tags) {
        console.warn('डिवाइस के लिए टैग: ' + JSON.stringify(tags));
    },
    function(error) {
        console.warn('टैग प्राप्त करने में त्रुटि: ' + JSON.stringify(error));
    }
);

getPushToken

PushNotification.prototype.getPushToken = function(  success  )

[android, ios, wp8, windows]
यदि उपलब्ध हो तो पुश टोकन लौटाता है। ध्यान दें कि टोकन registerDevice फ़ंक्शन कॉलबैक में भी आता है।

success – सफलता कॉलबैक।

pushwoosh.getPushToken(
    function(token) {
        console.warn('पुश टोकन: ' + token);
    }
);

getPushwooshHWID

PushNotification.prototype.getPushwooshHWID = function(  success  )

[android, ios, wp8, windows]
Pushwoosh API के साथ संचार के लिए उपयोग किया जाने वाला Pushwoosh HWID लौटाता है।

success – getPushwooshHWID कॉलबैक

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

getRemoteNotificationStatus

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

[android, ios]
पुश नोटिफिकेशन अनुमतियों की विस्तृत स्थिति लौटाता है।

callback – सफलता कॉलबैक। निम्नलिखित गुणों के साथ ऑब्जेक्ट प्राप्त करता है:

{
  "enabled" : नोटिफिकेशन सक्षम फ़्लैग।
  "pushBadge" : बैज अनुमति दी गई। (केवल iOS)
  "pushAlert" : अलर्ट अनुमति दी गई। (केवल iOS)
  "pushSound" : ध्वनि अनुमति दी गई। (केवल iOS)
}

error — त्रुटि कॉलबैक

setApplicationIconBadgeNumber

PushNotification.prototype.setApplicationIconBadgeNumber = function(  badgeNumber  )

[android, ios]
एप्लिकेशन आइकन बैज नंबर सेट करें।

badgeNumber – आइकन बैज नंबर

getApplicationIconBadgeNumber

PushNotification.prototype.getApplicationIconBadgeNumber = function(  callback  )

[android, ios]
एप्लिकेशन आइकन बैज नंबर लौटाता है।

callback – सफलता कॉलबैक

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

addToApplicationIconBadgeNumber

PushNotification.prototype.addToApplicationIconBadgeNumber = function( badgeNumber )

[android, ios]
एप्लिकेशन आइकन बैज में मान जोड़ता है।

badgeNumber — वृद्धिशील आइकन बैज नंबर

getLaunchNotification

PushNotification.prototype.getLaunchNotification = function(  callback  )

[android, ios]
यदि ऐप पुश नोटिफिकेशन के जवाब में शुरू किया गया था तो पुश नोटिफिकेशन पेलोड लौटाता है, या null लौटाता है।

callback – सफलता कॉलबैक

clearLaunchNotification

PushNotification.prototype.clearLaunchNotification = function(  callback  )

[android, ios]
लॉन्च नोटिफिकेशन को साफ़ करता है, इस कॉल के बाद getLaunchNotification() null लौटाएगा।

setUserId

PushNotification.prototype.setUserId = function(  userId  )

[android, ios]
उपयोगकर्ता पहचानकर्ता सेट करता है - एक फेसबुक आईडी, उपयोगकर्ता नाम, ईमेल, या कोई अन्य उपयोगकर्ता आईडी। यह कई उपयोगकर्ता उपकरणों में डेटा और घटनाओं का मिलान करने की अनुमति देता है।

userId – उपयोगकर्ता स्ट्रिंग पहचानकर्ता

postEvent

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

[android, ios]
इन-ऐप संदेशों के लिए ईवेंट पोस्ट करता है। यह Pushwoosh कंट्रोल पैनल में निर्दिष्ट के अनुसार इन-ऐप संदेश प्रदर्शन को ट्रिगर कर सकता है।

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 – सफलता कॉलबैक

fail – त्रुटि कॉलबैक

pushwoosh.createLocalNotification({msg:"आपके कद्दू तैयार हैं!", seconds:30, userData:{}})

clearLocalNotification

PushNotification.prototype.clearLocalNotification = function()

[android]
createLocalNotification द्वारा बनाए गए सभी लंबित स्थानीय नोटिफिकेशन को साफ़ करता है

clearNotificationCenter

PushNotification.prototype.clearNotificationCenter = function()

[android]
एंड्रॉइड नोटिफिकेशन सेंटर में प्रस्तुत सभी नोटिफिकेशन को साफ़ करता है।

setMultiNotificationMode

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

[android]
एंड्रॉइड नोटिफिकेशन सेंटर में कई नोटिफिकेशन प्रदर्शित करने की अनुमति देता है।

setSingleNotificationMode

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

[android]
एंड्रॉइड नोटिफिकेशन सेंटर में केवल अंतिम नोटिफिकेशन प्रदर्शित करने की अनुमति देता है।

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]
जब नोटिफिकेशन आता है और डिस्प्ले बंद होता है तो एलईडी ब्लिंकिंग को सक्षम करता है।

on – एलईडी ब्लिंक सक्षम/अक्षम करें (डिफ़ॉल्ट रूप से अक्षम)

setColorLED

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

[android]
एलईडी रंग सेट करता है। setEnableLED के साथ उपयोग करें।

color – ARGB पूर्णांक प्रारूप में एलईडी रंग

getPushHistory

PushNotification.prototype.getPushHistory = function(  success  )

[android]
प्राप्त पुश नोटिफिकेशन की ऐरे लौटाता है।

success – सफलता कॉलबैक

pushwoosh.getPushHistory(function(pushHistory) {
    if(pushHistory.length == 0)
        alert("कोई पुश हिस्ट्री नहीं");
    else
        alert(JSON.stringify(pushHistory));
});

pushwoosh.clearPushHistory();

clearPushHistory

PushNotification.prototype.clearPushHistory = function()

[android]
पुश हिस्ट्री को साफ़ करता है।

cancelAllLocalNotifications

PushNotification.prototype.cancelAllLocalNotifications = function( callback )

[ios]
नोटिफिकेशन सेंटर से सभी स्थानीय नोटिफिकेशन को साफ़ करता है।

presentInboxUI

[android, ios]
इनबॉक्स स्क्रीन खोलता है।

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) एंड्रॉइड विशिष्ट नोटिफिकेशन पेलोड

ios – (object) iOS विशिष्ट नोटिफिकेशन पेलोड

windows – (object) विंडोज विशिष्ट नोटिफिकेशन पेलोड

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

    if (typeof(userData) != "undefined") {
      // कस्टम नोटिफिकेशन डेटा को हैंडल करें
      console.warn('उपयोगकर्ता डेटा: ' + 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('उपयोगकर्ता डेटा: ' + JSON.stringify(userData));
    }
  }
);

ईवेंट गुण

push-receive के समान

additionalAuthorizationOptions

[केवल ios]
अतिरिक्त नोटिफिकेशन प्राधिकरण विकल्प प्रदान करता है। registerDevice को कॉल करने से पहले कॉल किया जाना चाहिए।

pushwoosh.additionalAuthorizationOptions({
  "UNAuthorizationOptionCriticalAlert" : 1,
  "UNAuthorizationOptionProvisional": 0 // यदि आप इसे अपने ऐप में नहीं जोड़ना चाहते हैं तो 0 सेट करें या विकल्प निर्दिष्ट न करें।
});