Skip to content

Latest commit

 

History

History
83 lines (54 loc) · 4.04 KB

README.md

File metadata and controls

83 lines (54 loc) · 4.04 KB

AeroGear PushPlugin Cordova

npm package

Dependency Status Known Vulnerabilities

This plugin makes starting with AeroGear Unified Push simple.

Project Info
License: Apache License, Version 2.0
Build: Cordova Plugin
Documentation: https://aerogear.org/docs/specs/aerogear-cordova/
Issue tracker: https://issues.jboss.org/browse/AGCORDOVA
Mailing lists: aerogear-users (subscribe)
aerogear-dev (subscribe)

Getting Started

Run tests

  1. Use your existing cordova app, or create a new one.
  2. Add the plugin and the tests:
cordova plugin add https://github.com/aerogear/aerogear-cordova-push.git
cordova plugin add https://github.com/aerogear/aerogear-cordova-push.git#:/tests
  1. Add this plugin:
cordova plugin add http://git-wip-us.apache.org/repos/asf/cordova-plugin-test-framework.git
  1. Change the start page in config.xml with <content src="cdvtests/index.html" /> or navigate to cdvtests/index.html from within your app.

Documentation

For more details about the current release, please consult our documentation.

Android notification icon

To show a better notification icon in Android Lollipop and above, create a transparent icon and name the file as "icon_white.png" and put into platforms/android/res/drawable folder.

Configuring Firebase Version

Many other plugins require Google Play Services and/or Firebase libraries. This is a common source of Android build-failures, since the library version must be aligned to the same version for all plugins. Use the FIREBASE_VERSION to align the required firebase-messaging version with other plugins.

For example:

cordova plugin add aerogear-cordova-push --variable FIREBASE_VERSION=18.0.0

AndroidX Support

This plugin has AndroidX support. This means that you should migrate your project to AndroidX. To prevent to do it manually everytime, there are 2 great plugins to migrate it:

  1. First, enable AndroidX adding the cordova-plugin-androidx plugin:
cordova plugin add cordova-plugin-androidx
  1. If you encounter build failures after installing (or after manually enabling AndroidX), try to install cordova-plugin-androidx-adapter into your project. It will migrate any references from the legacy Android Support library to use the new AndroidX which should resolve build failures.
cordova plugin add cordova-plugin-androidx-adapter

Development

If you would like to help develop AeroGear you can join our developer's mailing list, join #aerogear on Freenode, or shout at us on Twitter @aerogears.

Also takes some time and skim the contributor guide

Questions?

Join our user mailing list for any questions or help! We really hope you enjoy app development with AeroGear!

Found a bug?

If you found a bug please create a ticket for us on Jira with some steps to reproduce it.