feat(): add badge plugin

This commit is contained in:
Ibrahim Hadeed
2016-02-17 04:36:38 -05:00
parent 44d6d5c021
commit 3088df441b
2 changed files with 434 additions and 0 deletions
+68
View File
@@ -0,0 +1,68 @@
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 isnt 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).
*
* ```
* ionic plugin add https://github.com/katzer/cordova-plugin-badge.git
* ````
*
* @usage
* ```js
* Badge.setBadge(10);
* Badge.increaseBadge();
* Badge.clearBadge();
* ```
*/
@Plugin({
name: 'Badge',
plugin: 'cordova-plugin-badge',
pluginRef: 'cordova.plugins.notification.badge'
})
export class Badge {
/**
* Determine permission to set badge notifications
*/
@Cordova()
static hasPermission () : boolean {
return;
}
/**
* Register permission to set badge notifications
* @returns {Promise<T>}
*/
@Cordova()
static registerPermission () : Promise<any> {
return new Promise((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 {}
}