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.
Sets the badge number for the app icon on the home screen
Gets the current badge number for the app icon on the home screen
static addEventListener(type, handler)
Attaches a listener to remote notification events while the app is running in the foreground or the background.
Valid events are:
notification: Fired when a remote notification is received. The handler will be invoked with an instance of
register: Fired when the user registers for remote notifications. The handler will be invoked with a hex string representing the deviceToken.
Requests notification permissions from iOS, prompting the user's dialog box. By default, it will request all notification permissions, but a subset of these can be requested by passing a map of requested permissions. The following permissions are supported:
If a map is provided to the method, only the permissions with truthy values will be requested.
Unregister for all remote notifications received via Apple Push Notification service.
You should call this method in rare circumstances only, such as when a new version of the app removes support for all types of remote notifications. Users can temporarily prevent apps from receiving remote notifications through the Notifications section of the Settings app. Apps unregistered through this method can always re-register.
See what push permissions are currently enabled.
callback will be invoked with a
static removeEventListener(type, handler)
Removes the event listener. Do this in
componentWillUnmount to prevent memory leaks
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.
You will never need to instansiate
PushNotificationIOS yourself. Listening to the
notification event and invoking
popInitialNotification is sufficient
An alias for
getAlert to get the notification's main message string
Gets the sound string from the
Gets the notification's main message from the
Gets the badge count number from the
Gets the data object on the notif