@simplifield/capacitor-app-update

Checks for app updates on Aplle Store and Google Play

Install

npm install @simplifield/capacitor-app-update
npx cap sync

API

• getAppUpdateInfo()
• openAppStore()
• Interfaces

getAppUpdateInfo()

getAppUpdateInfo() => Promise<AppUpdateInfo>

Supported platform(s): Android, iOS Returns app update informations.

Returns: Promise<AppUpdateInfo>

---

openAppStore()

openAppStore() => Promise<void>

Supported platform(s): Android, iOS Opens the app store entry of the app in the Play Store (Android) or App Store (iOS).

---

Interfaces

AppUpdateInfo

Prop	Type	Description
currentVersion	string	Supported platform(s): Android, iOS Version code (Android) or CFBundleShortVersionString (iOS) of the currently installed app version.
availableVersion	string	Supported platform(s): Android, iOS Version code (Android) or CFBundleShortVersionString (iOS) of the update.
availableVersionReleaseDate	string	Supported platform(s): iOS Release date of the update in ISO 8601 (UTC) format.
updateAvailability	0 | 1 | 2 | 3	Supported platform(s): Android, iOS The app update availability.
updatePriority	number	Supported platform(s): Android In-app update priority for this update, as defined by the developer in the Google Play Developer API.
immediateUpdateAllowed	boolean	Supported platform(s): Android true if an immediate update is allowed, otherwise false.
flexibleUpdateAllowed	boolean	Supported platform(s): Android true if a flexible update is allowed, otherwise false.