diff --git a/src/plugins/appavailability.ts b/src/plugins/appavailability.ts index 3cc3d027..11283d90 100644 --- a/src/plugins/appavailability.ts +++ b/src/plugins/appavailability.ts @@ -37,7 +37,7 @@ export class AppAvailability { /** * Checks if an app is available on device - * @param app Package name on android, or URI scheme on iOS + * @param {string} app Package name on android, or URI scheme on iOS * @returns {Promise} */ @Cordova() diff --git a/src/plugins/apprate.ts b/src/plugins/apprate.ts index 96bc4add..fcdbfb08 100644 --- a/src/plugins/apprate.ts +++ b/src/plugins/apprate.ts @@ -20,6 +20,27 @@ declare var window; * AppRate.preferences.storeAppURL.windows8 = 'ms-windows-store:Review?name='; * AppRate.promptForRating(); * ``` + * + * @advanced + * + * Rating dialog preferences + * + * | Option | Type | Default | Description | + * |------------------------------|------------|---------|----------------------------------------------------------------------------------------| + * | useLanguage | `String` | null | custom BCP 47 language tag | + * | displayAppName | `String` | '' | custom application title | + * | promptAgainForEachNewVersion | `Boolean` | true | show dialog again when application version will be updated | + * | usesUntilPrompt | `Integer` | 3 | count of runs of application before dialog will be displayed | + * | openStoreInApp | `Boolean` | false | leave app or no when application page opened in app store (now supported only for iOS) | + * | useCustomRateDialog | `Boolean` | false | use custom view for rate dialog | + * | callbacks.onButtonClicked | `Function` | null | call back function. called when user clicked on rate-dialog buttons | + * | callbacks.onRateDialogShow | `Function` | null | call back function. called when rate-dialog showing | + * | storeAppURL.ios | `String` | null | application id in AppStore | + * | storeAppURL.android | `String` | null | application URL in GooglePlay | + * | storeAppURL.blackberry | `String` | null | application URL in AppWorld | + * | storeAppURL.windows8 | `String` | null | application URL in WindowsStore | + * | customLocale | `Object` | null | custom locale object | + */ @Plugin({ plugin: 'cordova-plugin-apprate', @@ -30,31 +51,14 @@ declare var window; export class AppRate { /** - * Rating dialog preferences - * - * | Option | Type | Default | Description | - * |------------------------------|------------|---------|----------------------------------------------------------------------------------------| - * | useLanguage | `String` | null | custom BCP 47 language tag | - * | displayAppName | `String` | '' | custom application title | - * | promptAgainForEachNewVersion | `Boolean` | true | show dialog again when application version will be updated | - * | usesUntilPrompt | `Integer` | 3 | count of runs of application before dialog will be displayed | - * | openStoreInApp | `Boolean` | false | leave app or no when application page opened in app store (now supported only for iOS) | - * | useCustomRateDialog | `Boolean` | false | use custom view for rate dialog | - * | callbacks.onButtonClicked | `Function` | null | call back function. called when user clicked on rate-dialog buttons | - * | callbacks.onRateDialogShow | `Function` | null | call back function. called when rate-dialog showing | - * | storeAppURL.ios | `String` | null | application id in AppStore | - * | storeAppURL.android | `String` | null | application URL in GooglePlay | - * | storeAppURL.blackberry | `String` | null | application URL in AppWorld | - * | storeAppURL.windows8 | `String` | null | application URL in WindowsStore | - * | customLocale | `Object` | null | custom locale object | - * @type {{}} + * Configure various settings for the Rating View. + * See table below for options */ @CordovaProperty static get preferences() { return window.AppRate.preferences; } /** * Prompts the user for rating - * * @param {boolean} immediately Show the rating prompt immediately. */ @Cordova()