Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

phonegap-plugin-push-bdg

phonegap48MIT1.11.3TypeScript support: included

Register and receive push notifications.

ecosystem:cordova, ecosystem:phonegap, cordova-ios, cordova-android, cordova-windows8, cordova-windows, cordova-wp8, cordova-browser

readme

phonegap-plugin-push-bdg Build Status

Register and receive push notifications

What is this?

This plugin offers support to receive and handle native push notifications with a single unified API.

Starting with version 2.0.0, this plugin will support CocoaPods installation of the Firebase Cloud Messaging library. More details are available in the Installation documentation.

Do you like tutorial? You get tutorial!

changelog

Change Log

v1.10.4 (2017-05-17)

Full Changelog

  • 1.10.4 view commit
  • :bookmark: Bumping plugin version to 1.10.4 view commit
  • :penguin::bug: Issue #1710: Notification message key overwritten view commit
  • :penguin::bug: Issue #1710: Notification message key overwritten view commit
  • :penguin: Fix issue #1663 by allowing message as the data payload key (#1666) view commit
  • [typo] Small fix to payload doc view commit
  • :memo: update readme view commit
  • :memo: Fix PAYLOAD.md regarding "drawable" directory name (#1711) view commit
  • Updating CHANGELOG view commit

v1.10.3 (2017-20-04)

Full Changelog

  • 1.10.3 view commit
  • :bookmark: Bumping plugin version to 1.10.3 view commit
  • :bug: Handle null in getCircleBitmap (#1705) view commit
  • :shirt: Issue #1702: The logging tag can be at most 23 characters, was 40 (PushPlugin_BackgroundActionButtonHandler) view commit
  • Shortened log tag PushPlugin_BackgroundActionButtonHandler to bring u… (#1703) view commit
  • :memo: Docs for interoperability with Firebase (#1693) view commit
  • fix headline (#1685) view commit
  • Fix changelog date view commit
  • :arrow_up: update pluginpub to 0.0.8 view commit
  • Updating CHANGELOG view commit

v1.10.2 (2017-04-12)

Full Changelog

v1.10.1 (2017-04-07)

Full Changelog

  • 1.10.1 view commit
  • :bookmark: Bumping plugin version to 1.10.1 view commit
  • :bug: Issue #1655: App opens on clearing notification (Android) view commit
  • :memo: Issue #1118: Problem with notifications stacking view commit
  • :memo: Issue #1220: [Question] the hook setting seem not work view commit
  • Set get badge count android (#1644) view commit
  • Add plugin typings from DefinitelyTyped (#1654) view commit
  • :arrow_up: Issue #1560: setApplicationIconBadgeNumber not working on Android but firing success function view commit
  • :memo: Issue #1618: No notification when app is closed on Android, not at all on iOS view commit
  • :arrow_down: Issue #1560: setApplicationIconBadgeNumber not working on Android but firing success function view commit
  • :arrow_up: Issue #1560: setApplicationIconBadgeNumber not working on Android but firing success function view commit
  • Updating CHANGELOG view commit

v1.10.0 (2017-03-10)

Full Changelog

  • 1.10.0 view commit
  • :bookmark: Bumping plugin version to 1.10.0 view commit
  • :heavy_plus_sign: update pluginpub version view commit
  • Issue #1464: Create round bitmap icon for large icon image passed in from local resource or url (#1635) view commit
  • Receive notification only from SENDER_ID (#1484) view commit
  • Add no-cache flag to payload (#1620) view commit
  • Add dismiss key to on notification data (#1621) view commit
  • return true for old android versions, since AppOpsManager is available starting at 19 (#1634) view commit
  • :art: remove reference to unused String view commit
  • Ability to use custom keys to find message title and text on Android (#1604) view commit
  • :memo: Fixed URL of apples custom sound documentation (#1600) view commit
  • Updating CHANGELOG view commit

v1.9.4 (2016-07-09)

Full Changelog

v1.9.3 (2016-07-09)

Full Changelog

  • 1.9.3 view commit
  • :bookmark: Bumping plugin version to 1.9.3 view commit
  • :wrench: Add valid SPDX license expression view commit
  • :memo: Issue #1587: v2.0.0-rc2: .on('notification') event not fired when background notification in Android view commit
  • :arrow_up: Issue #1560: setApplicationIconBadgeNumber not working on Android but firing success function view commit
  • :memo: Issue #1557: push.on('notification') not triggered - Ionic view commit
  • :memo: Issue #1407: Uncaught (in promise): Error: Push plugin not found! view commit
  • Corrected merges usage to prevent possible conflicts with other plugins (#1538) view commit
  • :penguin: android mixpanel pushnotification suport added (#1523) view commit
  • :memo: Making string replacement clearer view commit
  • :bug::penguin::memo: Issue #1433: Cordova Push V5 register () crashes App when initialized with topicList view commit
  • :bug::penguin: Issue #1421: Notification delay caused by icon bitmap timeout view commit
  • :memo: Issue #1442: CocoaPods support vs requirement view commit
  • make google_app_id non translatable string (#1485) view commit
  • :penguin::bug: Issue #1474: Android: force-start starts the app in Foreground instead of Background view commit
  • Updating CHANGELOG view commit

v1.9.2 (2016-07-09)

Full Changelog

v1.9.1 (2016-07-09)

Full Changelog

  • 1.9.1 view commit
  • Bumping plugin version to 1.9.1 view commit
  • :bug: Issue #1412: push.subscribe 'not a function' error view commit
  • :memo: Add emoji guide to CONTRIBUTING view commit
  • Issue #1342: Fail to add 1.9.0 to ios platform view commit
  • Issue #1402: force-start:1 brings a killed application to foreground, not background view commit
  • Issue #1400: Version 1.9.0 on PGB not working view commit
  • Merge pull request #1398 from getlarky/android-badge-documentation view commit
  • Warn about android badge support in documentation view commit
  • Enahancement : Add custom permission for PushHandlerActivity (#1362) view commit
  • Issue #1248: upgrade ShortcutBadger version to latest view commit
  • Merge pull request #1361 from pataar/master view commit
  • Fix minor typos in INSTALLATION.md view commit
  • Add mimimum cordova versions to installation docs view commit
  • Updating CHANGELOG view commit

v1.9.0 (2016-07-09)

Full Changelog

v1.8.4 (2016-07-09)

Full Changelog

v1.8.3 (2016-07-09)

Full Changelog

  • 1.8.3 view commit
  • Bumping plugin version to 1.8.3 view commit
  • Update pluginpub version view commit
  • Issue#1282 Show app name if title is empty (#1285) view commit
  • Note about background app refresh (#1267) view commit
  • Issue #1213: XDK instructions link for www template is incorrect (#1283) view commit
  • Merge pull request #1277 from dannywillems/patch-1 view commit
  • Unused variable app. Caused warnings. view commit
  • Issue #1254: [Question] Is it possible to get more than 3 action buttons on Android notifications? view commit
  • Use unique pending intent request code to enable multiple... (#1225) view commit
  • Add cordovaDependencies section to package.json (#1232) view commit
  • Updating CHANGELOG view commit

v1.8.2 (2016-07-09)

Full Changelog

  • 1.8.2 view commit
  • Bumping plugin version to 1.8.2 view commit
  • Localization from resources (#1196) view commit
  • Issue #1199: iOS 10 is not firing the 'notification' event after clicking on a notification when the app is in hibernate view commit
  • Use unique pending intent request code to enable multiple simultaneous notifications with action buttons (#1216) view commit
  • (doc) Fixing ios.catetories type in api reference. view commit
  • Issue #1155: [doc] Explain usage of the top level "priority" in GCM notifications view commit
  • Issue #1121: Notification is not shown on ios device view commit
  • Issue #1160: data.additionalData.[Object] as 'undefined' in iOS view commit
  • Few edits (#1179) view commit
  • Adding workshop tutorial link to the README (#1169) view commit
  • added Azure server-side example (#1124) view commit
  • Update appxmanifests with ToastCapable=true after plugin install (#1158) view commit
  • Updating CHANGELOG view commit

v1.8.1 (2016-07-09)

Full Changelog

v1.8.0 (2016-07-09)

Full Changelog

1.7.4 (2016-07-09)

Full Changelog

Closed issues:

  • FYI: Resumed iOS 10 Notifications results in an error (fix problem on iOS) #1002

1.7.3 (2016-07-06)

Full Changelog

Closed issues:

  • Implemented clearBadge for Android #1030
  • update badge number even if the app is totally closed #1027
  • Documentation issue of Android pictures push #1028
  • [iOS] unregister for a topic: parameter is not consistent between ios/android #1029
  • [doc] Error installing in IOS, version requirement: >=4.1.0 #1047

1.7.2 (2016-06-24)

Full Changelog

Closed issues:

  • FYI: Resumed iOS 10 Notifications results in an error #1002

1.7.1 (2016-06-17)

Full Changelog

Closed issues:

  • Update docs for Android badges #982
  • visibility not working #987
  • Revert pinning of support-v13 #983

1.7.0 (2016-06-06)

Full Changelog

Closed issues:

  • disable notification's sounds on a per notification basis #885
  • Android GCM Action Buttons lack of documentation #884
  • Android double on('notification') fired #828
  • Device should register, Push Notification should receive on IOS (IntelXDK) #926
  • Use cordova-ios 4.1.0 in Milestone 1.7.0 #751
  • Badge on android #190
  • JS error in Success callbackId: PushNotifiation###.. whenever a notification is sent to the device #824
  • coldstart flag always set to true if the app has been opened through an alert, on ios 9.3.1, plugin version 1.6.2 cordova 6.1.0 cordova ios 4.1.1 #795
  • Is there any way to clear notifications out from the app? #346
  • Show contents of notification when phone is locked #750
  • PushPlugin.m init() should send pending notification when js side is ready #658

1.6.4 (2016-05-24)

Full Changelog

Closed issues:

  • hasPermission() for windows #874
  • Latest Play store service breaks phonegap-plugin-push #909

1.6.3 (2016-04-27)

Full Changelog

Fixed bugs:

  • [Android] Can't install multiple apps using this plugin (v1.6.x) #768
  • JS error in "Success callbackId: PushNotifiation###.." whenever a notification is sent to the device #824

Closed issues:

  • Move example directory to a phonegap template #832
  • va #830
  • does not create the notification bar #821
  • Did not show notification in status bar for Xiomi Redmi Note 3 #790
  • PushNotification.hasPermission not working as expected #789

1.6.2 (2016-04-06)

Full Changelog

Fixed bugs:

  • Unexpected / Broken Android Behavior #767

Closed issues:

  • Android: JSON Exception No Value Found for Sender #781
  • Should I call init() every time the app is launched?? #777
  • Request: extend action buttons to wearables #776
  • After upgrade: 601 duplicate symbols for architecture i386 #769
  • push plugin #766
  • Documentation mentions old name for dependency #763
  • push.on('notification') callback is not called on coldstart on iOS #758
  • plugin doesn't work in background or when app not running on kitkat 4.4.2 #754
  • App Icon not displayed in tray using build.phonegap and cli-6.0.0 [ios] #753
  • push.on('registration') event not called on IOS. #752
  • catch 22 when trying to use this plug #741
  • push.setApplicationIconBadgeNumber not working in background #736
  • Strange issue while debugging in Safari Inspector #733

1.6.1 (2016-03-23)

Full Changelog

Fixed bugs:

  • App crashes on notification when in background #715

Closed issues:

  • Memory Leak when call push.on\('registration'. so Push Plugin register called not called #743
  • l #739
  • [testing issue template] ignore me #717
  • Incorrect init option "vibration" in a few ios samples on PAYLOAD.md #713
  • android M wear case #691
  • Incorrect document detailing (PHONEGAP_BUILD.md) #686
  • Windows Phone 8.1, not fired plugin methods #526

1.6.0 (2016-03-09)

Full Changelog

Implemented enhancements:

  • Background processing with coldstart on iOS #583

Fixed bugs:

  • Android: notification does not dismiss after selection button (1.6.x dev) #610

Closed issues:

  • XDK doesn't work with v1.5.x. Are you going to have a non-gradle version for v1.5.x #675
  • emoji support #668
  • iOS sound not found [edited with new debug info] #667
  • Push notification register APN to GCM Problem #665
  • IOS Never fire the registration event #659
  • Badge count inaccurate #651
  • Android Icon options in phonegap-plugin-push@1.2.3 #648
  • Getting same registration id when re-register #641
  • Callback not called unless you register to GCM everytime you open the app #626
  • How to make GCM show alert automatically ios #602
  • Shoddy image for notification icon,status bar icon? #587
  • ERROR: Plugin 'PushNotification' not found #568
  • ar #533
  • No sound and vibration for GCM when built with Cordova but Ok with PhoneBuild #520

1.5.3 (2016-01-14)

Full Changelog

Fixed bugs:

  • Android 4.1 and AppOpsManager #495

Closed issues:

  • iOS Building Error #507
  • [FIX] notification not fired when app is in background/killed ? Check this out #502
  • Which Sender ID to use #485
  • coldstart not documented #483
  • Android: iconColor doesn't work in hexadecimal (#RRGGBB) format #480
  • Cannot find symbol variable INSTANCE_ID_SCOPE #477
  • notification event not fired on cold start on Android 5 #469
  • Push notifications not working with iPhone6 + ios 9.2? #462
  • UTF8 support on android: the notification text (on android only) is shown with "???" #461
  • example application? #460
  • build fail in ios - version 1.5.2 #458
  • Getting NotRegistered error when sending GCM push notification, but the device never unregistered #419
  • Changelog neglected #412

1.5.2 (2015-12-21)

Full Changelog

Fixed bugs:

  • notification_applicationDidBecomeActive method #447

1.5.1 (2015-12-18)

Full Changelog

Closed issues:

  • Unsubscribing to topics should not clear event handlers #443

1.5.0 (2015-12-18)

Full Changelog

Fixed bugs:

  • Make sure iOS/Android can receive the same GCM payload #401

Closed issues:

  • Using stacking notifications but only able to process one #435
  • Cant find stacking docs #430
  • Android Marshmallow 6.0 push icon #422
  • Distinguish between 'android' or 'ios' on registration event #418
  • Phonegap Build Issues for 1.4.X #417
  • using in Ionic #416
  • notification event not called on ios #414
  • [docs] detail on deviceready dependency #410
  • iOS: Plugin does not start #404
  • Process notifications in background #398
  • On iOS 9 the badge does not clear #395
  • Background notification OK, but event "notification" never called #387
  • Android action button callback not triggered #298

1.4.5 (2015-12-03)

Full Changelog

Fixed bugs:

  • register -> unregister lifecycle #368

Closed issues:

  • jshint support #380
  • Platform support #379
  • Ionic implemenation #364
  • on registration callback getting called repeatedly. #353
  • on("notification") dont fire when the app its open #351

1.4.4 (2015-11-20)

Full Changelog

Fixed bugs:

  • InstanceID.getToken() not called in an Intent #354
  • Handle both data and notification payloads in the same GCM push #343
  • [INSTALL_FAILED_CONFLICTING_PROVIDER] #320
  • Getting "Error : Empty registration ID received from GCM" #315

Closed issues:

  • xcode build fails with phonegap-plugin-push #358
  • App crashes after adding push plugin and wikipedia app installed #357
  • Conflict when compiling with com.google.maps #355

1.4.3 (2015-11-18)

Full Changelog

Closed issues:

  • [Question] about the action's icon color #348
  • Can I access Web API's from 'notification' handler? #335
  • Init Error: Missing Instance ID Service #334
  • Install issue #332
  • Multiple Apps gets error #330
  • Can't find variable PushNotification #328
  • When app is in background, clicking on Android notification in shade opens app but does not trigger the on('notification') event handler #326
  • "Missing Command Error" when running in browser #318
  • Small icon not working #316
  • Duplicate push notifications happening on iOS when phone is unlocked #309
  • Is it possible to add badge on Android portion. #308
  • [just a question] about the priority #306
  • Android - After unregister and reregister no notifications #304
  • Amazon-Fireos and Blackberry 10 support #300
  • 1.4.x not showing notification on Android #299
  • "push.unregister" not really work in iOS #296

1.4.2 (2015-11-03)

Full Changelog

Closed issues:

  • data.registrationId is empty string "" on register event callback #295

1.4.1 (2015-11-02)

Full Changelog

1.4.0 (2015-10-27)

Full Changelog

Implemented enhancements:

  • Use Google's InstanceID API #188

Closed issues:

  • How to handle a re-installed app? #203
  • interactive push notifications? #266
  • Empty registrationId Android #265
  • Run callback when clicking of notification body #261
  • Android BUILD FAILED #251
  • Re-register #250
  • how to work in background ? #249
  • installing plugin #244
  • No Sound and vibration #242
  • Unable to build apk #241
  • still having problems with build. #239
  • Registering on iOS 9 #238
  • Custom sound repeated multiple times on Android #237
  • Android: status bar notification is not shown #236
  • Multiple Push Notifications - phonegap build #234
  • error: cannot find symbol String token = InstanceID.getInstance(getApplicationContext()).getToken(senderID, GCM); #231
  • Problem using "ledColor" and "VibrationPattern" #229
  • Notificaction event receive, but not notification showing on android #228
  • Events for registration not being fired #227
  • 'registration' event not firing on windows phone #224
  • Can i subscribe to a topic in using plugin? #219
  • GCMIntentService.java:472: error: cannot find symbol iconColor #217
  • Push Plugin registering on iOS 9 Devices but not showing Notification #216
  • Receiving a notification "outside app" while in it? #213
  • iOS push not working for device tokens when spaces removed #212
  • Error: Plugin PushPlugin failed to install. #210
  • Build error #205
  • Android push.on('registration', cb) fires correctly on device, but not in emulator. #204
  • 1.3.0 version not compatible with "crosswalk" by PGB #199
  • How to get data on didReceiveNotification Background Process #198
  • PushNotification is not defined in some devices #196
  • not getting notifications on the Android device #195
  • Installation Errors #186
  • IOS: on registration fired twice #185
  • Build failed with exit code 8 #184
  • iOS: Not able to schedule local notification after adding the plugin #183
  • How to show multiple notifications individually in android? #181
  • iOS init option type #180
  • Building for Android is a quest #179
  • How do i tell if the user open the app by tapping the notification? #176
  • IOS custom push sound when app is in background #175
  • Hi guys please post full working procedure, I'm not able to get registration id also. Please help #174
  • Has anyone tested this plugin on windows? #173

1.3.0 (2015-09-21)

Full Changelog

Implemented enhancements:

  • How to use GCM 3.0 with this plugin? #127
  • Android: possibility to send a notification with a title and without message #122
  • Enhancement - Led, Vibration Pattern, Priority on Android #105

Fixed bugs:

  • It is using in gcm data.additionalData ? #126
  • iOS notification from cold boot #117
  • Notification LED is not working #97

Closed issues:

  • Know which version is used in build service #151
  • Registration is not working in IOS9 #150
  • build fail on android #149
  • iconColor does not set icon background on Android #146
  • Prevent windows toast notification when in foreground #145
  • How to implement push notification for ios with this plug-in? #143
  • After installing this plugin I can't build on Android #141
  • version 1.2.3 #134
  • New inbox style on android #131
  • impossible to install the phonegap-plugin-push Error #130
  • Hello, i am developing a cordova app which requires push notifications to be sent to users android phone, so i tried using this new phonegap push plugin as old one is deprecated, and it keeps giving me an error in console: Uncaught ReferenceError: module is not defined --- Line 154 Push.js and i dont have much experience with cordova, so can anyone assist me ? #128
  • INVALID_REGISTRATION when http post request with to IOS #123
  • Andriod :More than 2 notifications in status bar it is not works. #121
  • Release notes for 1.2.x #119
  • Google cloud messaging GCM - Push Notification not being sent (Server Side) #110

1.2.3 (2015-09-08)

Full Changelog

Fixed bugs:

  • Notification not showing..... #101
  • Same data payload for messages with action buttons #90

Closed issues:

  • Notification doesn't show the app icon #112
  • Notification doesn't show the app icon #111
  • Issue with plugin facebook connect #107
  • Cordova Support #99
  • Uncaught ReferenceError: cordova is not defined, http://localhost:8100/lib/push.js, Line: 7 #98
  • Notifications never received on Android #96
  • How know the way the app was launched #95
  • Android, example doesn't work when it goes into background #94
  • Utilizing push plugin #91

1.2.2 (2015-08-31)

Full Changelog

Closed issues:

  • PushPlugin notification icon is too big #88

1.2.1 (2015-08-31)

Full Changelog

Implemented enhancements:

  • Question about GCM Notifications and data in the message payload #87

Fixed bugs:

  • Notification callback for pushes without a message #80

Closed issues:

  • Android: No notification displayed on device. Notification event never called. #86
  • it seem no wp8 version for now #56

1.2.0 (2015-08-25)

Full Changelog

Implemented enhancements:

  • Implement Inbox style for Android #74
  • multi-line text support #63

Fixed bugs:

  • Pushes being deleted from notification bar when cold start #67

Closed issues:

  • oficial push plugin and windows and wp8 compatibility #71
  • On Android, GCMIntentService.onError() doesn't get passed to the JavaScript "error" event #65
  • Android: add property to vibrate phone on received notification #61
  • push.on => "registration" will trigger twice times that only in iOS #57

1.1.1 (2015-07-27)

Full Changelog

1.1.0 (2015-07-27)

Full Changelog

Implemented enhancements:

  • iOS doesn't add foreground key #41
  • Android: Notification icon problem #20
  • iOS badge number #18
  • How i can set icons for push notifications in status bar and push view in android #14
  • Support Win8.1 + Phone 8.1 Universal Apps (WNS), drop support for WP8.0 (MPNS) #13

Fixed bugs:

  • iOS only reads out "aps" payload #29
  • Event not fired when in background #24
  • Custom notification sound in background mode? #17

Closed issues:

  • iOS only receives first notification in foreground #42
  • Cannot register on iOS #30
  • Fix Android paths in src folder #23
  • PushNotification not defined #21
  • Error trying to remove the plugin #19
  • Handling multiple notifications on Android devices #12
  • PGB (build.phonegap.com) problem #11
  • reporting location via gcm #6

Merged pull requests:

1.0.1 (2015-06-08)

Full Changelog

Closed issues:

  • documentation "senderId" correction #10
  • add to our ci page #9
  • Update installation instructions #7

1.0.0 (2015-06-05)

Closed issues:

  • Update code using enabledRemoteNotificationTypes because it is “not supported in iOS 8” #8
  • Register method not working #4
  • Publish plugin to npm #3
  • Update example to use new API #2
  • Lowercase Example/ directory #1

* This Change Log was automatically generated by github_changelog_generator