/cordova-plugin-ios-update-notifier

Cordova plugin for showing a notification for app updates on iOS.

Primary LanguageSwiftApache 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.

For iOS, this uses the Siren library.

Installation

Cordova

cordova plugin add cordova-plugin-update-notifier

Capacitor

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

Configuration Preferences

Alert Type

Siren's implementation for iOS allows for different alert types (see https://github.com/ArtSabintsev/Siren#screenshots). You can set the value to "critical" or "annoying" in config.xml.

<preference name="SirenAlertType" value="critical" />
<preference name="SirenAlertType" value="annoying" />

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.

Managed App Configuration

When deploying an app using an MDM, you can take advantage of Managed App Configuration to disable the update check. Simply create a preference called "DisableUpdateCheck" and set it's value to "true".

Supported Platforms

  • Cordova CLI (cordova-cli >= 9.0.0)
  • iOS (cordova-ios >= 5.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-2021 Ayogo Health Inc.