This project is not under active development. Folks who are users of this plugin should switch to using cordova-plugin-push which is a fork of this project.
Register and receive push notifications
The links below take you to the version 2.x documentation which includes a number of breaking API changes from version 1.x, mostly the move from GCM to FCM. If you are using version 1.x please reference the docs in the v1.x branch.
What is this?
This plugin offers support to receive and handle native push notifications with a single unified API.
This does not mean you will be able to send a single push message and have it
arrive on devices running different operating systems. By default Android uses
FCM and iOS uses APNS and their payloads are significantly different. Even if
you are using FCM for both Android and iOS there are differences in the payload
required for the plugin to work correctly. For Android always put your push
payload in the
data section of the push notification. For more information on
why that is the case read
Notification vs Data Payload.
For iOS follow the regular
This plugin does not provide a way to determine which platform you are running
on. The best way to do that is use the
device.platform property provided by
Starting with version
2.0.0, this plugin will support
Firebase Cloud Messaging library. More details are available in the
- Reporting Issues
- API reference
- Typescript support
- Platform support
- Cloud build support (PG Build, IntelXDK)
- Push notification payload details
- License (MIT)