Skip to content

Latest commit

 

History

History
136 lines (93 loc) · 4.22 KB

README.md

File metadata and controls

136 lines (93 loc) · 4.22 KB
Raw

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.

ℹ️ This plugin uses AndroidX!

Use version 1.x if you are building without AndroidX enabled.

Installation

Cordova

cordova plugin add cordova-plugin-update-notifier

Specifying Android Library Versions

You may need to specify specific versions of the Android Material Design or Play App Update frameworks, depending on the Android SDK version and build tools that your app is targeting. You can override these by specifying versions as variables when installing.

For example:

cordova plugin add cordova-plugin-update-notifier \
    --variable ANDROIDX_MATERIAL_DESIGN_VERSION=1.8.0 \
    --variable PLAY_APP_UPDATE_SDK_VERSION=2.1.0

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

Alert Type

Siren's implementation for iOS allows for different alert types (see https://github.com/ArtSabintsev/Siren#screenshots and https://github.com/ArtSabintsev/Siren/blob/6139af3394bc3635c6c8d5255339796feaa7d1a0/Sources/Models/Rules.swift#L12). You can set the value to "critical", "annoying", "persistent", "hinting" and "relaxed" in config.xml.

<preference name="SirenAlertType" value="critical" />
<preference name="SirenAlertType" value="annoying" />
<preference name="SirenAlertType" value="persistent" />
<preference name="SirenAlertType" value="hinting" />
<preference name="SirenAlertType" value="relaxed" />

For Android, you can force all updates to be considered "immediate" with the AndroidUpdateAlertType preference in config.xml.

<preference name="AndroidUpdateAlertType" value="Immediate" />

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)
  • Android (cordova-android >= 9.0.0, or capacitor) with AndroidX

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-2023 Ayogo Health Inc.