pushwoosh-cordova-plugin 6.1.0 → 6.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (79) hide show
  1. package/{MIT-LICENSE.txt → LICENSE.md} +0 -0
  2. package/README.md +20 -32
  3. package/README_PGB.md +32 -0
  4. package/package.json +1 -1
  5. package/package_pgb.json +29 -0
  6. package/plugin.xml +71 -85
  7. package/src/android/src/com/pushwoosh/plugin/internal/PhonegapPluginProvider.java +22 -0
  8. package/src/android/src/com/pushwoosh/plugin/pushnotifications/CustomFirebaseMessagingService.java +29 -0
  9. package/src/android/src/com/pushwoosh/plugin/pushnotifications/InboxUiStyleManager.java +136 -0
  10. package/src/android/src/com/pushwoosh/plugin/pushnotifications/PushNotifications.java +339 -388
  11. package/src/android/src/com/pushwoosh/plugin/pushnotifications/PushwooshNotificationServiceExtension.java +38 -0
  12. package/src/ios/PWBackward.h +25 -0
  13. package/src/ios/PWBackward.m +53 -0
  14. package/src/ios/PushNotification.m +409 -158
  15. package/src/ios/Pushwoosh.framework/Modules/module.modulemap +6 -0
  16. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PWAppDelegate.h +20 -0
  17. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PWGDPRManager.h +46 -0
  18. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PWInAppManager.h +174 -0
  19. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PWInbox.h +147 -0
  20. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PWInlineInAppView.h +26 -0
  21. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PWLog.h +23 -0
  22. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PWMessaging.h +20 -0
  23. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PWNotificationExtensionManager.h +33 -0
  24. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PWRichMediaManager.h +118 -0
  25. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PWRichMediaStyle.h +122 -0
  26. package/src/ios/Pushwoosh.framework/Versions/A/Headers/PushNotificationManager.h +263 -151
  27. package/src/ios/Pushwoosh.framework/Versions/A/Headers/Pushwoosh.h +525 -0
  28. package/src/ios/Pushwoosh.framework/Versions/A/libPushwoosh.a +0 -0
  29. package/src/ios/PushwooshInboxBundle.bundle/Info.plist +0 -0
  30. package/src/ios/PushwooshInboxBundle.bundle/PWIInboxAttachmentViewController.nib +0 -0
  31. package/src/ios/PushwooshInboxBundle.bundle/PWIInboxMessageViewCell.nib +0 -0
  32. package/src/ios/PushwooshInboxBundle.bundle/PWIInboxViewController.nib +0 -0
  33. package/src/ios/PushwooshInboxBundle.bundle/errorMessage@2x.png +0 -0
  34. package/src/ios/PushwooshInboxBundle.bundle/inbox_icon.png +0 -0
  35. package/src/ios/PushwooshInboxBundle.bundle/noMessage@2x.png +0 -0
  36. package/src/ios/PushwooshInboxBundle.bundle/unread.png +0 -0
  37. package/src/ios/PushwooshInboxUI.framework/Modules/module.modulemap +6 -0
  38. package/src/ios/PushwooshInboxUI.framework/Versions/A/Headers/PWIInboxStyle.h +122 -0
  39. package/src/ios/PushwooshInboxUI.framework/Versions/A/Headers/PWIInboxUI.h +39 -0
  40. package/src/ios/PushwooshInboxUI.framework/Versions/A/Headers/PushwooshInboxUI.h +19 -0
  41. package/src/ios/PushwooshInboxUI.framework/Versions/A/libPushwooshInboxUI.a +0 -0
  42. package/src/windows/PushSDK/Newtonsoft.Json.dll +0 -0
  43. package/src/windows/PushSDK/PushSDK.winmd +0 -0
  44. package/src/windows/PushwooshPluginProxy.js +88 -74
  45. package/src/wp8/PushNotification.cs +14 -0
  46. package/src/wp8/PushSDK/PushSDK.dll +0 -0
  47. package/www/PushNotification.js +171 -45
  48. package/Documentation/files/PushNotification-js.html +0 -157
  49. package/Documentation/index/Classes.html +0 -33
  50. package/Documentation/index/Functions.html +0 -61
  51. package/Documentation/index/General.html +0 -65
  52. package/Documentation/index.html +0 -1
  53. package/Documentation/javascript/main.js +0 -841
  54. package/Documentation/javascript/prettify.js +0 -1526
  55. package/Documentation/javascript/searchdata.js +0 -92
  56. package/Documentation/search/ClassesP.html +0 -20
  57. package/Documentation/search/FunctionsA.html +0 -20
  58. package/Documentation/search/FunctionsC.html +0 -20
  59. package/Documentation/search/FunctionsG.html +0 -20
  60. package/Documentation/search/FunctionsO.html +0 -20
  61. package/Documentation/search/FunctionsP.html +0 -20
  62. package/Documentation/search/FunctionsR.html +0 -20
  63. package/Documentation/search/FunctionsS.html +0 -20
  64. package/Documentation/search/FunctionsU.html +0 -20
  65. package/Documentation/search/GeneralA.html +0 -20
  66. package/Documentation/search/GeneralC.html +0 -20
  67. package/Documentation/search/GeneralF.html +0 -20
  68. package/Documentation/search/GeneralG.html +0 -20
  69. package/Documentation/search/GeneralO.html +0 -20
  70. package/Documentation/search/GeneralP.html +0 -20
  71. package/Documentation/search/GeneralR.html +0 -20
  72. package/Documentation/search/GeneralS.html +0 -20
  73. package/Documentation/search/GeneralU.html +0 -20
  74. package/Documentation/search/NoResults.html +0 -15
  75. package/Documentation/styles/main.css +0 -828
  76. package/VERSION.md +0 -138
  77. package/push.gradle +0 -21
  78. package/src/android/src/com/pushwoosh/plugin/pushnotifications/NotificationFactory.java +0 -29
  79. package/src/ios/Pushwoosh.framework/Versions/A/Pushwoosh +0 -0
package/Documentation/files/PushNotification-js.html DELETED
@@ -1,157 +0,0 @@
1
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
2
-
3
- <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>PushNotification</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
4
- if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
5
-
6
- <!-- Generated by Natural Docs, version 1.52 -->
7
- <!-- http://www.naturaldocs.org -->
8
-
9
- <!-- saved from url=(0026)http://www.naturaldocs.org -->
10
-
11
-
12
-
13
-
14
- <div id=Content><div class="CClass"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="PushNotification"></a>PushNotification</h1><div class=CBody><p>Class to interact with Pushwoosh Push Notifications plugin</p><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">var pushwoosh = cordova.require(&quot;pushwoosh-cordova-plugin.PushNotification&quot;);
15
- pushwoosh.onDeviceReady({
16
- appid : &quot;XXXXX-XXXXX&quot;,
17
- projectid: &quot;XXXXXXXXXXXXXXX&quot;,
18
- serviceName: &quot;XXXX&quot;
19
- });</pre></blockquote><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#PushNotification" >PushNotification</a></td><td class=SDescription>Class to interact with Pushwoosh Push Notifications plugin</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#PushNotification.Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.onDeviceReady" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">onDeviceReady</a></td><td class=SDescription>[android, ios, wp8, windows] Initialize Pushwoosh plugin and trigger a start push message Should be called on every app launch</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.registerDevice" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">registerDevice</a></td><td class=SDescription>[android, ios, wp8, windows] Register device for push notifications and retreive a push Token</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.unregisterDevice" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">unregisterDevice</a></td><td class=SDescription>[android, ios, wp8, windows] Unregister device form receiving push notifications</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.setTags" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">setTags</a></td><td class=SDescription>[android, ios, wp8, windows] Set tags for the device</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.getTags" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">getTags</a></td><td class=SDescription>[android, ios, wp8, windows] Returns tags for the device including default tags</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.getPushToken" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">getPushToken</a></td><td class=SDescription>[android, ios, wp8, windows] Returns push token if it is available. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.getPushwooshHWID" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">getPushwooshHWID</a></td><td class=SDescription>[android, ios, wp8, windows] Returns Pushwoosh HWID used for communications with Pushwoosh API</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.startLocationTracking" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">startLocationTracking</a></td><td class=SDescription>[android, ios, wp8, windows] Starts geolocation based push notifications. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.stopLocationTracking" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">stopLocationTracking</a></td><td class=SDescription>[android, ios, wp8, windows] Stops geolocation based push notifications</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.getRemoteNotificationStatus" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">getRemoteNotificationStatus</a></td><td class=SDescription>[android, ios] Returns a detailed status of push notification permissions.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.setApplicationIconBadgeNumber" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">setApplicationIconBadgeNumber</a></td><td class=SDescription>[android, ios] Set the application icon badge number</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.getApplicationIconBadgeNumber" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">getApplicationIconBadgeNumber</a></td><td class=SDescription>[android, ios] Returns the application icon badge number</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.addToApplicationIconBadgeNumber" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">addToApplicationIconBadgeNumber</a></td><td class=SDescription>[android, ios] Adds value to the application icon badge</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.getLaunchNotification" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">getLaunchNotification</a></td><td class=SDescription>[android, ios] Returns push notification payload if the app was started in response to push notification or null otherwise</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.clearLaunchNotification" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">clearLaunchNotification</a></td><td class=SDescription>[android, ios] Clears launch notifiation, getLaunchNotification() will return null after this call.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.setUserId" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">setUserId</a></td><td class=SDescription>[android, ios] Set User indentifier. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.postEvent" id=link17 onMouseOver="ShowTip(event, 'tt17', 'link17')" onMouseOut="HideTip('tt17')">postEvent</a></td><td class=SDescription>[android, ios] Post events for In-App Messages. </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.createLocalNotification" id=link18 onMouseOver="ShowTip(event, 'tt18', 'link18')" onMouseOut="HideTip('tt18')">createLocalNotification</a></td><td class=SDescription>[android] Schedules local notification,</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.clearLocalNotification" id=link19 onMouseOver="ShowTip(event, 'tt19', 'link19')" onMouseOut="HideTip('tt19')">clearLocalNotification</a></td><td class=SDescription>[android] Clears all pending local notifications created by <a href="#PushNotification.createLocalNotification" class=LFunction id=link20 onMouseOver="ShowTip(event, 'tt18', 'link20')" onMouseOut="HideTip('tt18')">createLocalNotification</a></td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.clearNotificationCenter" id=link21 onMouseOver="ShowTip(event, 'tt20', 'link21')" onMouseOut="HideTip('tt20')">clearNotificationCenter</a></td><td class=SDescription>[android] Clears all notifications presented in Android Notification Center</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.startBeaconPushes" id=link22 onMouseOver="ShowTip(event, 'tt21', 'link22')" onMouseOut="HideTip('tt21')">startBeaconPushes</a></td><td class=SDescription>[android] Starts beacon tracking</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.stopBeaconPushes" id=link23 onMouseOver="ShowTip(event, 'tt22', 'link23')" onMouseOut="HideTip('tt22')">stopBeaconPushes</a></td><td class=SDescription>[android] Stops beacon tracking</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.setBeaconBackgroundMode" id=link24 onMouseOver="ShowTip(event, 'tt23', 'link24')" onMouseOut="HideTip('tt23')">setBeaconBackgroundMode</a></td><td class=SDescription>[android] let the plugin know that the app went to background mode (or vise versa). </td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.setMultiNotificationMode" id=link25 onMouseOver="ShowTip(event, 'tt24', 'link25')" onMouseOut="HideTip('tt24')">setMultiNotificationMode</a></td><td class=SDescription>[android] Allows multiple notifications to be displayed in the Android Notification Center</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.setSingleNotificationMode" id=link26 onMouseOver="ShowTip(event, 'tt25', 'link26')" onMouseOut="HideTip('tt25')">setSingleNotificationMode</a></td><td class=SDescription>[android] Allows only the last one notification to be displayed in the Android Notification Center</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.setSoundType" id=link27 onMouseOver="ShowTip(event, 'tt26', 'link27')" onMouseOut="HideTip('tt26')">setSoundType</a></td><td class=SDescription>[android] Sets default sound to play when push notification arrive.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.setVibrateType" id=link28 onMouseOver="ShowTip(event, 'tt27', 'link28')" onMouseOut="HideTip('tt27')">setVibrateType</a></td><td class=SDescription>[android] Sets default vibration mode when push notification arrive.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.setLightScreenOnNotification" id=link29 onMouseOver="ShowTip(event, 'tt28', 'link29')" onMouseOut="HideTip('tt28')">setLightScreenOnNotification</a></td><td class=SDescription>[android] Turns the screen on if notification arrives</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.setEnableLED" id=link30 onMouseOver="ShowTip(event, 'tt29', 'link30')" onMouseOut="HideTip('tt29')">setEnableLED</a></td><td class=SDescription>[android] Enables led blinking when notification arrives and display is off</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.setEnableLED" >setEnableLED</a></td><td class=SDescription>[android] Set led color. </td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.getPushHistory" id=link31 onMouseOver="ShowTip(event, 'tt30', 'link31')" onMouseOut="HideTip('tt30')">getPushHistory</a></td><td class=SDescription>[android] Returns array of push notifications received.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#PushNotification.clearPushHistory" id=link32 onMouseOver="ShowTip(event, 'tt31', 'link32')" onMouseOut="HideTip('tt31')">clearPushHistory</a></td><td class=SDescription>[android] Clears push history</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#PushNotification.cancelAllLocalNotifications" id=link33 onMouseOver="ShowTip(event, 'tt32', 'link33')" onMouseOut="HideTip('tt32')">cancelAllLocalNotifications</a></td><td class=SDescription>[ios] Clears all notifications from the notification center</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
20
-
21
- <div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="PushNotification.Functions"></a>Functions</h3></div></div>
22
-
23
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.onDeviceReady"></a>onDeviceReady</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.onDeviceReady = function(</td><td class="PParameter prettyprint " nowrap>config</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios, wp8, windows] Initialize Pushwoosh plugin and trigger a start push message Should be called on every app launch</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;config.appid&rdquo;</td><td class=CDLDescription>Pushwoosh application code</td></tr><tr><td class=CDLEntry>&rdquo;config.projectid&rdquo;</td><td class=CDLDescription>GCM project number for android platform</td></tr><tr><td class=CDLEntry>&rdquo;config.serviceName&rdquo;</td><td class=CDLDescription>MPNS service name for wp8 platform</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">//initialize Pushwoosh with projectid: &quot;GOOGLE_PROJECT_NUMBER&quot;, appid : &quot;PUSHWOOSH_APP_ID&quot;, serviceName : &quot;WINDOWS_PHONE_SERVICE&quot;. This will trigger all pending push notifications on start.
24
- pushwoosh.onDeviceReady({
25
- appid : &quot;XXXXX-XXXXX&quot;,
26
- projectid: &quot;XXXXXXXXXXXXXXX&quot;,
27
- serviceName: &quot;XXXX&quot;
28
- });</pre></blockquote></div></div></div>
29
-
30
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.registerDevice"></a>registerDevice</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.registerDevice = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios, wp8, windows] Register device for push notifications and retreive a push Token</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;success&rdquo;</td><td class=CDLDescription>success callback.&nbsp; Push token is passed as &ldquo;status.pushToken&rdquo; parameter to this callback</td></tr><tr><td class=CDLEntry>&rdquo;fail&rdquo;</td><td class=CDLDescription>error callback</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">pushwoosh.registerDevice(
31
- function(status) {
32
- alert(&quot;Registered with push token: &quot; + status.pushToken);
33
- },
34
- function(error) {
35
- alert(&quot;Failed to register: &quot; + error);
36
- }
37
- );</pre></blockquote></div></div></div>
38
-
39
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.unregisterDevice"></a>unregisterDevice</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.unregisterDevice = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios, wp8, windows] Unregister device form receiving push notifications</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;success&rdquo;</td><td class=CDLDescription>success callback</td></tr><tr><td class=CDLEntry>&rdquo;fail&rdquo;</td><td class=CDLDescription>error callback</td></tr></table><p>Unregisters device from push notifications</p></div></div></div>
40
-
41
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setTags"></a>setTags</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setTags = function(</td><td class="PParameter prettyprint " nowrap>config,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios, wp8, windows] Set tags for the device</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;config&rdquo;</td><td class=CDLDescription>object with custom device tags</td></tr><tr><td class=CDLEntry>&rdquo;success&rdquo;</td><td class=CDLDescription>success callback</td></tr><tr><td class=CDLEntry>&rdquo;fail&rdquo;</td><td class=CDLDescription>error callback</td></tr></table><h4 class=CHeading>Example</h4><p>sets the following tags: &ldquo;deviceName&rdquo; with value &ldquo;hello&rdquo; and &ldquo;deviceId&rdquo; with value 10</p><blockquote><pre class="prettyprint">pushwoosh.setTags({deviceName:&quot;hello&quot;, deviceId:10},
42
- function() {
43
- console.warn('setTags success');
44
- },
45
- function(error) {
46
- console.warn('setTags failed');
47
- }
48
- );
49
-
50
- //setings list tags &quot;MyTag&quot; with values (array) &quot;hello&quot;, &quot;world&quot;
51
- pushwoosh.setTags({&quot;MyTag&quot;:[&quot;hello&quot;, &quot;world&quot;]});</pre></blockquote></div></div></div>
52
-
53
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.getTags"></a>getTags</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getTags = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios, wp8, windows] Returns tags for the device including default tags</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;success&rdquo;</td><td class=CDLDescription>success callback.&nbsp; Receives tags as parameter</td></tr><tr><td class=CDLEntry>&rdquo;fail&rdquo;</td><td class=CDLDescription>error callback</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">pushwoosh.getTags(
54
- function(tags) {
55
- console.warn('tags for the device: ' + JSON.stringify(tags));
56
- },
57
- function(error) {
58
- console.warn('get tags error: ' + JSON.stringify(error));
59
- }
60
- );</pre></blockquote></div></div></div>
61
-
62
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.getPushToken"></a>getPushToken</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getPushToken = function(</td><td class="PParameter prettyprint " nowrap>success</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios, wp8, windows] Returns push token if it is available.&nbsp; Note the token also comes in registerDevice function callback.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;success&rdquo;</td><td class=CDLDescription>getPushToken callback</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">pushwoosh.getPushToken(
63
- function(token) {
64
- console.warn('push token: ' + token);
65
- }
66
- );</pre></blockquote></div></div></div>
67
-
68
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.getPushwooshHWID"></a>getPushwooshHWID</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getPushwooshHWID = function(</td><td class="PParameter prettyprint " nowrap>success</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios, wp8, windows] Returns Pushwoosh HWID used for communications with Pushwoosh API</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;success&rdquo;</td><td class=CDLDescription>getPushwooshHWID callback</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">pushwoosh.getPushwooshHWID(
69
- function(token) {
70
- console.warn('Pushwoosh HWID: ' + token);
71
- }
72
- );</pre></blockquote></div></div></div>
73
-
74
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.startLocationTracking"></a>startLocationTracking</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.startLocationTracking = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios, wp8, windows] Starts geolocation based push notifications.&nbsp; You need to configure Geozones in Pushwoosh Control panel.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;success&rdquo;</td><td class=CDLDescription>success callback</td></tr><tr><td class=CDLEntry>&rdquo;fail&rdquo;</td><td class=CDLDescription>error callback</td></tr></table></div></div></div>
75
-
76
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.stopLocationTracking"></a>stopLocationTracking</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.stopLocationTracking = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios, wp8, windows] Stops geolocation based push notifications</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;success&rdquo;</td><td class=CDLDescription>success callback</td></tr><tr><td class=CDLEntry>&rdquo;fail&rdquo;</td><td class=CDLDescription>error callback</td></tr></table></div></div></div>
77
-
78
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.getRemoteNotificationStatus"></a>getRemoteNotificationStatus</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getRemoteNotificationStatus = function(</td><td class="PParameter prettyprint " nowrap>callback,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>error</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios] Returns a detailed status of push notification permissions.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;callback&rdquo;</td><td class=CDLDescription>success callback</td></tr><tr><td class=CDLEntry>&rdquo;error&rdquo;</td><td class=CDLDescription>error callback</td></tr></table><h4 class=CHeading>Returns array with the following items</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;enabled&rdquo;</td><td class=CDLDescription>if push notificaions enabled.</td></tr><tr><td class=CDLEntry>&rdquo;pushBadge&rdquo;</td><td class=CDLDescription>badges permission granted.&nbsp; (iOS only)</td></tr><tr><td class=CDLEntry>&rdquo;pushAlert&rdquo;</td><td class=CDLDescription>alert permission granted.&nbsp; (iOS only)</td></tr><tr><td class=CDLEntry>&rdquo;pushSound&rdquo;</td><td class=CDLDescription>sound permission granted.&nbsp; (iOS only)</td></tr></table></div></div></div>
79
-
80
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setApplicationIconBadgeNumber"></a>setApplicationIconBadgeNumber</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setApplicationIconBadgeNumber = function(</td><td class="PParameter prettyprint " nowrap>badgeNumber</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios] Set the application icon badge number</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;badgeNumber&rdquo;</td><td class=CDLDescription>icon badge number</td></tr></table></div></div></div>
81
-
82
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.getApplicationIconBadgeNumber"></a>getApplicationIconBadgeNumber</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getApplicationIconBadgeNumber = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios] Returns the application icon badge number</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;callback&rdquo;</td><td class=CDLDescription>success callback</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">pushwoosh.getApplicationIconBadgeNumber(function(badge){ alert(badge);} );</pre></blockquote></div></div></div>
83
-
84
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.addToApplicationIconBadgeNumber"></a>addToApplicationIconBadgeNumber</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=2>PushNotification.prototype.addToApplicationIconBadgeNumber = function(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>badgeNumber</td></tr><tr><td class="PAfterParameters prettyprint "colspan=2>)</td></tr></table></td></tr></table></blockquote><p>[android, ios] Adds value to the application icon badge</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;badgeNumber&rdquo;</td><td class=CDLDescription>incremental icon badge number</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">pushwoosh.addToApplicationIconBadgeNumber(5);
85
- pushwoosh.addToApplicationIconBadgeNumber(-5);</pre></blockquote></div></div></div>
86
-
87
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.getLaunchNotification"></a>getLaunchNotification</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getLaunchNotification = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios] Returns push notification payload if the app was started in response to push notification or null otherwise</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;callback&rdquo;</td><td class=CDLDescription>success callback</td></tr></table></div></div></div>
88
-
89
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.clearLaunchNotification"></a>clearLaunchNotification</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.clearLaunchNotification = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios] Clears launch notifiation, getLaunchNotification() will return null after this call.</p></div></div></div>
90
-
91
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setUserId"></a>setUserId</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setUserId = function(</td><td class="PParameter prettyprint " nowrap>userId</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios] Set User indentifier.&nbsp; This could be Facebook ID, username or email, or any other user ID.&nbsp; This allows data and events to be matched across multiple user devices.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;userId&rdquo;</td><td class=CDLDescription>user string identifier</td></tr></table></div></div></div>
92
-
93
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.postEvent"></a>postEvent</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.postEvent = function(</td><td class="PParameter prettyprint " nowrap>event,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>attributes</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android, ios] Post events for In-App Messages.&nbsp; This can trigger In-App message display as specified in Pushwoosh Control Panel.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;event&rdquo;</td><td class=CDLDescription>event to trigger</td></tr><tr><td class=CDLEntry>&rdquo;attributes&rdquo;</td><td class=CDLDescription>object with additional event attributes</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">pushwoosh.setUserId(&quot;XXXXXX&quot;);
94
- pushwoosh.postEvent(&quot;buttonPressed&quot;, { &quot;buttonNumber&quot; : 4, &quot;buttonLabel&quot; : &quot;banner&quot; });</pre></blockquote></div></div></div>
95
-
96
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.createLocalNotification"></a>createLocalNotification</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.createLocalNotification = function(</td><td class="PParameter prettyprint " nowrap>config,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] Schedules local notification,</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;config.msg&rdquo;</td><td class=CDLDescription>notification message</td></tr><tr><td class=CDLEntry>&rdquo;config.seconds&rdquo;</td><td class=CDLDescription>notification delay in seconds</td></tr><tr><td class=CDLEntry>&rdquo;config.userData&rdquo;</td><td class=CDLDescription>addition data to pass in notification</td></tr><tr><td class=CDLEntry>&rdquo;success&rdquo;</td><td class=CDLDescription>success callback</td></tr><tr><td class=CDLEntry>&rdquo;fail&rdquo;</td><td class=CDLDescription>error callback</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">pushwoosh.createLocalNotification({msg:&quot;Your pumpkins are ready!&quot;, seconds:30, userData:&quot;optional&quot;}</pre></blockquote></div></div></div>
97
-
98
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.clearLocalNotification"></a>clearLocalNotification</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">PushNotification.prototype.clearLocalNotification = function()</td></tr></table></blockquote><p>[android] Clears all pending local notifications created by <a href="#PushNotification.createLocalNotification" class=LFunction id=link34 onMouseOver="ShowTip(event, 'tt18', 'link34')" onMouseOut="HideTip('tt18')">createLocalNotification</a></p></div></div></div>
99
-
100
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.clearNotificationCenter"></a>clearNotificationCenter</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">PushNotification.prototype.clearNotificationCenter = function()</td></tr></table></blockquote><p>[android] Clears all notifications presented in Android Notification Center</p></div></div></div>
101
-
102
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.startBeaconPushes"></a>startBeaconPushes</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.startBeaconPushes = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] Starts beacon tracking</p></div></div></div>
103
-
104
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.stopBeaconPushes"></a>stopBeaconPushes</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.stopBeaconPushes = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] Stops beacon tracking</p></div></div></div>
105
-
106
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setBeaconBackgroundMode"></a>setBeaconBackgroundMode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setBeaconBackgroundMode = function(</td><td class="PParameter prettyprint " nowrap>on,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] let the plugin know that the app went to background mode (or vise versa).&nbsp; Call this when going background when using beacons</p></div></div></div>
107
-
108
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setMultiNotificationMode"></a>setMultiNotificationMode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setMultiNotificationMode = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] Allows multiple notifications to be displayed in the Android Notification Center</p></div></div></div>
109
-
110
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setSingleNotificationMode"></a>setSingleNotificationMode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setSingleNotificationMode = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] Allows only the last one notification to be displayed in the Android Notification Center</p></div></div></div>
111
-
112
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setSoundType"></a>setSoundType</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setSoundType = function(</td><td class="PParameter prettyprint " nowrap>type,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] Sets default sound to play when push notification arrive.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;type&rdquo;</td><td class=CDLDescription>Sound type (0 - default, 1 - no sound, 2 - always)</td></tr></table></div></div></div>
113
-
114
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setVibrateType"></a>setVibrateType</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setVibrateType = function(</td><td class="PParameter prettyprint " nowrap>type,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] Sets default vibration mode when push notification arrive.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;type&rdquo;</td><td class=CDLDescription>Vibration type (0 - default, 1 - no vibration, 2 - always)</td></tr></table></div></div></div>
115
-
116
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setLightScreenOnNotification"></a>setLightScreenOnNotification</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setLightScreenOnNotification = function(</td><td class="PParameter prettyprint " nowrap>on,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] Turns the screen on if notification arrives</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;on&rdquo;</td><td class=CDLDescription>enable/disable screen unlock (is disabled by default)</td></tr></table></div></div></div>
117
-
118
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setEnableLED"></a>setEnableLED</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setEnableLED = function(</td><td class="PParameter prettyprint " nowrap>on,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] Enables led blinking when notification arrives and display is off</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;on&rdquo;</td><td class=CDLDescription>enable/disable led blink (is disabled by default)</td></tr></table></div></div></div>
119
-
120
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.setEnableLED"></a>setEnableLED</h3><div class=CBody><p>[android] Set led color.&nbsp; Use with <a href="#PushNotification.setEnableLED" class=LFunction id=link35 onMouseOver="ShowTip(event, 'tt29', 'link35')" onMouseOut="HideTip('tt29')">setEnableLED</a></p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;color&rdquo;</td><td class=CDLDescription>led color in ARGB integer format</td></tr></table></div></div></div>
121
-
122
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.getPushHistory"></a>getPushHistory</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getPushHistory = function(</td><td class="PParameter prettyprint " nowrap>success</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[android] Returns array of push notifications received.</p><h4 class=CHeading>Parameters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>&rdquo;success&rdquo;</td><td class=CDLDescription>success callback</td></tr></table><h4 class=CHeading>Example</h4><blockquote><pre class="prettyprint">pushwoosh.getPushHistory(function(pushHistory) {
123
- if(pushHistory.length == 0)
124
- alert(&quot;no push history&quot;);
125
- else
126
- alert(JSON.stringify(pushHistory));
127
- });
128
-
129
- pushwoosh.clearPushHistory();</pre></blockquote></div></div></div>
130
-
131
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.clearPushHistory"></a>clearPushHistory</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">PushNotification.prototype.clearPushHistory = function()</td></tr></table></blockquote><p>[android] Clears push history</p></div></div></div>
132
-
133
- <div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="PushNotification.cancelAllLocalNotifications"></a>cancelAllLocalNotifications</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.cancelAllLocalNotifications = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>[ios] Clears all notifications from the notification center</p></div></div></div>
134
-
135
- </div><!--Content-->
136
-
137
-
138
- <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
139
-
140
-
141
- <div id=Menu><div class=MEntry><div class=MFile id=MSelected>PushNotification</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div></div></div></div><script type="text/javascript"><!--
142
- var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
143
- --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Functions">Functions</option></select></div></div><!--Menu-->
144
-
145
-
146
-
147
- <!--START_ND_TOOLTIPS-->
148
- <div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.onDeviceReady = function(</td><td class="PParameter prettyprint " nowrap>config</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Initialize Pushwoosh plugin and trigger a start push message Should be called on every app launch</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.registerDevice = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Register device for push notifications and retreive a push Token</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.unregisterDevice = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Unregister device form receiving push notifications</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setTags = function(</td><td class="PParameter prettyprint " nowrap>config,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Set tags for the device</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getTags = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Returns tags for the device including default tags</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getPushToken = function(</td><td class="PParameter prettyprint " nowrap>success</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Returns push token if it is available. </div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getPushwooshHWID = function(</td><td class="PParameter prettyprint " nowrap>success</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Returns Pushwoosh HWID used for communications with Pushwoosh API</div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.startLocationTracking = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Starts geolocation based push notifications. </div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.stopLocationTracking = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Stops geolocation based push notifications</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getRemoteNotificationStatus = function(</td><td class="PParameter prettyprint " nowrap>callback,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>error</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Returns a detailed status of push notification permissions.</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setApplicationIconBadgeNumber = function(</td><td class="PParameter prettyprint " nowrap>badgeNumber</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Set the application icon badge number</div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getApplicationIconBadgeNumber = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Returns the application icon badge number</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=2>PushNotification.prototype.addToApplicationIconBadgeNumber = function(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>badgeNumber</td></tr><tr><td class="PAfterParameters prettyprint "colspan=2>)</td></tr></table></td></tr></table></blockquote>[android, ios] Adds value to the application icon badge</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getLaunchNotification = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Returns push notification payload if the app was started in response to push notification or null otherwise</div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.clearLaunchNotification = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Clears launch notifiation, getLaunchNotification() will return null after this call.</div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setUserId = function(</td><td class="PParameter prettyprint " nowrap>userId</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Set User indentifier. </div></div><div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.postEvent = function(</td><td class="PParameter prettyprint " nowrap>event,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>attributes</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Post events for In-App Messages. </div></div><div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.createLocalNotification = function(</td><td class="PParameter prettyprint " nowrap>config,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Schedules local notification,</div></div><div class=CToolTip id="tt19"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">PushNotification.prototype.clearLocalNotification = function()</td></tr></table></blockquote>[android] Clears all pending local notifications created by createLocalNotification</div></div><div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">PushNotification.prototype.clearNotificationCenter = function()</td></tr></table></blockquote>[android] Clears all notifications presented in Android Notification Center</div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.startBeaconPushes = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Starts beacon tracking</div></div><div class=CToolTip id="tt22"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.stopBeaconPushes = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Stops beacon tracking</div></div><div class=CToolTip id="tt23"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setBeaconBackgroundMode = function(</td><td class="PParameter prettyprint " nowrap>on,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] let the plugin know that the app went to background mode (or vise versa). </div></div><div class=CToolTip id="tt24"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setMultiNotificationMode = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Allows multiple notifications to be displayed in the Android Notification Center</div></div><div class=CToolTip id="tt25"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setSingleNotificationMode = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Allows only the last one notification to be displayed in the Android Notification Center</div></div><div class=CToolTip id="tt26"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setSoundType = function(</td><td class="PParameter prettyprint " nowrap>type,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Sets default sound to play when push notification arrive.</div></div><div class=CToolTip id="tt27"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setVibrateType = function(</td><td class="PParameter prettyprint " nowrap>type,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Sets default vibration mode when push notification arrive.</div></div><div class=CToolTip id="tt28"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setLightScreenOnNotification = function(</td><td class="PParameter prettyprint " nowrap>on,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Turns the screen on if notification arrives</div></div><div class=CToolTip id="tt29"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setEnableLED = function(</td><td class="PParameter prettyprint " nowrap>on,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Enables led blinking when notification arrives and display is off</div></div><div class=CToolTip id="tt30"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getPushHistory = function(</td><td class="PParameter prettyprint " nowrap>success</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Returns array of push notifications received.</div></div><div class=CToolTip id="tt31"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">PushNotification.prototype.clearPushHistory = function()</td></tr></table></blockquote>[android] Clears push history</div></div><div class=CToolTip id="tt32"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.cancelAllLocalNotifications = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[ios] Clears all notifications from the notification center</div></div><!--END_ND_TOOLTIPS-->
149
-
150
-
151
-
152
-
153
- <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
154
-
155
-
156
- <script language=JavaScript><!--
157
- if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
package/Documentation/index/Classes.html DELETED
@@ -1,33 +0,0 @@
1
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
2
-
3
- <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Class Index</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="IndexPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
4
- if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
5
-
6
- <!-- Generated by Natural Docs, version 1.52 -->
7
- <!-- http://www.naturaldocs.org -->
8
-
9
- <!-- saved from url=(0026)http://www.naturaldocs.org -->
10
-
11
-
12
-
13
-
14
- <div id=Index><div class=IPageTitle>Class Index</div><div class=INavigationBar>$#! &middot; 0-9 &middot; A &middot; B &middot; C &middot; D &middot; E &middot; F &middot; G &middot; H &middot; I &middot; J &middot; K &middot; L &middot; M &middot; N &middot; O &middot; <a href="#P">P</a> &middot; Q &middot; R &middot; S &middot; T &middot; U &middot; V &middot; W &middot; X &middot; Y &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="P"></a>P</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')" class=ISymbol>PushNotification</a></td></tr></table>
15
- <!--START_ND_TOOLTIPS-->
16
- <div class=CToolTip id="tt1"><div class=CClass>Class to interact with Pushwoosh Push Notifications plugin</div></div><!--END_ND_TOOLTIPS-->
17
-
18
- </div><!--Index-->
19
-
20
-
21
- <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
22
-
23
-
24
- <div id=Menu><div class=MEntry><div class=MFile><a href="../files/PushNotification-js.html">PushNotification</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MIndex id=MSelected>Classes</div></div><div class=MEntry><div class=MIndex><a href="General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="Functions.html">Functions</a></div></div></div></div></div><script type="text/javascript"><!--
25
- var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
26
- --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Functions">Functions</option></select></div></div><!--Menu-->
27
-
28
-
29
- <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
30
-
31
-
32
- <script language=JavaScript><!--
33
- if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
package/Documentation/index/Functions.html DELETED
@@ -1,61 +0,0 @@
1
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
2
-
3
- <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Function Index</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="IndexPage" onLoad="NDOnLoad()"><script language=JavaScript><!--
4
- if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
5
-
6
- <!-- Generated by Natural Docs, version 1.52 -->
7
- <!-- http://www.naturaldocs.org -->
8
-
9
- <!-- saved from url=(0026)http://www.naturaldocs.org -->
10
-
11
-
12
-
13
-
14
- <div id=Index><div class=IPageTitle>Function Index</div><div class=INavigationBar>$#! &middot; 0-9 &middot; <a href="#A">A</a> &middot; B &middot; <a href="#C">C</a> &middot; D &middot; E &middot; F &middot; <a href="#G">G</a> &middot; H &middot; I &middot; J &middot; K &middot; L &middot; M &middot; N &middot; <a href="#O">O</a> &middot; <a href="#P">P</a> &middot; Q &middot; <a href="#R">R</a> &middot; <a href="#S">S</a> &middot; T &middot; <a href="#U">U</a> &middot; V &middot; W &middot; X &middot; Y &middot; Z</div><table border=0 cellspacing=0 cellpadding=0><tr><td class=IHeading id=IFirstHeading><a name="A"></a>A</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.addToApplicationIconBadgeNumber" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')" class=ISymbol>addToApplicationIconBadgeNumber</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=IHeading><a name="C"></a>C</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.cancelAllLocalNotifications" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')" class=ISymbol>cancelAllLocalNotifications</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.clearLaunchNotification" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')" class=ISymbol>clearLaunchNotification</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.clearLocalNotification" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')" class=ISymbol>clearLocalNotification</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.clearNotificationCenter" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')" class=ISymbol>clearNotificationCenter</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.clearPushHistory" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')" class=ISymbol>clearPushHistory</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.createLocalNotification" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')" class=ISymbol>createLocalNotification</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=IHeading><a name="G"></a>G</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.getApplicationIconBadgeNumber" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')" class=ISymbol>getApplicationIconBadgeNumber</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.getLaunchNotification" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')" class=ISymbol>getLaunchNotification</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.getPushHistory" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')" class=ISymbol>getPushHistory</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.getPushToken" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')" class=ISymbol>getPushToken</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.getPushwooshHWID" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')" class=ISymbol>getPushwooshHWID</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.getRemoteNotificationStatus" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')" class=ISymbol>getRemoteNotificationStatus</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.getTags" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')" class=ISymbol>getTags</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=IHeading><a name="O"></a>O</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.onDeviceReady" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')" class=ISymbol>onDeviceReady</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=IHeading><a name="P"></a>P</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.postEvent" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')" class=ISymbol>postEvent</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=IHeading><a name="R"></a>R</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.registerDevice" id=link17 onMouseOver="ShowTip(event, 'tt17', 'link17')" onMouseOut="HideTip('tt17')" class=ISymbol>registerDevice</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=IHeading><a name="S"></a>S</td><td></td></tr><tr><td class=ISymbolPrefix id=IFirstSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.setApplicationIconBadgeNumber" id=link18 onMouseOver="ShowTip(event, 'tt18', 'link18')" onMouseOut="HideTip('tt18')" class=ISymbol>setApplicationIconBadgeNumber</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.setBeaconBackgroundMode" id=link19 onMouseOver="ShowTip(event, 'tt19', 'link19')" onMouseOut="HideTip('tt19')" class=ISymbol>setBeaconBackgroundMode</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.setEnableLED" id=link20 onMouseOver="ShowTip(event, 'tt20', 'link20')" onMouseOut="HideTip('tt20')" class=ISymbol>setEnableLED</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.setLightScreenOnNotification" id=link21 onMouseOver="ShowTip(event, 'tt21', 'link21')" onMouseOut="HideTip('tt21')" class=ISymbol>setLightScreenOnNotification</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.setMultiNotificationMode" id=link22 onMouseOver="ShowTip(event, 'tt22', 'link22')" onMouseOut="HideTip('tt22')" class=ISymbol>setMultiNotificationMode</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.setSingleNotificationMode" id=link23 onMouseOver="ShowTip(event, 'tt23', 'link23')" onMouseOut="HideTip('tt23')" class=ISymbol>setSingleNotificationMode</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.setSoundType" id=link24 onMouseOver="ShowTip(event, 'tt24', 'link24')" onMouseOut="HideTip('tt24')" class=ISymbol>setSoundType</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.setTags" id=link25 onMouseOver="ShowTip(event, 'tt25', 'link25')" onMouseOut="HideTip('tt25')" class=ISymbol>setTags</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.setUserId" id=link26 onMouseOver="ShowTip(event, 'tt26', 'link26')" onMouseOut="HideTip('tt26')" class=ISymbol>setUserId</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.setVibrateType" id=link27 onMouseOver="ShowTip(event, 'tt27', 'link27')" onMouseOut="HideTip('tt27')" class=ISymbol>setVibrateType</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.startBeaconPushes" id=link28 onMouseOver="ShowTip(event, 'tt28', 'link28')" onMouseOut="HideTip('tt28')" class=ISymbol>startBeaconPushes</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.startLocationTracking" id=link29 onMouseOver="ShowTip(event, 'tt29', 'link29')" onMouseOut="HideTip('tt29')" class=ISymbol>startLocationTracking</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.stopBeaconPushes" id=link30 onMouseOver="ShowTip(event, 'tt30', 'link30')" onMouseOut="HideTip('tt30')" class=ISymbol>stopBeaconPushes</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=ISymbolPrefix id=ILastSymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.stopLocationTracking" id=link31 onMouseOver="ShowTip(event, 'tt31', 'link31')" onMouseOut="HideTip('tt31')" class=ISymbol>stopLocationTracking</a>, <span class=IParent>PushNotification</span></td></tr><tr><td class=IHeading><a name="U"></a>U</td><td></td></tr><tr><td class=ISymbolPrefix id=IOnlySymbolPrefix>&nbsp;</td><td class=IEntry><a href="../files/PushNotification-js.html#PushNotification.unregisterDevice" id=link32 onMouseOver="ShowTip(event, 'tt32', 'link32')" onMouseOut="HideTip('tt32')" class=ISymbol>unregisterDevice</a>, <span class=IParent>PushNotification</span></td></tr></table>
15
- <!--START_ND_TOOLTIPS-->
16
- <div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "colspan=2>PushNotification.prototype.addToApplicationIconBadgeNumber = function(</td></tr><tr><td>&nbsp;&nbsp;&nbsp;</td><td class="PParameter prettyprint " nowrap width=100%>badgeNumber</td></tr><tr><td class="PAfterParameters prettyprint "colspan=2>)</td></tr></table></td></tr></table></blockquote>[android, ios] Adds value to the application icon badge</div></div><!--END_ND_TOOLTIPS-->
17
-
18
-
19
- <!--START_ND_TOOLTIPS-->
20
- <div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.cancelAllLocalNotifications = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[ios] Clears all notifications from the notification center</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.clearLaunchNotification = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Clears launch notifiation, getLaunchNotification() will return null after this call.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">PushNotification.prototype.clearLocalNotification = function()</td></tr></table></blockquote>[android] Clears all pending local notifications created by createLocalNotification</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">PushNotification.prototype.clearNotificationCenter = function()</td></tr></table></blockquote>[android] Clears all notifications presented in Android Notification Center</div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">PushNotification.prototype.clearPushHistory = function()</td></tr></table></blockquote>[android] Clears push history</div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.createLocalNotification = function(</td><td class="PParameter prettyprint " nowrap>config,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Schedules local notification,</div></div><!--END_ND_TOOLTIPS-->
21
-
22
-
23
- <!--START_ND_TOOLTIPS-->
24
- <div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getApplicationIconBadgeNumber = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Returns the application icon badge number</div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getLaunchNotification = function(</td><td class="PParameter prettyprint " nowrap>callback</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Returns push notification payload if the app was started in response to push notification or null otherwise</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getPushHistory = function(</td><td class="PParameter prettyprint " nowrap>success</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Returns array of push notifications received.</div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getPushToken = function(</td><td class="PParameter prettyprint " nowrap>success</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Returns push token if it is available. </div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getPushwooshHWID = function(</td><td class="PParameter prettyprint " nowrap>success</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Returns Pushwoosh HWID used for communications with Pushwoosh API</div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getRemoteNotificationStatus = function(</td><td class="PParameter prettyprint " nowrap>callback,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>error</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Returns a detailed status of push notification permissions.</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.getTags = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Returns tags for the device including default tags</div></div><!--END_ND_TOOLTIPS-->
25
-
26
-
27
- <!--START_ND_TOOLTIPS-->
28
- <div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.onDeviceReady = function(</td><td class="PParameter prettyprint " nowrap>config</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Initialize Pushwoosh plugin and trigger a start push message Should be called on every app launch</div></div><!--END_ND_TOOLTIPS-->
29
-
30
-
31
- <!--START_ND_TOOLTIPS-->
32
- <div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.postEvent = function(</td><td class="PParameter prettyprint " nowrap>event,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>attributes</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Post events for In-App Messages. </div></div><!--END_ND_TOOLTIPS-->
33
-
34
-
35
- <!--START_ND_TOOLTIPS-->
36
- <div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.registerDevice = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Register device for push notifications and retreive a push Token</div></div><!--END_ND_TOOLTIPS-->
37
-
38
-
39
- <!--START_ND_TOOLTIPS-->
40
- <div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setApplicationIconBadgeNumber = function(</td><td class="PParameter prettyprint " nowrap>badgeNumber</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Set the application icon badge number</div></div><div class=CToolTip id="tt19"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setBeaconBackgroundMode = function(</td><td class="PParameter prettyprint " nowrap>on,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] let the plugin know that the app went to background mode (or vise versa). </div></div><div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setEnableLED = function(</td><td class="PParameter prettyprint " nowrap>on,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Enables led blinking when notification arrives and display is off</div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setLightScreenOnNotification = function(</td><td class="PParameter prettyprint " nowrap>on,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Turns the screen on if notification arrives</div></div><div class=CToolTip id="tt22"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setMultiNotificationMode = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Allows multiple notifications to be displayed in the Android Notification Center</div></div><div class=CToolTip id="tt23"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setSingleNotificationMode = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Allows only the last one notification to be displayed in the Android Notification Center</div></div><div class=CToolTip id="tt24"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setSoundType = function(</td><td class="PParameter prettyprint " nowrap>type,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Sets default sound to play when push notification arrive.</div></div><div class=CToolTip id="tt25"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setTags = function(</td><td class="PParameter prettyprint " nowrap>config,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Set tags for the device</div></div><div class=CToolTip id="tt26"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setUserId = function(</td><td class="PParameter prettyprint " nowrap>userId</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios] Set User indentifier. </div></div><div class=CToolTip id="tt27"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.setVibrateType = function(</td><td class="PParameter prettyprint " nowrap>type,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Sets default vibration mode when push notification arrive.</div></div><div class=CToolTip id="tt28"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.startBeaconPushes = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Starts beacon tracking</div></div><div class=CToolTip id="tt29"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.startLocationTracking = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Starts geolocation based push notifications. </div></div><div class=CToolTip id="tt30"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.stopBeaconPushes = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android] Stops beacon tracking</div></div><div class=CToolTip id="tt31"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.stopLocationTracking = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Stops geolocation based push notifications</div></div><!--END_ND_TOOLTIPS-->
41
-
42
-
43
- <!--START_ND_TOOLTIPS-->
44
- <div class=CToolTip id="tt32"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>PushNotification.prototype.unregisterDevice = function(</td><td class="PParameter prettyprint " nowrap>success,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>fail</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>[android, ios, wp8, windows] Unregister device form receiving push notifications</div></div><!--END_ND_TOOLTIPS-->
45
-
46
- </div><!--Index-->
47
-
48
-
49
- <div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
50
-
51
-
52
- <div id=Menu><div class=MEntry><div class=MFile><a href="../files/PushNotification-js.html">PushNotification</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Index</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MIndex><a href="Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="General.html">Everything</a></div></div><div class=MEntry><div class=MIndex id=MSelected>Functions</div></div></div></div></div><script type="text/javascript"><!--
53
- var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
54
- --></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Functions">Functions</option></select></div></div><!--Menu-->
55
-
56
-
57
- <div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
58
-
59
-
60
- <script language=JavaScript><!--
61
- if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>