README.md

cordova-plugin-app-review

Index

• Supported platforms
• Installation
• Functions

Supported platforms

• iOS

  • Supported iOS 10.3+ only
  • iOS limits the frequency of displaying The Rating dialog

• Android

  • After the account on the device has downloaded the app at least once from the internal test track and is part of the testers list, you can deploy new versions of the app via cordova cli and call requestReview in debug mode
  • In-app reviews require your app to be published in Play Store
  • Google Play enforces a quota on how often a user can be shown the review dialog

Installation

$ cordova plugin add cordova-plugin-app-review

Use variable ANDROID_PLAY_REVIEW_VERSION to override dependency version on Android:

$ cordova plugin add cordova-plugin-app-review \
    --variable ANDROID_PLAY_REVIEW_VERSION='2.0.+'

Functions

openStoreScreen

openStoreScreen(packageName?, writeReview?): Promise<void>

Launches App/Play store page with a review form. By default current app screen is displayed but you can pass a package name string to show another app details.

Example

cordova.plugins.AppReview.openStoreScreen();
cordova.plugins.AppReview.openStoreScreen("com.app.example");
cordova.plugins.AppReview.openStoreScreen(null, true);

Parameters

Name	Type	Description
packageName?	string	Package name to show instead of the current app.
writeReview?	boolean	Open review form if true. Only implemented on iOS.

Returns

Promise<void>

Callback when operation is completed

---

requestReview

requestReview(): Promise<void>

Launches in-app review dialog.

Example

cordova.plugins.AppReview.requestReview();
// request dialog and provide fallback
cordova.plugins.AppReview.requestReview().catch(function() {
    return cordova.plugins.AppReview.openStoreScreen();
});

Returns

Promise<void>

Callback when operation is completed