/cordova-plugin-update-notifier

Cordova plugin for showing a notification for app updates.

Primary LanguageJavaApache License 2.0Apache-2.0

cordova-plugin-update-notifier

This plugin provides a mechanism for showing an in-app notification when a new version of the app is available for download from the App Store or Play Store.

For iOS, this uses the Siren library.

For Android, this implements the Play Store In-App Update system.

Installation

Cordova

cordova plugin add cordova-plugin-update-notifier

Capacitor

npm install cordova-plugin-update-notifier
npx cap sync

Note about Android strings for Capacitor

To override the text shown in the banner when an update is ready to install, add the following to app/src/main/res/values/strings.xml:

<string name="app_update_ready">An update has just been downloaded.</string>
<string name="app_update_install">RESTART</string>

Configuration Preferences

Non US-AppStore iOS apps

Siren's implementation for iOS requires specifying a country code if your app is not published to the US AppStore.

<preference name="SirenCountryCode" value="CA" />

For Capacitor, add "SirenCountryCode": "CA" to your capacitor.config.json file.

Supported Platforms

  • iOS (cordova-ios >= 5.0.0, or capacitor)
  • Android (cordova-android >= 8.0.0, or capacitor)

Contributing

Contributions of bug reports, feature requests, and pull requests are greatly appreciated!

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Licence

Released under the Apache 2.0 Licence.
Copyright © 2020 Ayogo Health Inc.