You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
An object describing relevant specific options for all target platforms.
All available option attributes are described bellow. Currently, there are no Windows specific options.
Android
Attribute
Type
Default
Description
android.senderID
string
Maps to the project number in the Google Developer Console.
android.icon
string
Optional. The name of a drawable resource to use as the small-icon. The name should not include the extension.
android.iconColor
string
Optional. Sets the background color of the small icon on Android 5.0 and greater. Supported Formats
android.sound
boolean
true
Optional. If true it plays the sound specified in the push data or the default system sound.
android.vibrate
boolean
true
Optional. If true the device vibrates on receipt of notification.
android.clearNotifications
boolean
true
Optional. If true the app clears all pending notifications when it is closed.
android.forceShow
boolean
false
Optional. If true will always show a notification, even when the app is on the foreground.
iOS
All iOS boolean options can also be specified as string
Attribute
Type
Default
Description
ios.alert
boolean
false
Optional. If true the device shows an alert on receipt of notification. 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.
ios.badge
boolean
false
Optional. If true the device sets the badge number on receipt of notification. 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.
ios.sound
boolean
false
Optional. If true the device plays a sound on receipt of notification. 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.
ios.clearBadge
boolean
false
Optional. If true the badge will be cleared on app startup.
The event notification will be triggered each time a push notification is received by a 3rd party push service on the device.
Callback parameters
Parameter
Type
Description
data.message
string
The text of the push message sent from the 3rd party service.
data.title
string
The optional title of the push message sent from the 3rd party service.
data.count
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.
data.sound
string
The name of the sound file to be played upon receipt of the notification.
data.image
string
The path of the image file to be displayed in the notification.
data.additionalData
Object
An optional collection of data sent by the 3rd party push service that does not fit in the above properties.
data.additionalData.foreground
boolean
Whether the notification was received while the app was in the foreground
Removes a previously registered callback for an event.
Parameters
Parameter
Type
Default
Description
event
string
Name of the event type. The possible event names are the same as for the push.on function.
callback
Function
The same callback used to register with push.on.
Example
varcallback=function(data){/*...*/};//Adding handler for notification eventpush.on('notification',callback);//Removing handler for notification eventpush.off('notification',callback);
WARNING: As stated in the example, you will have to store your event handler if you are planning to remove it.
push.unregister(successHandler, errorHandler)
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.
Parameters
Parameter
Type
Default
Description
successHandler
Function
Is called when the api successfully unregisters.
errorHandler
Function
Is called when the api encounters an error while unregistering.
push.setApplicationIconBadgeNumber(successHandler, errorHandler, count) - iOS only
Set the badge count visible when the app is not running
Parameters
Parameter
Type
Default
Description
successHandler
Function
Is called when the api successfully sets the icon badge number.
errorHandler
Function
Is called when the api encounters an error while trying to set the icon badge number.
count
number
Indicates 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.