diff --git a/src/plugins/push.ts b/src/plugins/push.ts index a947de12db..ae1c24507d 100644 --- a/src/plugins/push.ts +++ b/src/plugins/push.ts @@ -110,6 +110,25 @@ export interface PushNotification { unregister(successHandler: () => any, errorHandler?: () => any): void; /** + * The subscribe method is used when the application wants to subscribe a new topic to receive push notifications. + * @param {string} topic: Topic to subscribe to. + * @param successHandler + * @param errorHandler + */ + subscribe(topic: string, successHandler: () => any, errorHandler?: () => any): void; + + /** + * The unsubscribe method is used when the application no longer wants to receive push notifications + * from a specific topic but continue to receive other push messages. + * @param {string} topic: Topic to subscribe to. + * @param successHandler + * @param errorHandler + */ + unsubscribe(topic: string, successHandler: () => any, errorHandler?: () => any): void; + + /** + * iOS & android only + * * Set the badge count visible when the app is not running * * The count is an integer indicating what number should show up in the badge. @@ -121,6 +140,8 @@ export interface PushNotification { */ setApplicationIconBadgeNumber(successHandler: () => any, errorHandler: () => any, count?: number): void; /** + * iOS only + * * Get the current badge count visible when the app is not running * successHandler gets called with an integer which is the current badge count * @param successHandler @@ -130,6 +151,7 @@ export interface PushNotification { /** * iOS only + * * Tells the OS that you are done processing a background push notification. * successHandler gets called when background push processing is successfully completed. * @param successHandler @@ -137,6 +159,16 @@ export interface PushNotification { * @param id */ finish(successHandler: () => any, errorHandler: () => any, id?: string): void; + + /** + * iOS & android only + * + * Tells the OS to clear all notifications from the Notification Center. + * successHandler gets called when the api successfully clears the notifications + * @param successHandler + * @param errorHandler + */ + clearAllNotifications(successHandler: () => any, errorHandler: () => any): void; } export interface IOSPushOptions {