0.18

Edit

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.

To enable support for notification and register events you need to augment your AppDelegate.

At the top of your AppDelegate.m:

#import "RCTPushNotificationManager.h"

And then in your AppDelegate implementation add the following:

 // Required to register for notifications
 - (void)application:(UIApplication *)application didRegisterUserNotificationSettings:(UIUserNotificationSettings *)notificationSettings
 {
  [RCTPushNotificationManager didRegisterUserNotificationSettings:notificationSettings];
 }
 // Required for the register event.
 - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
 {
  [RCTPushNotificationManager didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
 }
 // Required for the notification event.
 - (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)notification
 {
  [RCTPushNotificationManager didReceiveRemoteNotification:notification];
 }

Methods

Reference

Methods

presentLocalNotification()

static presentLocalNotification(details)

Schedules the localNotification for immediate presentation.

details is an object containing:

  • alertBody : The message displayed in the notification alert.

scheduleLocalNotification()

static scheduleLocalNotification(details)

Schedules the localNotification for future presentation.

details is an object containing:

  • fireDate : The date and time when the system should deliver the notification.
  • alertBody : The message displayed in the notification alert.

cancelAllLocalNotifications()

static cancelAllLocalNotifications()

Cancels all scheduled localNotifications

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 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 PushNotificationIOS.
  • register: Fired when the user registers for remote notifications. The handler will be invoked with a hex string representing the deviceToken.

requestPermissions()

static requestPermissions(permissions?)

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:

  • alert
  • badge
  • sound

If a map is provided to the method, only the permissions with truthy values will be requested.

abandonPermissions()

static abandonPermissions()

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.

checkPermissions()

static checkPermissions(callback)

See what push permissions are currently enabled. callback will be invoked with a permissions object:

  • alert :boolean
  • badge :boolean
  • sound :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 instantiate 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

← PixelRatioSettings →