Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 3.14 KB

README.md

File metadata and controls

61 lines (40 loc) · 3.14 KB

OneSignal Cordova Push Notification Plugin

npm version npm downloads


⚠️ Migration Advisory for current OneSignal customers

Our new user-centric APIs and v5.x.x SDKs offer an improved user and data management experience. However, they may not be at 1:1 feature parity with our previous versions yet.

If you are migrating an existing app, we suggest using iOS and Android’s Phased Rollout capabilities to ensure that there are no unexpected issues or edge cases. Here is the documentation for each:

If you run into any challenges or have concerns, please contact our support team at [email protected]


OneSignal is a free email, sms, push notification, and in-app message service for mobile apps. This plugin makes it easy to integrate your Cordova based (e.g. Ionic, PhoneGap, and PhoneGap Build app with OneSignal.

Cordova Notification

Installation and Setup

See the Documentation for installation and setup instructions:

API

See OneSignal's Client SDK Reference page for a list of all available methods.

Change Log

See this repository's release tags for a complete change log of every released version.

Support

Please visit this repository's Github issue tracker for feature requests and bug reports related specificly to the SDK. For account issues and support please contact OneSignal support from the OneSignal.com dashboard.

Demo Projects

To make things easier, we have published an Ionic Capacitor React demo app in the /example folder of this repository.

To test it out, run:

ionic capacitor run android

ionic capacitor run ios

Legacy (Player Model) demo projects:

Supports:

  • Cordova, Ionic, Ionic Capacitor, and Phonegap
  • Android 4.1 (API Level 16) through 12 (API Level 31), and Amazon FireOS
  • iOS 9 - 15