Skip to content

Commit

Permalink
3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
chemerisuk committed Nov 29, 2022
1 parent aea7d66 commit 76582e5
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 4 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Use variable `ANDROID_PLAY_REVIEW_VERSION` to override dependency version on And

### openStoreScreen

**openStoreScreen**(`packageName?`): `Promise`<`void`\>
**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.
Expand All @@ -62,13 +62,15 @@ is displayed but you can pass a package name string to show another app details.
```ts
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

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cordova-plugin-app-review",
"version": "3.0.1",
"version": "3.1.0",
"description": "Cordova plugin to review app",
"types": "./types/index.d.ts",
"cordova": {
Expand Down
2 changes: 1 addition & 1 deletion plugin.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<plugin xmlns="http://apache.org/cordova/ns/plugins/1.0"
xmlns:android="http://schemas.android.com/apk/res/android"
id="cordova-plugin-app-review"
version="3.0.1">
version="3.1.0">

<name>AppReviewPlugin</name>
<description>Cordova plugin to review app</description>
Expand Down
4 changes: 3 additions & 1 deletion types/AppReview.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,12 @@ export function requestReview(): Promise<void>;
* is displayed but you can pass a package name string to show another app details.
*
* @param {string} [packageName] Package name to show instead of the current app.
* @param {boolean} [writeReview] Open review form if true. Only implemented on iOS.
* @returns {Promise<void>} Callback when operation is completed
*
* @example
* cordova.plugins.AppReview.openStoreScreen();
* cordova.plugins.AppReview.openStoreScreen("com.app.example");
* cordova.plugins.AppReview.openStoreScreen(null, true);
*/
export function openStoreScreen(packageName?: string): Promise<void>;
export function openStoreScreen(packageName?: string, writeReview?: boolean): Promise<void>;

0 comments on commit 76582e5

Please sign in to comment.