Merge pull request DefinitelyTyped#6917 from fredgalvao/phonegap-plugin-push-1.4.4

Phonegap plugin push 1.4.4

Author: vvakame

phonegap-plugin-push/phonegap-plugin-push-tests.ts

@@ -1,26 +1,39 @@
 /// <reference path="phonegap-plugin-push.d.ts" />
 
 function test() {
-	var options:PhonegapPluginPush.InitOptions = {
+	let options: PhonegapPluginPush.InitOptions = {
 		android: {
 			senderID: '123456789',
 			icon: 'phonegap',
 			iconColor: 'blue',
 			sound: true,
 			vibrate: true,
-			clearNotifications: false
+			clearNotifications: false,
+			forceShow: true
 		},
 		ios: {
 			badge: true,
 			sound: true,
-			alert: true
+			alert: true,
+			clearBadge: true
 		},
 		windows: {}
 	};
-	var push:PhonegapPluginPush.PushNotification;
+
+	let iosStringOptions = {
+		badge: 'true',
+		sound: 'true',
+		alert: 'true',
+		clearBadge: 'true'
+	};
+
+	options.ios = iosStringOptions;
+
+	let push: PhonegapPluginPush.PushNotification;
 
 	/*from constructor*/
 	push = new PushNotification(options);
+	push = new window.PushNotification(options);
 
 	push.unregister(() => {
 		console.log('did unregister');
@@ -30,12 +43,13 @@ function test() {
 
 	/*from init*/
 	push = PushNotification.init(options);
+	push = window.PushNotification.init(options);
 
-	push.on('registration', (data:PhonegapPluginPush.RegistrationEventResponse) => {
+	let registrationHandler = (data: PhonegapPluginPush.RegistrationEventResponse) => {
 		console.log(data.registrationId);
-	});
+	};
 
-	push.on('notification', (data:PhonegapPluginPush.NotificationEventResponse) => {
+	let notificationHandler = (data: PhonegapPluginPush.NotificationEventResponse) => {
 		console.log(data.message);
 		console.log(data.title);
 		console.log(data.count);
@@ -45,15 +59,35 @@ function test() {
 		/*the rest of the additional fields are not 'canon'*/
 		console.log(data.additionalData);
 		console.log(data.additionalData.foreground);
-	});
 
-	push.on('error', (e:Error) => {
+		push.finish(() => {
+			console.log('did finish');
+		}, () => {
+			console.log('did not finish');
+		});
+	};
+
+	let errorHandler = (e: Error) => {
 		console.log(e.message);
-	});
+	};
+
+	push.on('registration', registrationHandler);
+	push.on('notification', notificationHandler);
+	push.on('error', errorHandler);
+
+	push.off('registration', registrationHandler);
+	push.off('notification', notificationHandler);
+	push.off('error', errorHandler);
 
 	push.setApplicationIconBadgeNumber(() => {
 		console.log('did setApplicationIconBadgeNumber');
 	}, () => {
 		console.log('did not setApplicationIconBadgeNumber');
 	}, 1);
+
+	push.getApplicationIconBadgeNumber((count: number) => {
+		console.log('did getApplicationIconBadgeNumber', count);
+	}, () => {
+		console.log('did not getApplicationIconBadgeNumber');
+	});
 }

phonegap-plugin-push/phonegap-plugin-push.d.ts

@@ -12,43 +12,77 @@ declare module PhonegapPluginPush {
 		 * @param event
 		 * @param callback
 		 */
-		on(event:"registration", callback:(response:RegistrationEventResponse)=>any):void
+		on(event: "registration", callback: (response: RegistrationEventResponse) => any): void
 		/**
 		 * The event notification will be triggered each time a push notification is received by a 3rd party push service on the device.
 		 * @param event
 		 * @param callback
 		 */
-		on(event:"notification", callback:(response:NotificationEventResponse)=>any):void
+		on(event: "notification", callback: (response: NotificationEventResponse) => any): void
 		/**
 		 * The event error will trigger when an internal error occurs and the cache is aborted.
 		 * @param event
 		 * @param callback
 		 */
-		on(event:"error", callback:(response:Error)=>any):void
-		/*Generic one, needed for the overloads*/
+		on(event: "error", callback: (response: Error) => any): void
 		/**
 		 *
 		 * @param event Name of the event to listen to. See below(above) for all the event names.
 		 * @param callback is called when the event is triggered.
+		 * @param event
+		 * @param callback
+		 */
+		on(event: string, callback: (response: EventResponse) => any): void
+
+		off(event: "registration", callback: (response: RegistrationEventResponse) => any): void
+		off(event: "notification", callback: (response: NotificationEventResponse) => any): void
+		off(event: "error", callback: (response: Error) => any): void
+		/**
+		 * As stated in the example, you will have to store your event handler if you are planning to remove it.
+		 * @param event Name of the event type. The possible event names are the same as for the push.on function.
+		 * @param callback handle to the function to get removed.
+		 * @param event
+		 * @param callback
 		 */
-		on(event:string, callback:(response:EventResponse)=>any):void
+		off(event: string, callback: (response: EventResponse) => any): void
 
 		/**
 		 * The unregister method is used when the application no longer wants to receive push notifications.
+		 * Beware that this cleans up all event handlers previously registered,
+		 * so you will need to re-register them if you want them to function again without an application reload.
 		 * @param successHandler
 		 * @param errorHandler
 		 */
-		unregister(successHandler:()=>any, errorHandler?:()=>any):void
+		unregister(successHandler: () => any, errorHandler?: () => any): void
+
 		/*TODO according to js source code, "errorHandler" is optional, but is "count" also optional? I can't read objetive-C code (can anyone at all? I wonder...)*/
 		/**
 		 * 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. Passing 0 will clear the badge. Each notification event contains a data.count value which can be used to set the badge to correct number.
+		 * The count is an integer indicating what number should show up in the badge.
+		 * Passing 0 will clear the badge.
+		 * Each notification event contains a data.count value which can be used to set the badge to correct number.
 		 * @param successHandler
 		 * @param errorHandler
 		 * @param count
 		 */
-		setApplicationIconBadgeNumber(successHandler:()=>any, errorHandler:()=>any, count:number):void
+		setApplicationIconBadgeNumber(successHandler: () => any, errorHandler: () => any, count: number): void
+		/**
+		 * 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
+		 * @param errorHandler
+		 */
+		getApplicationIconBadgeNumber(successHandler: (count: number) => any, errorHandler: () => any): void
+		
+		/**
+		 * 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
+		 * @param errorHandler
+		 */
+		finish(successHandler: () => any, errorHandler: () => any): void
 	}
 
 	/**
@@ -62,46 +96,66 @@ declare module PhonegapPluginPush {
 			/**
 			 * Maps to the project number in the Google Developer Console.
 			 */
-			senderID:string
+			senderID: string
 			/**
-			 * The name of a drawable resource to use as the small-icon.
+			 * The name of a drawable resource to use as the small-icon. The name should not include the extension.
 			 */
-			icon?:string
+			icon?: string
 			/**
-			 * Sets the background color of the small icon.
+			 * Sets the background color of the small icon on Android 5.0 and greater.
 			 * Supported Formats - http://developer.android.com/reference/android/graphics/Color.html#parseColor(java.lang.String)
 			 */
-			iconColor?:string
+			iconColor?: string
 			/**
 			 * If true it plays the sound specified in the push data or the default system sound. Default is true.
 			 */
-			sound?:boolean
+			sound?: boolean
 			/**
 			 * If true the device vibrates on receipt of notification. Default is true.
 			 */
-			vibrate?:boolean
+			vibrate?: boolean
 			/**
 			 * If true the app clears all pending notifications when it is closed. Default is true.
 			 */
-			clearNotifications?:boolean
+			clearNotifications?: boolean
+			/**
+			 * If true will always show a notification, even when the app is on the foreground. Default is false.
+			 */
+			forceShow?: boolean
 		}
 
 		/**
 		 * iOS specific initialization options.
 		 */
 		ios?: {
 			/**
-			 * If true the device shows an alert on receipt of notification. Default is false.
+			 * If true|"true" the device sets the badge number on receipt of notification.
+			 * Default is false|"false".
+			 * Note: the value you set this option to the first time you call the init method will be how the application always acts.
+			 * Once this is set programmatically in the init method it can only be changed manually by the user in Settings>Notifications>App Name.
+			 * This is normal iOS behaviour.
 			 */
-			badge?: boolean
+			badge?: boolean | string
 			/**
-			 * If true the device sets the badge number on receipt of notification. Default is false.
+			 * If true|"true" the device plays a sound on receipt of notification.
+			 * Default is false|"false".
+			 * Note: the value you set this option to the first time you call the init method will be how the application always acts.
+			 * Once this is set programmatically in the init method it can only be changed manually by the user in Settings>Notifications>App Name.
+			 * This is normal iOS behaviour.
 			 */
-			sound?: boolean
+			sound?: boolean | string
+			/**
+			 * If true|"true" the device shows an alert on receipt of notification.
+			 * Default is false|"false".
+			 * Note: the value you set this option to the first time you call the init method will be how the application always acts.
+			 * Once this is set programmatically in the init method it can only be changed manually by the user in Settings>Notifications>App Name.
+			 * This is normal iOS behaviour.
+			 */
+			alert?: boolean | string
 			/**
-			 * If true the device plays a sound on receipt of notification. Default is false.
+			 * If true|"true" the badge will be cleared on app startup. Default is false|"false".
 			 */
-			alert?: boolean
+			clearBadge?: boolean | string
 		}
 
 		/**
@@ -116,63 +170,64 @@ declare module PhonegapPluginPush {
 		/**
 		 * The registration ID provided by the 3rd party remote push service.
 		 */
-		registrationId:string
+		registrationId: string
 	}
 
 	interface NotificationEventResponse {
 		/**
 		 * The text of the push message sent from the 3rd party service.
 		 */
-		message:string
+		message: string
 		/**
 		 * The optional title of the push message sent from the 3rd party service.
 		 */
-		title?:string
+		title?: string
 		/**
 		 * The number of messages to be displayed in the badge iOS or message count in the notification shade in Android.
 		 * For windows, it represents the value in the badge notification which could be a number or a status glyph.
 		 */
-		count:string
+		count: string
 		/**
 		 * The name of the sound file to be played upon receipt of the notification.
 		 */
-		sound:string
+		sound: string
 		/**
 		 * The path of the image file to be displayed in the notification.
 		 */
-		image:string
+		image: string
 		/**
 		 * An optional collection of data sent by the 3rd party push service that does not fit in the above properties.
 		 */
 		additionalData: NotificationEventAdditionalData
 	}
 
+	/**
+	 * TODO: document all possible properties (I only got the android ones)
+	 *
+	 * Loosened up with a dictionary notation, but all non-defined properties need to use (map['prop']) notation
+	 *
+	 * Ideally the developer would overload (merged declaration) this or create a new interface that would extend this one
+	 * so that he could specify any custom code without having to use array notation (map['prop']) for all of them.
+	 */
 	interface NotificationEventAdditionalData {
-		/**
-		 * TODO: document all possible properties (I only got the android ones)
-		 *
-		 * Loosened up with a dictionary notation, but all non-defined properties need to use (map['prop']) notation
-		 *
-		 * Ideally the developer would overload (merged declaration) this or create a new interface that would extend this one
-		 * so that he could specify any custom code without having to use array notation (map['prop']) for all of them.
-		 */
 		[name: string]: any
+
 		/**
 		 * Whether the notification was received while the app was in the foreground
 		 */
-		foreground?:boolean
-		collapse_key?:string
-		from?:string
-		notId?:string
+		foreground?: boolean
+		collapse_key?: string
+		from?: string
+		notId?: string
 	}
 
 	interface PushNotificationStatic {
-		init(options:InitOptions):PushNotification
-		new(options:InitOptions):PushNotification
+		init(options: InitOptions): PushNotification
+		new (options: InitOptions): PushNotification
 	}
 }
 
 interface Window {
-	PushNotification:PhonegapPluginPush.PushNotificationStatic
+	PushNotification: PhonegapPluginPush.PushNotificationStatic
 }
-declare var PushNotification:PhonegapPluginPush.PushNotificationStatic;
+declare var PushNotification: PhonegapPluginPush.PushNotificationStatic;