新架构实战课实操 + 基建 + 原理全维度包揽，抢先掌握 React Native 新架构精髓立即查看 >

🚧 PushNotificationIOS

已过时。 Use @react-native-community/push-notification-ios instead.

本模块帮助你处理应用的推送通知，包括权限控制以及应用图标上的角标数（未读消息数）。

要使用推送通知功能，首先在苹果后台配置推送通知服务并且准备好服务端的系统。

Add the PushNotificationIOS library to your Podfile: ./ios/Podfile

  target 'myAwesomeApp' do
    # Pods for myAwesomeApp
    pod 'React-RCTPushNotification', :path => '../node_modules/react-native/Libraries/PushNotificationIOS'
  end

译注: 0.60 版本之前的步骤不同，请查看老版本文档。

然后你需要在 AppDelegate 中启用推送通知的支持以及注册相应的事件。

在AppDelegate.m开头：

#import <React/RCTPushNotificationManager.h>

然后在 AppDelegate 实现中添加如下的代码：

 // 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. You must call the completion handler after handling the remote notification.
 - (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo
                                                        fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler
 {
   [RCTPushNotificationManager didReceiveRemoteNotification:userInfo fetchCompletionHandler:completionHandler];
 }
 // Required for the registrationError event.
 - (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
 {
  [RCTPushNotificationManager didFailToRegisterForRemoteNotificationsWithError:error];
 }
 // Required for the localNotification event.
 - (void)application:(UIApplication *)application didReceiveLocalNotification:(UILocalNotification *)notification
 {
  [RCTPushNotificationManager didReceiveLocalNotification:notification];
 }

To show notifications while being in the foreground (available starting from iOS 10) add the following lines:

At the top of your AppDelegate.m:

#import <UserNotifications/UserNotifications.h>

And then in your AppDelegate implementation add the following:

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
  ...
  // Define UNUserNotificationCenter
  UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter];
  center.delegate = self;

  return YES;
}

//Called when a notification is delivered to a foreground app.
-(void)userNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler
{
  completionHandler(UNAuthorizationOptionSound | UNAuthorizationOptionAlert | UNAuthorizationOptionBadge);
}

Then enable Background Modes/Remote notifications to be able to use remote notifications properly. The easiest way to do this is via the project settings. Navigate to Targets -> Your App -> Capabilities -> Background Modes and check Remote notifications. This will automatically enable the required settings.

文档

Methods

`presentLocalNotification()`

PushNotificationIOS.presentLocalNotification(details);

Schedules the localNotification for immediate presentation.

参数：

名称	类型	必需	说明
details	object	是	看下面的说明

details is an object containing:

alertBody : The message displayed in the notification alert.
alertAction : The "action" displayed beneath an actionable notification. Defaults to "view";
soundName : The sound played when the notification is fired (optional).
isSilent : If true, the notification will appear without sound (optional).
category : The category of this notification, required for actionable notifications (optional).
userInfo : An optional object containing additional notification data.
applicationIconBadgeNumber (optional) : The number to display as the app's icon badge. The default value of this property is 0, which means that no badge is displayed.

`scheduleLocalNotification()`

PushNotificationIOS.scheduleLocalNotification(details);

Schedules the localNotification for future presentation.

参数：

名称	类型	必需	说明
details	object	是	看下面的说明

details is an object containing:

fireDate : The date and time when the system should deliver the notification.
alertTitle : The text displayed as the title of the notification alert.
alertBody : The message displayed in the notification alert.
alertAction : The "action" displayed beneath an actionable notification. Defaults to "view";
soundName : The sound played when the notification is fired (optional).
isSilent : If true, the notification will appear without sound (optional).
category : The category of this notification, required for actionable notifications (optional).
userInfo : An optional object containing additional notification data.
applicationIconBadgeNumber (optional) : The number to display as the app's icon badge. Setting the number to 0 removes the icon badge.
repeatInterval : The interval to repeat as a string. Possible values: minute, hour, day, week, month, year.

`cancelAllLocalNotifications()`

PushNotificationIOS.cancelAllLocalNotifications();

Cancels all scheduled localNotifications

`removeAllDeliveredNotifications()`

PushNotificationIOS.removeAllDeliveredNotifications();

Remove all delivered notifications from Notification Center

`getDeliveredNotifications()`

PushNotificationIOS.getDeliveredNotifications(callback);

Provides you with a list of the app’s notifications that are still displayed in Notification Center

参数：

名称	类型	必需	说明
callback	function	是	Function which receive an array of delivered notifications.

A delivered notification is an object containing:

identifier : The identifier of this notification.
title : The title of this notification.
body : The body of this notification.
category : The category of this notification, if has one.
userInfo : An optional object containing additional notification data.
thread-id : The thread identifier of this notification, if has one.

`removeDeliveredNotifications()`

PushNotificationIOS.removeDeliveredNotifications(identifiers);

Removes the specified notifications from Notification Center

参数：

名称	类型	必需	说明
identifiers	array	是	Array of notification identifiers.

`setApplicationIconBadgeNumber()`

PushNotificationIOS.setApplicationIconBadgeNumber(number);

Sets the badge number for the app icon on the home screen

参数：

名称	类型	必需	说明
number	number	是	Badge number for the app icon.

`getApplicationIconBadgeNumber()`

PushNotificationIOS.getApplicationIconBadgeNumber(callback);

Gets the current badge number for the app icon on the home screen

参数：

名称	类型	必需	说明
callback	function	是	A function that will be passed the current badge number.

`cancelLocalNotifications()`

PushNotificationIOS.cancelLocalNotifications(userInfo);

Cancel local notifications.

Optionally restricts the set of canceled notifications to those notifications whose userInfo fields match the corresponding fields in the userInfo argument.

参数：

名称	类型	必需	说明
userInfo	object	否

`getScheduledLocalNotifications()`

PushNotificationIOS.getScheduledLocalNotifications(callback);

Gets the local notifications that are currently scheduled.

参数：

名称	类型	必需	说明
callback	function	是	A function that will be passed an array of objects describing local notifications.

`addEventListener()`

PushNotificationIOS.addEventListener(type, handler);

Attaches a listener to remote or local notification events while the app is running in the foreground or the background.

参数：

名称	类型	必需	说明
类型	string	是	Event type.
handler	function	是	Listener.

Valid events are:

notification：当接收到远程通知时触发。处理程序将使用一个PushNotificationIOS实例调用。
localNotification：当接收到本地通知时触发。处理程序将使用一个PushNotificationIOS实例调用。
register：当用户注册远程通知时触发。处理程序将使用表示设备令牌的十六进制字符串调用。
registrationError: 当用户无法注册远程通知时触发。通常在 APNS 出现问题或设备为模拟器时发生。处理程序将被调用并传入 {message: string, code: number, details: any}。

`removeEventListener()`

PushNotificationIOS.removeEventListener(type, handler);

Removes the event listener. Do this in componentWillUnmount to prevent memory leaks

参数：

名称	类型	必需	说明
类型	string	是	Event type.
handler	function	是	Listener.

`requestPermissions()`

PushNotificationIOS.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.

This method returns a promise that will resolve when the user accepts, rejects, or if the permissions were previously rejected. The promise resolves to the current state of the permission.

参数：

名称	类型	必需	说明
permissions	array	否	alert, badge, or sound

`abandonPermissions()`

PushNotificationIOS.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()`

PushNotificationIOS.checkPermissions(callback);

See what push permissions are currently enabled.

参数：

名称	类型	必需	说明
callback	function	是	看下面的说明

callback will be invoked with a permissions object:

alert: boolean
badge: boolean
sound: boolean

`getInitialNotification()`

PushNotificationIOS.getInitialNotification();

This method returns a promise. If the app was launched by a push notification, this promise resolves to an object of type PushNotificationIOS. Otherwise, it resolves to null.

`constructor()`

constructor(nativeNotif);

You will never need to instantiate PushNotificationIOS yourself. Listening to the notification event and invoking getInitialNotification is sufficient.

`finish()`

finish(fetchResult);

This method is available for remote notifications that have been received via: application:didReceiveRemoteNotification:fetchCompletionHandler: https://developer.apple.com/documentation/uikit/uiapplicationdelegate/1623013-application?language=objc

Call this to execute when the remote notification handling is complete. When calling this block, pass in the fetch result value that best describes the results of your operation. You must call this handler and should do so as soon as possible. For a list of possible values, see PushNotificationIOS.FetchResult.

If you do not call this method your background remote notifications could be throttled, to read more about it see the above documentation link.

`getMessage()`

getMessage();

An alias for getAlert to get the notification's main message string

`getSound()`

getSound();

Gets the sound string from the aps object

`getCategory()`

getCategory();

Gets the category string from the aps object

`getAlert()`

getAlert();

Gets the notification's main message from the aps object

`getContentAvailable()`

getContentAvailable();

Gets the content-available number from the aps object

`getBadgeCount()`

getBadgeCount();

Gets the badge count number from the aps object

`getData()`

getData();

Gets the data object on the notif

`getThreadID()`

getThreadID();

Gets the thread ID on the notification

Projects with Native Code Only

文档

Methods​

presentLocalNotification()​

scheduleLocalNotification()​

cancelAllLocalNotifications()​

removeAllDeliveredNotifications()​

getDeliveredNotifications()​

removeDeliveredNotifications()​

setApplicationIconBadgeNumber()​

getApplicationIconBadgeNumber()​

cancelLocalNotifications()​

getScheduledLocalNotifications()​

addEventListener()​

removeEventListener()​

requestPermissions()​

abandonPermissions()​

checkPermissions()​

getInitialNotification()​

constructor()​

finish()​

getMessage()​

getSound()​

getCategory()​

getAlert()​

getContentAvailable()​

getBadgeCount()​

getData()​

getThreadID()​

Methods

`presentLocalNotification()`

`scheduleLocalNotification()`

`cancelAllLocalNotifications()`

`removeAllDeliveredNotifications()`

`getDeliveredNotifications()`

`removeDeliveredNotifications()`

`setApplicationIconBadgeNumber()`

`getApplicationIconBadgeNumber()`

`cancelLocalNotifications()`

`getScheduledLocalNotifications()`

`addEventListener()`

`removeEventListener()`

`requestPermissions()`

`abandonPermissions()`

`checkPermissions()`

`getInitialNotification()`

`constructor()`

`finish()`

`getMessage()`

`getSound()`

`getCategory()`

`getAlert()`

`getContentAvailable()`

`getBadgeCount()`

`getData()`

`getThreadID()`