@capawesome/capacitor-app-update
Version:
Capacitor plugin that assists with app updates.
242 lines (241 loc) • 6.84 kB
TypeScript
import type { PluginListenerHandle } from '@capacitor/core';
export interface AppUpdatePlugin {
/**
* Returns app update informations.
*
* Only available on Android and iOS.
*/
getAppUpdateInfo(options?: GetAppUpdateInfoOptions): Promise<AppUpdateInfo>;
/**
* Opens the app store entry of the app in the Play Store (Android) or App Store (iOS).
*
* Only available on Android and iOS.
*/
openAppStore(options?: OpenAppStoreOptions): Promise<void>;
/**
* Performs an immediate in-app update.
*
* Only available on Android.
*/
performImmediateUpdate(): Promise<AppUpdateResult>;
/**
* Starts a flexible in-app update.
*
* Only available on Android.
*/
startFlexibleUpdate(): Promise<AppUpdateResult>;
/**
* Completes a flexible in-app update by restarting the app.
*
* Only available on Android.
*/
completeFlexibleUpdate(): Promise<void>;
/**
* Adds a flexbile in-app update state change listener.
*
* Only available on Android.
*/
addListener(eventName: 'onFlexibleUpdateStateChange', listenerFunc: (state: FlexibleUpdateState) => void): Promise<PluginListenerHandle>;
/**
* Remove all listeners for this plugin.
*/
removeAllListeners(): Promise<void>;
}
export interface GetAppUpdateInfoOptions {
/**
* The two-letter country code for the store you want to search.
* See http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 for a list of ISO Country Codes.
*
* Only available on iOS.
*/
country?: string;
}
export interface AppUpdateInfo {
/**
* The current version name of the app.
*
* On **Android**, this is the `versionName` from the `android/app/build.gradle` file.
* On **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.
*
* Only available on Android and iOS.
*
* @since 5.1.0
* @example "1.0.0"
*/
currentVersionName: string;
/**
* The available version name of the update.
*
* On **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file.
*
* Only available on iOS.
*
* @since 5.1.0
* @example "1.1.0"
*/
availableVersionName?: string;
/**
* The current version code of the app.
*
* On **Android**, this is the `versionCode` from the `android/app/build.gradle` file.
* On **iOS**, this is the `CFBundleVersion` from the `Info.plist` file.
*
* Only available on Android and iOS.
*
* @since 5.1.0
* @example "1"
*/
currentVersionCode: string;
/**
* The available version code of the update.
*
* On **Android**, this is the `versionCode` from the `android/app/build.gradle` file.
*
* Only available on Android.
*
* @since 5.1.0
* @example "2"
*/
availableVersionCode?: string;
/**
* Release date of the update in ISO 8601 (UTC) format.
*
* Only available on iOS.
*/
availableVersionReleaseDate?: string;
/**
* The app update availability.
*
* Only available on Android and iOS.
*/
updateAvailability: AppUpdateAvailability;
/**
* In-app update priority for this update, as defined by the developer in the Google Play Developer API.
*
* Only available on Android.
*/
updatePriority?: number;
/**
* `true` if an immediate update is allowed, otherwise `false`.
*
* Only available on Android.
*/
immediateUpdateAllowed?: boolean;
/**
* `true` if a flexible update is allowed, otherwise `false`.
*
* Only available on Android.
*/
flexibleUpdateAllowed?: boolean;
/**
* Number of days since the Google Play Store app on the user's device has learnt about an available update if an update is available or in progress.
*
* Only available on Android.
*/
clientVersionStalenessDays?: number;
/**
* Flexible in-app update install status.
*
* Only available on Android.
*/
installStatus?: FlexibleUpdateInstallStatus;
/**
* The minimum version of the operating system required for the app to run in iOS.
*
* Only available on iOS.
*/
minimumOsVersion?: string;
}
export declare enum AppUpdateAvailability {
UNKNOWN = 0,
UPDATE_NOT_AVAILABLE = 1,
UPDATE_AVAILABLE = 2,
UPDATE_IN_PROGRESS = 3
}
export interface OpenAppStoreOptions {
/**
* The package name of the app to open in the Play Store.
*
* On **Android**, this is the application ID of your app
* (e.g. `com.example.app`).
* You can find the ID in the `android/app/build.gradle` file.
*
* If not provided, the current app's package name will be used.
*
* Only available on Android.
*
* @since 7.2.0
* @example "com.example.app"
*/
androidPackageName?: string;
/**
* The app ID of the app to open in the App Store.
*
* On **iOS**, this is the Apple ID of your app (e.g. `123456789`).
* You can find the ID in the URL of your app store entry
* (e.g. `https://apps.apple.com/app/id123456789`).
*
* Only available on iOS.
*
* @since 6.1.0
* @example "com.example.app"
* @example "123456789"
*/
appId?: string;
}
export interface FlexibleUpdateState {
/**
* Flexible in-app update install status.
*/
installStatus: FlexibleUpdateInstallStatus;
/**
* Returns the number of bytes downloaded so far.
* `undefined` if the install status is other than `DOWNLOADING`.
*/
bytesDownloaded: number | undefined;
/**
* Returns the total number of bytes to be downloaded for this update.
* `undefined` if the install status is other than `DOWNLOADING`.
*/
totalBytesToDownload: number | undefined;
}
export declare enum FlexibleUpdateInstallStatus {
UNKNOWN = 0,
PENDING = 1,
DOWNLOADING = 2,
INSTALLING = 3,
INSTALLED = 4,
FAILED = 5,
CANCELED = 6,
DOWNLOADED = 11
}
export interface AppUpdateResult {
code: AppUpdateResultCode;
}
export declare enum AppUpdateResultCode {
/**
* The user has accepted the update.
*/
OK = 0,
/**
* The user has denied or cancelled the update.
*/
CANCELED = 1,
/**
* Some other error prevented either the user from providing consent or the update to proceed.
*/
FAILED = 2,
/**
* No update available.
*/
NOT_AVAILABLE = 3,
/**
* Update type not allowed.
*/
NOT_ALLOWED = 4,
/**
* App update info missing.
* You must call `getAppUpdateInfo()` before requesting an update.
*/
INFO_MISSING = 5
}