Awesome

⚠️ Deprecated repository

This project has been moved to the following monorepo: capawesome-team/capacitor-plugins.

This plugin supports retrieving app update information on Android and iOS.
Additionally, this plugin supports in-app updates on Android.

Maintainers

Sponsors

This is an MIT-licensed open source project. It can grow thanks to the support by these awesome people. If you'd like to join them, please read more here.

Installation

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

Android Variables

This plugin will use the following project variables (defined in your app’s variables.gradle file):

• $androidPlayCore version of com.google.android.play:core (default: 1.9.0)
• $androidPlayServicesBaseVersion version of com.google.android.gms:play-services-base (default: 18.0.1)

Configuration

No configuration required for this plugin.

Demo

A working example can be found here: robingenz/capacitor-plugin-demo

Usage

import { AppUpdate } from '@capawesome/capacitor-app-update';

const getCurrentAppVersion = async () => {
  const result = await AppUpdate.getAppUpdateInfo();
  return result.currentVersion;
};

const getAvailableAppVersion = async () => {
  const result = await AppUpdate.getAppUpdateInfo();
  return result.availableVersion;
};

const openAppStore = async () => {
  await AppUpdate.openAppStore();
};

const performImmediateUpdate = async () => {
  const result = await AppUpdate.getAppUpdateInfo();
  if (result.updateAvailability !== AppUpdateAvailability.UPDATE_AVAILABLE) {
    return;
  }
  if (result.immediateUpdateAllowed) {
    await AppUpdate.performImmediateUpdate();
  }
};

const startFlexibleUpdate = async () => {
  const result = await AppUpdate.getAppUpdateInfo();
  if (result.updateAvailability !== AppUpdateAvailability.UPDATE_AVAILABLE) {
    return;
  }
  if (result.flexibleUpdateAllowed) {
    await AppUpdate.startFlexibleUpdate();
  }
};

const completeFlexibleUpdate = async () => {
  await AppUpdate.completeFlexibleUpdate();
};

API

• getAppUpdateInfo(...)
• openAppStore(...)
• performImmediateUpdate()
• startFlexibleUpdate()
• completeFlexibleUpdate()
• addListener('onFlexibleUpdateStateChange', ...)
• removeAllListeners()
• Interfaces
• Enums

getAppUpdateInfo(...)

getAppUpdateInfo(options?: GetAppUpdateInfoOptions | undefined) => Promise<AppUpdateInfo>

Returns app update informations.

Only available for Android and iOS.

Returns: <code>Promise<<a href="#appupdateinfo">AppUpdateInfo</a>></code>

openAppStore(...)

openAppStore(options?: OpenAppStoreOptions | undefined) => Promise<void>

Opens the app store entry of the app in the Play Store (Android) or App Store (iOS).

Only available for Android and iOS.

performImmediateUpdate()

performImmediateUpdate() => Promise<AppUpdateResult>

Performs an immediate in-app update.

Only available for Android.

Returns: <code>Promise<<a href="#appupdateresult">AppUpdateResult</a>></code>

startFlexibleUpdate()

startFlexibleUpdate() => Promise<AppUpdateResult>

Starts a flexible in-app update.

Only available for Android.

Returns: <code>Promise<<a href="#appupdateresult">AppUpdateResult</a>></code>

completeFlexibleUpdate()

completeFlexibleUpdate() => Promise<void>

Completes a flexible in-app update by restarting the app.

Only available for Android.

addListener('onFlexibleUpdateStateChange', ...)

addListener(eventName: 'onFlexibleUpdateStateChange', listenerFunc: (state: FlexibleUpdateState) => void) => PluginListenerHandle

Adds a flexbile in-app update state change listener.

Only available for Android.

Returns: <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all listeners for this plugin.

Interfaces

AppUpdateInfo

GetAppUpdateInfoOptions

OpenAppStoreOptions

AppUpdateResult

PluginListenerHandle

FlexibleUpdateState

Enums

AppUpdateAvailability

FlexibleUpdateInstallStatus

AppUpdateResultCode

Test with internal app-sharing

The Android Developers documentation describes how to test in-app updates using internal app sharing: https://developer.android.com/guide/playcore/in-app-updates/test

Changelog

See CHANGELOG.md.

License

See LICENSE.