Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 3.29 KB

README.md

File metadata and controls

103 lines (68 loc) · 3.29 KB

cordova-plugin-app-review

NPM version NPM downloads PayPal donate Twitter

Index

Supported platforms

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