PushNotificationIOS
Handle push notifications for your app, including permission handling and icon badge number.
To get up and running, configure your notifications with Apple and your server-side system. To get an idea, this is the Parse guide.
Methods
setApplicationIconBadgeNumber
getApplicationIconBadgeNumber
addEventListener
requestPermissions
checkPermissions
removeEventListener
popInitialNotification
constructor
getMessage
getSound
getAlert
getBadgeCount
getData
Reference
Methods
setApplicationIconBadgeNumber()
static setApplicationIconBadgeNumber(number)
Sets the badge number for the app icon on the home screen
getApplicationIconBadgeNumber()
static getApplicationIconBadgeNumber(callback)
Gets the current badge number for the app icon on the home screen
addEventListener()
static addEventListener(type, handler)
Attaches a listener to remote notifications while the app is running in the foreground or the background.
The handler will get be invoked with an instance of PushNotificationIOS
requestPermissions()
static requestPermissions()
Requests all notification permissions from iOS, prompting the user's dialog box.
checkPermissions()
static checkPermissions(callback)
See what push permissions are currently enabled. callback
will be invoked with a permissions
object:
alert
:booleanbadge
:booleansound
:boolean
removeEventListener()
static removeEventListener(type, handler)
Removes the event listener. Do this in componentWillUnmount
to prevent memory leaks
popInitialNotification()
static popInitialNotification()
An initial notification will be available if the app was cold-launched from a notification.
The first caller of popInitialNotification
will get the initial notification object, or null
. Subsequent invocations will return null.
constructor()
constructor(nativeNotif);
You will never need to instansiate PushNotificationIOS
yourself. Listening to the notification
event and invoking popInitialNotification
is sufficient
getMessage()
getMessage();
An alias for getAlert
to get the notification's main message string
getSound()
getSound();
Gets the sound string from the aps
object
getAlert()
getAlert();
Gets the notification's main message from the aps
object
getBadgeCount()
getBadgeCount();
Gets the badge count number from the aps
object
getData()
getData();
Gets the data object on the notif