github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2024-10-07 00:18:08 +08:00
Code Issues Projects Releases Wiki Activity

copy edits from @kgindervogel

Browse Source
This commit is contained in:
perry 2016-05-10 17:49:21 -05:00
parent 3cdf50bf3b
commit df1cee1fc6
5 changed files with 28 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
src/plugins/apprate.ts
View File

@ -32,19 +32,21 @@ export class AppRate {
/**
* Rating dialog preferences
*
* 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
* | 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 {{}}
*/
@CordovaProperty

5
src/plugins/diagnostic.ts
View File

@ -3,6 +3,7 @@ import {Plugin, Cordova} from './plugin';
@Plugin({
plugin: 'cordova.plugins.diagnostic',
pluginRef: 'cordova.plugins.diagnostic'
repo: 'https://github.com/floatinghotpot/cordova-plugin-admob'
})
export class Diagnostic {
/**
@ -20,7 +21,7 @@ export class Diagnostic {
/**
* Checks if Wifi is connected/enabled. On iOS this returns true if the device is connected to a network by WiFi. On Android and Windows 10 Mobile this returns true if the WiFi setting is set to enabled.
* On Android this requires permission <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
* On Android this requires permission. `<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />`
*/
@Cordova()
static isWifiEnabled() {
@ -185,4 +186,4 @@ export class Diagnostic {
}
}

6
src/plugins/file.ts
View File

@ -118,7 +118,7 @@ export class File {
}
/**
* Remove a directory at a given path
* Remove a directory at a given path.
*
* @param {string} path The path to the directory
* @param {string} dirName The directory name
@ -158,7 +158,7 @@ export class File {
}
/**
* Move a directory to a given path
* Move a directory to a given path.
*
* @param {string} path The source path to the directory
* @param {string} dirName The source directory name
@ -252,7 +252,7 @@ export class File {
}
/**
* List files and directory from a given path
* List files and directory from a given path.
*
* @param {string} path Base FileSystem. Please refer to the iOS and Android filesystems above
* @param {string} dirName Name of directory

10
src/plugins/flashlight.ts
View File

@ -23,8 +23,8 @@ export class Flashlight {
/**
* Checks if the flash light is available
* @returns {Promise<boolean>} Returns a promise that resolves with a boolean stating if the flash light is available.
* Checks if the flashlight is available
* @returns {Promise<boolean>} Returns a promise that resolves with a boolean stating if the flashlight is available.
*/
@Cordova()
static available(): Promise<boolean> { return; }
@ -37,7 +37,7 @@ export class Flashlight {
static switchOn(): Promise<boolean> { return; }
/**
* Switches the flash light off
* Switches the flashlight off
* @returns {Promise<boolean>}
*/
@Cordova()
@ -52,7 +52,7 @@ export class Flashlight {
/**
* Checks if the flash light is turned on.
* Checks if the flashlight is turned on.
* Returns a boolean
*/
@Cordova({
@ -60,4 +60,4 @@ export class Flashlight {
})
static isSwitchedOn(): boolean { return; }
}
}

4
src/plugins/keyboard.ts
View File

@ -37,7 +37,7 @@ export class Keyboard {
static show(): void {}
/**
* Close the keyboard if open
* Close the keyboard if open.
*/
@Cordova({
sync: true,
@ -75,4 +75,4 @@ export class Keyboard {
})
static onKeyboardHide(): Observable<any> {return; }
}
}