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

chore(): new plugin cleanup

Browse Source
This commit is contained in:
Tim Lancina
2016-03-04 15:42:21 -06:00
parent 5ad72de3d3
commit 98fbe6c7ce
6 changed files with 161 additions and 69 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/plugins/apprate.ts
+8 -6
View File
@@ -5,10 +5,10 @@ declare var window;
/**
* The AppRate plugin makes it easy to prompt the user to rate your app, either now, later, or never.
*
* Requires Cordova plugin: cordova-plugin-apprate. For more info, please see the [cordova-plugin-apprate docs](https://github.com/pushandplay/cordova-plugin-apprate).
* Requires Cordova plugin: cordova-plugin-apprate. For more info, please see the [AppRate plugin docs](https://github.com/pushandplay/cordova-plugin-apprate).
*
* ```
* ionic plugin add https://github.com/pushandplay/cordova-plugin-apprate.git
* cordova plugin add https://github.com/pushandplay/cordova-plugin-apprate.git
* ````
*
* @usage
@@ -17,11 +17,11 @@ declare var window;
* AppRate.preferences.storeAppURL.android = 'market://details?id=<package_name>';
* AppRate.preferences.storeAppURL.blackberry = 'appworld://content/[App Id]/';
* AppRate.preferences.storeAppURL.windows8 = 'ms-windows-store:Review?name=<the Package Family Name of the application>';
* AppRate.prompt();
* AppRate.promptForRating();
* ```
*/
@Plugin({
plugin: 'cordova-plugin-apprate',
plugin: 'https://github.com/pushandplay/cordova-plugin-apprate.git',
pluginRef: 'AppRate'
})
export class AppRate {
@@ -45,14 +45,16 @@ export class AppRate {
* @type {{}}
*/
@CordovaProperty
static get preferences(){
static get preferences() {
return window.AppRate.preferences;
}
/**
* Prompts the user for rating
*
* @param {boolean} immediately Show the rating prompt immediately.
*/
@Cordova()
static prompt () : void {};
static promptForRating(immediately: boolean) : void {};
}
src/plugins/appversion.ts
+39 -16
View File
@@ -3,10 +3,10 @@ import {Plugin, Cordova} from './plugin';
/**
* Reads the version of your app from the target build settings.
*
* Requires Cordova plugin: cordova-plugin-appversion. For more info, please see the [cordova-plugin-version docs](ttps://github.com/whiteoctober/cordova-plugin-app-version).
* Requires Cordova plugin: `cordova-plugin-app-version`. For more info, please see the [Cordova App Version docs](ttps://github.com/whiteoctober/cordova-plugin-app-version).
*
* ```
* ionic plugin add https://github.com/whiteoctober/cordova-plugin-app-version.git
* cordova plugin add cordova-plugin-app-version
* ````
*
* @usage
@@ -18,41 +18,64 @@ import {Plugin, Cordova} from './plugin';
* ```
*/
@Plugin({
plugin: 'cordova-plugin-appversion',
plugin: 'cordova-plugin-app-version',
pluginRef: 'cordova.getAppVersion'
})
export class AppVersion {
/**
* Returns the name of the app
* @returns {Promise}
*/
@Cordova
static getAppName () : string {
return;
@Cordova()
static getAppName () {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<any>((res, rej) => {});
}
/**
* Returns the package name of the app
* @returns {Promise}
*/
@Cordova
static getPackageName () : string {
return;
@Cordova()
static getPackageName () {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<any>((res, rej) => {});
}
/**
* Returns the build identifier of the app
* @returns {Promise}
*/
@Cordova
static getVersionCode () : string {
return;
@Cordova()
static getVersionCode () {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<any>((res, rej) => {});
}
/**
* Returns the version of the app
* @returns {Promise}
*/
@Cordova
static getVersionNumber () : string {
return;
@Cordova()
static getVersionNumber() {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<any>((res, rej) => {});
}
}
src/plugins/badge.ts
+94 -38
View File
@@ -3,17 +3,17 @@ import {Plugin, Cordova} from './plugin';
/**
* The essential purpose of badge numbers is to enable an application to inform its users that it has something for them — for example, unread messages — when the application isn’t running in the foreground.
*
* Requires Cordova plugin: cordova-plugin-badge. For more info, please see the [cordova-plugin-badge docs](https://github.com/katzer/cordova-plugin-badge).
* Requires Cordova plugin: cordova-plugin-badge. For more info, please see the [Badge plugin docs](https://github.com/katzer/cordova-plugin-badge).
*
* ```
* ionic plugin add https://github.com/katzer/cordova-plugin-badge.git
* ````
* cordova plugin add cordova-plugin-badge
* ```
*
* @usage
* ```js
* Badge.setBadge(10);
* Badge.increaseBadge();
* Badge.clearBadge();
* Badge.set(10);
* Badge.increase();
* Badge.clear();
* ```
*/
@Plugin({
@@ -23,45 +23,101 @@ import {Plugin, Cordova} from './plugin';
export class Badge {
/**
* Determine permission to set badge notifications
* Clear the badge of the app icon.
*/
@Cordova()
static hasPermission () : boolean {
return;
static clear() {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<boolean>((res, rej) => {});
}
/**
* Set the badge of the app icon.
* @param {number} number The new badge number.
* @returns {Promise}
*/
@Cordova()
static set(number: number) {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<any>((res, rej) => {});
}
/**
* Get the badge of the app icon.
* @returns {Promise}
*/
@Cordova()
static get() {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<any>((res, rej) => {});
}
/**
* Increase the badge number.
* @param {number} count Count to add to the current badge number
* @returns {Promise}
*/
@Cordova()
static increase(number: number) {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<any>((res, rej) => {});
}
/**
* Decrease the badge number.
* @param {number} count Count to subtract from the current badge number
* @returns {Promise}
*/
@Cordova()
static decrease(number: number) {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<any>((res, rej) => {});
}
/**
* Determine if the app has permission to show badges.
*/
@Cordova()
static hasPermission() {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<boolean>((res, rej) => {});
}
/**
* Register permission to set badge notifications
* @returns {Promise<T>}
* @returns {Promise}
*/
@Cordova()
static registerPermission () : Promise<any> {
return new Promise((res,rej) => {});
static registerPermission() {
// This Promise is replaced by one from the @Cordova decorator that wraps
// the plugin's callbacks. We provide a dummy one here so TypeScript
// knows that the correct return type is Promise, because there's no way
// for it to know the return type from a decorator.
// See https://github.com/Microsoft/TypeScript/issues/4881
return new Promise<any>((res, rej) => {});
}
/**
* Sets the badge number
* @param number
*/
@Cordova()
static setBadge (number : number) : void {}
/**
* Clears the badge number
*/
@Cordova()
static clearBadge () : void {}
/**
* Increases the badge number
*/
@Cordova()
static increaseBadge () : void {}
/**
* Decreases the badge number
*/
@Cordova()
static decreaseBadge () : void {}
}
src/plugins/clipboard.ts
+3 -2
View File
@@ -4,9 +4,10 @@ import {Plugin, Cordova} from './plugin';
* Clipboard management plugin for Cordova that supports iOS, Android, and Windows Phone 8.
*
* Requires Cordova plugin: https://github.com/VersoSolutions/CordovaClipboard
* For more info, please see the [Clipboard plugin docs](https://github.com/VersoSolutions/CordovaClipboard.git).
*
* ```
* ionic plugin add https://github.com/VersoSolutions/CordovaClipboard.git
* cordova plugin add https://github.com/VersoSolutions/CordovaClipboard.git
* ```
*
* @usage
@@ -25,7 +26,7 @@ import {Plugin, Cordova} from './plugin';
* ```
*/
@Plugin({
plugin: 'com.verso.cordova.clipboard',
plugin: 'https://github.com/VersoSolutions/CordovaClipboard.git',
pluginRef: 'cordova.plugins.clipboard'
})
export class Clipboard {
src/plugins/datepicker.ts
+1 -1
View File
@@ -29,7 +29,7 @@ export class DatePicker {
* @param options
* @returns {Promise<Date>} Returns a promise that resolves with the picked date and/or time, or rejects with an error.
*/
@Cordova
@Cordova()
static show(options? : {
mode : string,
date : string,