1.1.2 • Published 3 years ago

@lucario/cordova-in-app-update v1.1.2

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

cordova-in-app-update

This pluging enabels In app update For cordova.

Supports

  • Flexible update
  • Immidiate update

Install Plugin

cordova add plugin @lucario/cordova-in-app-update

Examples

Check Available Update Information

If you want to prompt user with a prompt about new version information before initiating the update, you can use window.plugins.InAppUpdate.check to retrive the new app version information.

window.plugins.InAppUpdate.check(success, error);

Initiate Update Flow

Flexible updates

Flexible updates provide background download and installation with graceful state monitoring. This UX flow is appropriate when it's acceptable for the user to use the app while downloading the update. For example, you might want to encourage users to try a new feature that's not critical to the core functionality of your app.

Immediate updates

Immediate updates are fullscreen UX flows that require the user to update and restart the app in order to continue using it. This UX flow is best for cases where an update is critical to the core functionality of your app. After a user accepts an immediate update, Google Play handles the update installation and app restart.

window.plugins.InAppUpdate.update(success, error, { updateType: "<IMMEDIATE | FLEXIBLE>" });

Complete Flexible Update

Flexible updates provide background download. Once flexible update completes the download in background, completion of upgrade can be initiated by calling window.plugins.InAppUpdate.completeFlexibleUpdate.

window.plugins.InAppUpdate.update((data) => {
    if(data.installStatus == 2)
        window.plugins.InAppUpdate.completeFlexibleUpdate(success, error);
}, (error) => {}, { updateType: "FLEXIBLE" });

Testing InAppUpdate

Test your app's in-app updates to verify that your integration is working correctly.