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