-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(app-review): add plugin (#4348)
- Loading branch information
Showing
1 changed file
with
55 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
import { Injectable } from '@angular/core'; | ||
import { Plugin, Cordova, AwesomeCordovaNativePlugin } from '@awesome-cordova-plugins/core'; | ||
|
||
/** | ||
* @name App Review | ||
* @description | ||
* Cordova plugin to review app | ||
* | ||
* @usage | ||
* ```typescript | ||
* import { AppReview } from '@awesome-cordova-plugins/app-review/ngx'; | ||
* | ||
* | ||
* constructor(private appReview: AppReview) { } | ||
* | ||
* ... | ||
* | ||
* | ||
* this.appReview.requestReview() | ||
* .then(() => console.log('Success')) | ||
* .catch((error: any) => console.error(error)); | ||
* | ||
* ``` | ||
*/ | ||
@Plugin({ | ||
pluginName: 'AppReview', | ||
plugin: 'cordova-plugin-app-review', | ||
pluginRef: 'cordova.plugins.AppReview', | ||
repo: 'https://github.com/chemerisuk/cordova-plugin-app-review', | ||
platforms: ['Android', 'iOS'], | ||
}) | ||
@Injectable() | ||
export class AppReview extends AwesomeCordovaNativePlugin { | ||
/** | ||
* Launches in-app review dialog. | ||
* | ||
* @returns {Promise<void>} Callback when operation is completed | ||
*/ | ||
@Cordova({ sync: true }) | ||
requestReview(): Promise<void> { | ||
return; | ||
} | ||
|
||
/** | ||
* 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. | ||
* | ||
* @param {string} [packageName] Package name to show instead of the current app. | ||
* @returns {Promise<void>} Callback when operation is completed | ||
*/ | ||
@Cordova({ sync: true }) | ||
openStoreScreen(packageName?: string): Promise<void> { | ||
return; | ||
} | ||
} |