🗑️ PushNotificationIOS

Deprecated

请使用其中一个社区包代替。

处理你应用的通知，包括调度和权限。

入门

要启用推送通知，请向 Apple 配置你的通知以及你的服务器端系统。

然后，在你的项目中启用远程通知。这将自动启用所需设置。

启用对 `register` 事件的支持

在你的 AppDelegate.m 中添加：

Objective-C
#import <React/RCTPushNotificationManager.h>

然后按如下方式实现，以处理远程通知注册事件：

Objective-C
- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
 // 这将触发 PushNotificationIOS 上的 'register' 事件
 [RCTPushNotificationManager didRegisterForRemoteNotificationsWithDeviceToken:deviceToken];
}
- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
{
 // 这将触发 PushNotificationIOS 上的 'registrationError' 事件
 [RCTPushNotificationManager didFailToRegisterForRemoteNotificationsWithError:error];
}

处理通知

你需要在 AppDelegate 中实现 UNUserNotificationCenterDelegate：

Objective-C
#import <UserNotifications/UserNotifications.h>

@interface YourAppDelegate () <UNUserNotificationCenterDelegate>
@end

在应用启动时设置 delegate：

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

  return YES;
}

前台通知

实现 userNotificationCenter:willPresentNotification:withCompletionHandler: 以处理应用处于前台时到达的通知。使用 completionHandler 来决定是否向用户显示通知，并相应地通知 RCTPushNotificationManager：

Objective-C
// 当通知投递到前台应用时调用。
- (void)userNotificationCenter:(UNUserNotificationCenter *)center
       willPresentNotification:(UNNotification *)notification
         withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler
{
  // 这将触发 PushNotificationIOS 上的 'notification' 和 'localNotification' 事件
  [RCTPushNotificationManager didReceiveNotification:notification];
  // 决定是否以及如何向用户显示该通知
  completionHandler(UNNotificationPresentationOptionNone);
}

后台通知

实现 userNotificationCenter:didReceiveNotificationResponse:withCompletionHandler: 以处理通知被点击的情况，通常是用户点击后台通知以打开应用时调用。不过，如果你已在 userNotificationCenter:willPresentNotification:withCompletionHandler: 中设置前台通知显示，那么当前台通知被点击时，此方法也会被调用。在这种情况下，你只应在这些回调中的一个里通知 RCTPushNotificationManager。

如果被点击的通知导致应用启动，请调用 setInitialNotification:。如果该通知之前未通过 userNotificationCenter:willPresentNotification:withCompletionHandler: 处理，则也调用 didReceiveNotification:：

Objective-C
- (void)  userNotificationCenter:(UNUserNotificationCenter *)center
  didReceiveNotificationResponse:(UNNotificationResponse *)response
           withCompletionHandler:(void (^)(void))completionHandler
{
  // 如果通知被点击以启动应用，则此条件成立
  if ([response.actionIdentifier isEqualToString:UNNotificationDefaultActionIdentifier]) {
    // 允许在 JS 端通过 getInitialNotification() 获取该通知
    [RCTPushNotificationManager setInitialNotification:response.notification];
  }
  // 这将触发 PushNotificationIOS 上的 'notification' 和 'localNotification' 事件
  [RCTPushNotificationManager didReceiveNotification:response.notification];
  completionHandler();
}

参考

方法

`presentLocalNotification()`

React TSX
static presentLocalNotification(details: PresentLocalNotificationDetails);

安排一个本地通知立即显示。

参数：

名称	类型	必需	描述
details	object	是	见下文。

details 是一个包含以下内容的对象：

alertTitle：显示为通知提醒标题的文本。
alertBody：显示在通知提醒中的消息。
userInfo：包含额外通知数据的对象（可选）。
category：此通知的类别，交互式通知需要（可选）。例如，带有 Reply 或 Like 等附加操作的通知。
applicationIconBadgeNumber：显示在应用图标角标上的数字。此属性的默认值为 0，表示不显示角标（可选）。
isSilent：如果为 true，通知将无声音显示（可选）。
soundName：通知触发时播放的声音（可选）。
alertAction：已弃用。用于 iOS 的旧版 UILocalNotification。

`scheduleLocalNotification()`

React TSX
static scheduleLocalNotification(details: ScheduleLocalNotificationDetails);

安排一个本地通知在未来显示。

参数：

名称	类型	必需	描述
details	object	是	见下文。

details 是一个包含以下内容的对象：

alertTitle：显示为通知提醒标题的文本。
alertBody：显示在通知提醒中的消息。
fireDate：通知将被触发的时间。使用 fireDate 或 fireIntervalSeconds 来安排通知，且 fireDate 优先。
fireIntervalSeconds：从现在起多少秒后显示通知。
userInfo：包含额外通知数据的对象（可选）。
category：此通知的类别，交互式通知需要（可选）。例如，带有 Reply 或 Like 等附加操作的通知。
applicationIconBadgeNumber：显示在应用图标角标上的数字。此属性的默认值为 0，表示不显示角标（可选）。
isSilent：如果为 true，通知将无声音显示（可选）。
soundName：通知触发时播放的声音（可选）。
alertAction：已弃用。用于 iOS 的旧版 UILocalNotification。
repeatInterval：已弃用。请改用 fireDate 或 fireIntervalSeconds。

`cancelAllLocalNotifications()`

React TSX
static cancelAllLocalNotifications();

取消所有已安排的本地通知。

`removeAllDeliveredNotifications()`

React TSX
static removeAllDeliveredNotifications();

从通知中心移除所有已送达的通知。

`getDeliveredNotifications()`

React TSX
static getDeliveredNotifications(callback: (notifications: Object[]) => void);

提供当前显示在通知中心中的应用通知列表。

参数：

名称	类型	必需	描述
callback	function	是	接收已送达通知数组的函数。

已送达的通知是一个包含以下内容的对象：

identifier：此通知的标识符。
title：此通知的标题。
body：此通知的正文。
category：此通知的类别（可选）。
userInfo：包含额外通知数据的对象（可选）。
thread-id：此通知的线程标识符（如果有）。

`removeDeliveredNotifications()`

React TSX
static removeDeliveredNotifications(identifiers: string[]);

从通知中心移除指定通知。

参数：

名称	类型	必需	描述
identifiers	array	是	通知标识符数组。

`setApplicationIconBadgeNumber()`

React TSX
static setApplicationIconBadgeNumber(num: number);

设置主屏幕上应用图标的角标数字。

参数：

名称	类型	必需	描述
number	number	是	应用图标的角标数字。

`getApplicationIconBadgeNumber()`

React TSX
static getApplicationIconBadgeNumber(callback: (num: number) => void);

获取主屏幕上应用图标当前的角标数字。

参数：

名称	类型	必需	描述
callback	function	是	处理当前角标数字的函数。

`cancelLocalNotifications()`

React TSX
static cancelLocalNotifications(userInfo: Object);

取消所有与提供的 userInfo 字段匹配的已安排本地通知。

参数：

名称	类型	必需	描述
userInfo	object	否

`getScheduledLocalNotifications()`

React TSX
static getScheduledLocalNotifications(
  callback: (notifications: ScheduleLocalNotificationDetails[]) => void,
);

获取当前已安排的本地通知列表。

参数：

名称	类型	必需	描述
callback	function	是	处理描述本地通知的对象数组的函数。

`addEventListener()`

React TSX
static addEventListener(
  type: PushNotificationEventName,
  handler:
    | ((notification: PushNotification) => void)
    | ((deviceToken: string) => void)
    | ((error: {message: string; code: number; details: any}) => void),
);

为通知事件添加监听器，包括本地通知、远程通知和通知注册结果。

参数：

名称	类型	必需	描述
type	string	是	要监听的事件类型。见下文。
handler	function	是	监听器。

有效的事件类型包括：

notification：收到远程通知时触发。处理函数将以 PushNotificationIOS 的实例作为参数调用。这将处理在前台到达的通知，或用户从后台点击以打开应用的通知。
localNotification：收到本地通知时触发。处理函数将以 PushNotificationIOS 的实例作为参数调用。这将处理在前台到达的通知，或用户从后台点击以打开应用的通知。
register：用户成功注册远程通知时触发。处理函数将以表示 deviceToken 的十六进制字符串作为参数调用。
registrationError：用户注册远程通知失败时触发。通常由于 APNS 问题，或者设备是模拟器。处理函数将以 {message: string, code: number, details: any} 作为参数调用。

`removeEventListener()`

React TSX
static removeEventListener(
  type: PushNotificationEventName,
);

移除事件监听器。请在 componentWillUnmount 中执行此操作以防止内存泄漏。

参数：

名称	类型	必需	描述
type	string	是	事件类型。请参阅 `addEventListener()` 以获取可选项。

`requestPermissions()`

React TSX
static requestPermissions(permissions?: PushNotificationPermissions[]);

向 iOS 请求通知权限，并弹出对话框提示用户。默认情况下，这将请求所有通知权限，但你也可以选择指定要请求哪些权限。支持以下权限：

alert
badge
sound

如果向该方法提供了一个映射，则只会请求其中值为 truthy 的权限。

此方法返回一个 promise，当用户接受或拒绝请求，或权限先前已被拒绝时，该 promise 将被 resolve。该 promise 会 resolve 为请求完成后权限的状态。

参数：

名称	类型	必需	描述
permissions	array	否	alert、badge 或 sound

`abandonPermissions()`

React TSX
static abandonPermissions();

注销通过 Apple Push Notification service 接收的所有远程通知。

你应仅在极少数情况下调用此方法，例如当应用的新版本移除了对所有类型远程通知的支持时。用户可以通过设置 App 临时阻止应用接收远程通知。通过此方法注销的应用总是可以重新注册。

`checkPermissions()`

React TSX
static checkPermissions(
  callback: (permissions: PushNotificationPermissions) => void,
);

检查当前启用了哪些推送权限。

参数：

名称	类型	必需	描述
callback	function	是	见下文。

callback 将以一个 permissions 对象被调用：

alert: boolean
badge: boolean
sound: boolean

`getInitialNotification()`

React TSX
static getInitialNotification(): Promise<PushNotification | null>;

此方法返回一个 promise。如果应用是由推送通知启动的，则该 promise 会 resolve 为被点击通知对应的 PushNotificationIOS 对象。否则，它会 resolve 为 null。

`getAuthorizationStatus()`

React TSX
static getAuthorizationStatus(): Promise<number>;

此方法返回一个 promise，该 promise 会 resolve 为当前通知授权状态。可能的值请参阅 UNAuthorizationStatus。

`finish()`

React TSX
finish(result: string);

此方法适用于通过 application:didReceiveRemoteNotification:fetchCompletionHandler: 接收的远程通知。不过，它已被 UNUserNotificationCenterDelegate 取代，如果同时实现了 application:didReceiveRemoteNotification:fetchCompletionHandler: 和较新的 UNUserNotificationCenterDelegate 处理程序，则它将不再被调用。

如果由于某些原因你仍依赖 application:didReceiveRemoteNotification:fetchCompletionHandler:，则你需要在 iOS 端设置事件处理：

Objective-C
- (void)           application:(UIApplication *)application
  didReceiveRemoteNotification:(NSDictionary *)userInfo
        fetchCompletionHandler:(void (^)(UIBackgroundFetchResult result))handler
{
  [RCTPushNotificationManager didReceiveRemoteNotification:userInfo fetchCompletionHandler:handler];
}

在 JS 端处理完通知后，调用 finish() 来执行原生完成处理程序。调用此块时，传入最能描述你操作结果的 fetch result 值。可选值列表请参见 PushNotificationIOS.FetchResult。

如果你使用的是 application:didReceiveRemoteNotification:fetchCompletionHandler:，你_必须_调用此处理程序，并且应尽快调用。更多详情请参阅官方文档。

`getMessage()`

React TSX
getMessage(): string | Object;

getAlert 的别名，用于获取通知的主消息字符串。

`getSound()`

React TSX
getSound(): string;

从 aps 对象中获取声音字符串。对于本地通知，这将是 null。

`getCategory()`

React TSX
getCategory(): string;

从 aps 对象中获取类别字符串。

`getAlert()`

React TSX
getAlert(): string | Object;

从 aps 对象中获取通知的主消息。另请参阅别名：getMessage()。

`getContentAvailable()`

React TSX
getContentAvailable(): number;

从 aps 对象中获取 content-available 数值。

`getBadgeCount()`

React TSX
getBadgeCount(): number;

从 aps 对象中获取角标数量。

`getData()`

React TSX
getData(): Object;

获取通知上的数据对象。

`getThreadID()`

React TSX
getThreadID();

获取通知上的线程 ID。

仅适用于包含原生代码的项目

入门​

启用对 register 事件的支持​

处理通知​

前台通知​

后台通知​

参考

方法​

presentLocalNotification()​

scheduleLocalNotification()​

cancelAllLocalNotifications()​

removeAllDeliveredNotifications()​

getDeliveredNotifications()​

removeDeliveredNotifications()​

setApplicationIconBadgeNumber()​

getApplicationIconBadgeNumber()​

cancelLocalNotifications()​

getScheduledLocalNotifications()​

addEventListener()​

removeEventListener()​

requestPermissions()​

abandonPermissions()​

checkPermissions()​

getInitialNotification()​

getAuthorizationStatus()​

finish()​

getMessage()​

getSound()​

getCategory()​

getAlert()​

getContentAvailable()​

getBadgeCount()​

getData()​

getThreadID()​

入门

启用对 `register` 事件的支持

处理通知

前台通知

后台通知

方法

`presentLocalNotification()`

`scheduleLocalNotification()`

`cancelAllLocalNotifications()`

`removeAllDeliveredNotifications()`

`getDeliveredNotifications()`

`removeDeliveredNotifications()`

`setApplicationIconBadgeNumber()`

`getApplicationIconBadgeNumber()`

`cancelLocalNotifications()`

`getScheduledLocalNotifications()`

`addEventListener()`

`removeEventListener()`

`requestPermissions()`

`abandonPermissions()`

`checkPermissions()`

`getInitialNotification()`

`getAuthorizationStatus()`

`finish()`

`getMessage()`

`getSound()`

`getCategory()`

`getAlert()`

`getContentAvailable()`

`getBadgeCount()`

`getData()`

`getThreadID()`