mirror of
https://github.com/danielsogl/awesome-cordova-plugins.git
synced 2026-04-13 00:00:10 +08:00
Carl Poole
111 lines
3.0 KiB
TypeScript
111 lines
3.0 KiB
TypeScript
import { Injectable } from '@angular/core';
|
||
import { Cordova, IonicNativePlugin, Plugin } from '@ionic-native/core';
|
||
|
||
/**
|
||
* @name Badge
|
||
* @premier badge
|
||
* @description
|
||
* 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 [Badge plugin docs](https://github.com/katzer/cordova-plugin-badge).
|
||
*
|
||
* Android Note: Badges have historically only been a feature implemented by third party launchers and not visible unless one of those launchers was being used (E.G. Samsung or Nova Launcher) and if enabled by the user. As of Android 8 (Oreo), [notification badges](https://developer.android.com/training/notify-user/badges) were introduced officially to reflect unread notifications. This plugin is unlikely to work as expected on devices running Android 8 or newer. Please see the [local notifications plugin docs](https://github.com/katzer/cordova-plugin-local-notifications) for more information on badge use with notifications.
|
||
*
|
||
* @usage
|
||
* ```typescript
|
||
* import { Badge } from '@ionic-native/badge/ngx';
|
||
*
|
||
* constructor(private badge: Badge) { }
|
||
*
|
||
* ...
|
||
*
|
||
* this.badge.set(10);
|
||
* this.badge.increase(1);
|
||
* this.badge.clear();
|
||
* ```
|
||
*/
|
||
@Plugin({
|
||
pluginName: 'Badge',
|
||
plugin: 'cordova-plugin-badge',
|
||
pluginRef: 'cordova.plugins.notification.badge',
|
||
repo: 'https://github.com/katzer/cordova-plugin-badge',
|
||
platforms: ['Android', 'Browser', 'iOS', 'Windows'],
|
||
})
|
||
@Injectable()
|
||
export class Badge extends IonicNativePlugin {
|
||
/**
|
||
* Clear the badge of the app icon.
|
||
* @returns {Promise<boolean>}
|
||
*/
|
||
@Cordova()
|
||
clear(): Promise<boolean> {
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* Set the badge of the app icon.
|
||
* @param {number} badgeNumber The new badge number.
|
||
* @returns {Promise<any>}
|
||
*/
|
||
@Cordova()
|
||
set(badgeNumber: number): Promise<any> {
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* Get the badge of the app icon.
|
||
* @returns {Promise<any>}
|
||
*/
|
||
@Cordova()
|
||
get(): Promise<any> {
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* Increase the badge number.
|
||
* @param {number} increaseBy Count to add to the current badge number
|
||
* @returns {Promise<any>}
|
||
*/
|
||
@Cordova()
|
||
increase(increaseBy: number): Promise<any> {
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* Decrease the badge number.
|
||
* @param {number} decreaseBy Count to subtract from the current badge number
|
||
* @returns {Promise<any>}
|
||
*/
|
||
@Cordova()
|
||
decrease(decreaseBy: number): Promise<any> {
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* Check support to show badges.
|
||
* @returns {Promise<any>}
|
||
*/
|
||
@Cordova()
|
||
isSupported(): Promise<any> {
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* Determine if the app has permission to show badges.
|
||
* @returns {Promise<any>}
|
||
*/
|
||
@Cordova()
|
||
hasPermission(): Promise<any> {
|
||
return;
|
||
}
|
||
|
||
/**
|
||
* Register permission to set badge notifications
|
||
* @returns {Promise<any>}
|
||
*/
|
||
@Cordova()
|
||
requestPermission(): Promise<any> {
|
||
return;
|
||
}
|
||
}
|