3
0
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-03-17 17:21:08 +08:00

docs(localNotification): update docs

This commit is contained in:
mhartington 2016-09-07 12:44:35 -04:00
parent d8baf3a814
commit 410b3d261f

@ -72,12 +72,14 @@ export class LocalNotifications {
/** /**
* Clears single or multiple notifications * Clears single or multiple notifications
* @param notificationId A single notification id, or an array of notification ids. * @param notificationId A single notification id, or an array of notification ids.
* @returns {Promise} Returns a promise when the notification had been cleared
*/ */
@Cordova() @Cordova()
static clear(notificationId: any): Promise<any> { return; } static clear(notificationId: any): Promise<any> { return; }
/** /**
* Clears all notifications * Clears all notifications
* @returns {Promise} Returns a promise when all notifications have cleared
*/ */
@Cordova({ @Cordova({
successIndex: 0, successIndex: 0,
@ -88,12 +90,14 @@ export class LocalNotifications {
/** /**
* Cancels single or multiple notifications * Cancels single or multiple notifications
* @param notificationId A single notification id, or an array of notification ids. * @param notificationId A single notification id, or an array of notification ids.
* @returns {Promise} Returns a promise when the notification is canceled
*/ */
@Cordova() @Cordova()
static cancel(notificationId: any): Promise<any> { return; } static cancel(notificationId: any): Promise<any> { return; }
/** /**
* Cancels all notifications * Cancels all notifications
* @returns {Promise} Returns a promise when all notifications are canceled
*/ */
@Cordova({ @Cordova({
successIndex: 0, successIndex: 0,
@ -104,6 +108,7 @@ export class LocalNotifications {
/** /**
* Checks presence of a notification * Checks presence of a notification
* @param notificationId * @param notificationId
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static isPresent(notificationId: number): Promise<boolean> { return; } static isPresent(notificationId: number): Promise<boolean> { return; }
@ -111,6 +116,7 @@ export class LocalNotifications {
/** /**
* Checks is a notification is scheduled * Checks is a notification is scheduled
* @param notificationId * @param notificationId
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static isScheduled(notificationId: number): Promise<boolean> { return; } static isScheduled(notificationId: number): Promise<boolean> { return; }
@ -118,24 +124,28 @@ export class LocalNotifications {
/** /**
* Checks if a notification is triggered * Checks if a notification is triggered
* @param notificationId * @param notificationId
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static isTriggered(notificationId: number): Promise<boolean> { return; } static isTriggered(notificationId: number): Promise<boolean> { return; }
/** /**
* Get all the notification ids * Get all the notification ids
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static getAllIds(): Promise<Array<number>> { return; } static getAllIds(): Promise<Array<number>> { return; }
/** /**
* Get the ids of triggered notifications * Get the ids of triggered notifications
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static getTriggeredIds(): Promise<Array<number>> { return; } static getTriggeredIds(): Promise<Array<number>> { return; }
/** /**
* Get the ids of scheduled notifications * Get the ids of scheduled notifications
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static getScheduledIds(): Promise<Array<number>> { return; } static getScheduledIds(): Promise<Array<number>> { return; }
@ -143,6 +153,7 @@ export class LocalNotifications {
/** /**
* Get a notification object * Get a notification object
* @param notificationId The id of the notification to get * @param notificationId The id of the notification to get
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static get(notificationId: any): Promise<Notification> { return; } static get(notificationId: any): Promise<Notification> { return; }
@ -150,6 +161,7 @@ export class LocalNotifications {
/** /**
* Get a scheduled notification object * Get a scheduled notification object
* @param notificationId The id of the notification to get * @param notificationId The id of the notification to get
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static getScheduled(notificationId: any): Promise<Notification> { return; } static getScheduled(notificationId: any): Promise<Notification> { return; }
@ -157,24 +169,28 @@ export class LocalNotifications {
/** /**
* Get a triggered notification object * Get a triggered notification object
* @param notificationId The id of the notification to get * @param notificationId The id of the notification to get
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static getTriggered(notificationId: any): Promise<Notification> { return; } static getTriggered(notificationId: any): Promise<Notification> { return; }
/** /**
* Get all notification objects * Get all notification objects
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static getAll(): Promise<Array<Notification>> { return; } static getAll(): Promise<Array<Notification>> { return; }
/** /**
* Get all scheduled notification objects * Get all scheduled notification objects
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static getAllScheduled(): Promise<Array<Notification>> { return; } static getAllScheduled(): Promise<Array<Notification>> { return; }
/** /**
* Get all triggered notification objects * Get all triggered notification objects
* @returns {Promise} Returns a promise
*/ */
@Cordova() @Cordova()
static getAllTriggered(): Promise<Array<Notification>> { return; } static getAllTriggered(): Promise<Array<Notification>> { return; }