版本：v7

@capacitor/push-notifications

Push Notifications API 提供对原生推送通知的访问能力。

安装

npm install @capacitor/push-notifications@latest-7
npx cap sync

iOS

在 iOS 上，你必须启用推送通知权限。有关如何启用该权限的说明，请参阅设置权限。

启用推送通知权限后，请在你的应用的 AppDelegate.swift 文件中添加以下代码：

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
  NotificationCenter.default.post(name: .capacitorDidRegisterForRemoteNotifications, object: deviceToken)
}

func application(_ application: UIApplication, didFailToRegisterForRemoteNotificationsWithError error: Error) {
  NotificationCenter.default.post(name: .capacitorDidFailToRegisterForRemoteNotifications, object: error)
}

Android

Push Notification API 使用 Firebase Cloud Messaging SDK 来处理通知。请参阅在 Android 上设置 Firebase Cloud Messaging 客户端应用并按照说明创建 Firebase 项目并注册你的应用程序。

无需将 Firebase SDK 添加到你的应用或编辑应用的清单文件 — Push Notifications 插件已为你提供所需内容。唯一需要的是将你的 Firebase 项目的 google-services.json 文件添加到应用的模块（应用级别）目录中。

Android 13 需要权限检查才能接收推送通知。当目标 SDK 版本为 33 时，你需要相应地调用 checkPermissions() 和 requestPermissions()。

从 Android 15 开始，用户可以在私人空间中安装应用。用户可以随时锁定其私人空间，这意味着在用户解锁之前不会显示推送通知。

无法检测应用是否安装在私人空间中。因此，如果你的应用显示任何关键通知，请告知你的用户避免将应用安装在私人空间内。

有关你的应用与私人空间相关的行为变更的更多信息，请参阅 Android 文档。

变量

本插件将使用以下项目变量（定义在你的应用的 variables.gradle 文件中）：

firebaseMessagingVersion 版本号为 com.google.firebase:firebase-messaging（默认值：24.1.0）

推送通知图标

在 Android 上，应将具有适当名称的推送通知图标添加到 AndroidManifest.xml 文件中：

<meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@mipmap/push_icon_name" />

如果未指定图标，Android 将使用应用图标，但推送图标应为透明背景上的白色像素。由于应用图标通常不是这样，因此会显示白色方块或圆形。因此，建议为推送通知提供单独的图标。

Android Studio 有一个图标生成器，你可以用来创建推送通知图标。

推送通知渠道

从 Android 8.0（API 级别 26）及更高版本开始，支持并推荐使用通知渠道。SDK 将按以下顺序为传入的推送通知派生 channelId：

首先检查传入的通知是否设置了 channelId。 无论是通过 FCM 控制台还是其 API 发送推送通知，都可以指定一个 channelId。
然后检查 AndroidManifest.xml 中可能给出的值。 如果你希望创建并使用自己的默认渠道，请将 default_notification_channel_id 设置为你通知渠道对象的 ID，如下所示；当传入消息未明确设置通知渠道时，FCM 将使用此值。

<meta-data
    android:name="com.google.firebase.messaging.default_notification_channel_id"
    android:value="@string/default_notification_channel_id" />

最后，它将使用 Firebase SDK 为我们提供的备用 channelId。 FCM 提供了一个具有基本设置的默认通知渠道。该渠道将在收到第一条推送消息时由 Firebase SDK 创建。

警告使用选项 1 或 2 时，你仍然需要在代码中创建一个通知渠道，其 ID 与所选选项中使用的 ID 匹配。你可以使用 createChannel(...) 来实现。如果不这样做，SDK 将回退到选项 3。

应用在前台时的推送通知显示方式

你可以配置应用在前台时推送通知的显示方式。

属性	类型	描述	始于
`presentationOptions`	`PresentationOption[]`	这是一个可以组合的字符串数组。数组中可能的值为： - `badge`：更新应用图标上的角标计数（默认值） - `sound`：收到推送通知时设备会响铃/振动 - `alert`：推送通知显示在原生对话框中如果不希望任何选项，可以提供一个空数组。badge 仅适用于 iOS。	1.0.0

示例

在 capacitor.config.json 中：

{
  "plugins": {
    "PushNotifications": {
      "presentationOptions": ["badge", "sound", "alert"]
    }
  }
}

在 capacitor.config.ts 中：

/// <reference types="@capacitor/push-notifications" />

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    PushNotifications: {
      presentationOptions: ["badge", "sound", "alert"],
    },
  },
};

export default config;

静默推送通知 / 纯数据通知

iOS

此插件不支持 iOS 静默推送（远程通知）。我们建议使用原生代码解决方案来处理这类通知，请参阅推送后台更新到你的应用。

Android

此插件确实支持纯数据通知，但如果应用程序已被终止，则不会调用 pushNotificationReceived。要处理这种情况，你需要创建一个继承自 FirebaseMessagingService 的服务，请参阅处理 FCM 消息。

常见问题

在 Android 上，有多种系统和应用状态可能会影响推送通知的送达：

如果设备已进入 Doze 模式，你的应用程序功能可能会受到限制。为了提高通知被接收的几率，可以考虑使用 FCM 高优先级消息。
开发环境和生产环境下的行为存在差异。尝试在非 Android Studio 启动的情况下测试你的应用。了解更多信息请点击这里。

示例

import { PushNotifications } from '@capacitor/push-notifications';

const addListeners = async () => {
  await PushNotifications.addListener('registration', token => {
    console.info('Registration token: ', token.value);
  });

  await PushNotifications.addListener('registrationError', err => {
    console.error('Registration error: ', err.error);
  });

  await PushNotifications.addListener('pushNotificationReceived', notification => {
    console.log('Push notification received: ', notification);
  });

  await PushNotifications.addListener('pushNotificationActionPerformed', notification => {
    console.log('Push notification action performed', notification.actionId, notification.inputValue);
  });
}

const registerNotifications = async () => {
  let permStatus = await PushNotifications.checkPermissions();

  if (permStatus.receive === 'prompt') {
    permStatus = await PushNotifications.requestPermissions();
  }

  if (permStatus.receive !== 'granted') {
    throw new Error('User denied permissions!');
  }

  await PushNotifications.register();
}

const getDeliveredNotifications = async () => {
  const notificationList = await PushNotifications.getDeliveredNotifications();
  console.log('delivered notifications', notificationList);
}

API

register()
unregister()
getDeliveredNotifications()
removeDeliveredNotifications(...)
removeAllDeliveredNotifications()
createChannel(...)
deleteChannel(...)
listChannels()
checkPermissions()
requestPermissions()
addListener('registration', ...)
addListener('registrationError', ...)
addListener('pushNotificationReceived', ...)
addListener('pushNotificationActionPerformed', ...)
removeAllListeners()
接口
类型别名

register()

register() => Promise<void>

注册应用以接收推送通知。

此方法将触发 'registration' 事件（携带推送令牌）或在出现问题时触发 'registrationError'。它不会向用户请求通知权限，请先使用 requestPermissions() 方法。

自： 1.0.0

unregister()

unregister() => Promise<void>

取消应用对推送通知的注册。

在 Android 上，这将删除 Firebase 令牌；在 iOS 上，将取消对 APNS 的注册。

自： 5.0.0

getDeliveredNotifications()

getDeliveredNotifications() => Promise<DeliveredNotifications>

获取通知屏幕上可见的通知列表。

返回值：

Promise<DeliveredNotifications>

自： 1.0.0

removeDeliveredNotifications(...)

removeDeliveredNotifications(delivered: DeliveredNotifications) => Promise<void>

从通知屏幕上移除指定的通知。

参数	类型
`delivered`	`DeliveredNotifications`

自： 1.0.0

removeAllDeliveredNotifications()

removeAllDeliveredNotifications() => Promise<void>

从通知屏幕上移除所有通知。

自： 1.0.0

createChannel(...)

createChannel(channel: Channel) => Promise<void>

创建通知渠道。

仅在 Android O 或更新版本（SDK 26+）上可用。

参数	类型
`channel`	`Channel`

自： 1.0.0

deleteChannel(...)

deleteChannel(args: { id: string; }) => Promise<void>

删除通知渠道。

仅在 Android O 或更新版本（SDK 26+）上可用。

参数	类型
`args`	`{ id: string; }`

自： 1.0.0

listChannels()

listChannels() => Promise<ListChannelsResult>

列出可用的通知渠道。

仅在 Android O 或更新版本（SDK 26+）上可用。

返回值：

Promise<ListChannelsResult>

自： 1.0.0

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

检查接收推送通知的权限。

在 Android 12 及以下版本中，状态始终为 granted，因为你总是可以接收推送通知。如果你需要检查用户是否允许显示通知，请使用 local-notifications 插件。

返回值：

Promise<PermissionStatus>

自： 1.0.0

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

请求接收推送通知的权限。

在 Android 12 及更低版本上，此方法不会提示权限请求，因为系统始终允许接收推送通知。

在 iOS 上，首次调用此方法时，会提示用户授予推送通知权限，并根据用户的选择返回 granted（已授予）或 denied（已拒绝）。后续调用将直接返回当前权限状态，不再重复提示。

返回：

Promise<PermissionStatus>

自： 1.0.0

addListener('registration', ...)

addListener(eventName: 'registration', listenerFunc: (token: Token) => void) => Promise<PluginListenerHandle>

当推送通知注册成功完成时调用。

提供推送通知令牌。

参数	类型
`eventName`	`'registration'`
`listenerFunc`	`(token: Token) => void`

返回：

Promise<PluginListenerHandle>

自： 1.0.0

addListener('registrationError', ...)

addListener(eventName: 'registrationError', listenerFunc: (error: RegistrationError) => void) => Promise<PluginListenerHandle>

当推送通知注册过程中遇到问题时调用。

提供注册相关的错误信息。

参数	类型
`eventName`	`'registrationError'`
`listenerFunc`	`(error: RegistrationError) => void`

返回：

Promise<PluginListenerHandle>

自： 1.0.0

addListener('pushNotificationReceived', ...)

addListener(eventName: 'pushNotificationReceived', listenerFunc: (notification: PushNotificationSchema) => void) => Promise<PluginListenerHandle>

当设备收到推送通知时调用。

参数	类型
`eventName`	`'pushNotificationReceived'`
`listenerFunc`	`(notification: PushNotificationSchema) => void`

返回：

Promise<PluginListenerHandle>

自： 1.0.0

addListener('pushNotificationActionPerformed', ...)

addListener(eventName: 'pushNotificationActionPerformed', listenerFunc: (notification: ActionPerformed) => void) => Promise<PluginListenerHandle>

当对推送通知执行了某个操作时调用。

参数	类型
`eventName`	`'pushNotificationActionPerformed'`
`listenerFunc`	`(notification: ActionPerformed) => void`

返回：

Promise<PluginListenerHandle>

自： 1.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

移除本插件的所有原生事件监听器。

自： 1.0.0

接口

DeliveredNotifications

属性	类型	描述	自
`notifications`	`PushNotificationSchema[]`	通知屏幕上可见的通知列表。	1.0.0

PushNotificationSchema

属性	类型	描述	自
`title`	`string`	通知标题。	1.0.0
`subtitle`	`string`	通知副标题。	1.0.0
`body`	`string`	通知的主要文本内容。	1.0.0
`id`	`string`	通知标识符。	1.0.0
`tag`	`string`	通知标签。仅 Android 可用（来自推送通知）。	4.0.0
`badge`	`number`	显示在应用图标角标上的数字。	1.0.0
`notification`	`any`	此属性当前不返回。	1.0.0
`data`	`any`	推送通知负载中包含的任何附加数据。	1.0.0
`click_action`	`string`	用户点击通知时要执行的操作。仅 Android 可用。	1.0.0
`link`	`string`	通知中的深度链接。仅 Android 可用。	1.0.0
`group`	`string`	设置通知分组的组标识符。仅 Android 可用。功能类似于 iOS 的 `threadIdentifier`。	1.0.0
`groupSummary`	`boolean`	将此通知指定为关联 `group` 的摘要通知。仅 Android 可用。	1.0.0

Channel

属性	类型	说明	默认值	始于
`id`	`string`	频道标识符		1.0.0
`name`	`string`	该频道的用户友好名称（展示给用户）		1.0.0
`description`	`string`	该频道的描述（展示给用户）		1.0.0
`sound`	`string`	发布到该频道的通知应播放的声音。重要性级别至少为 `3` 的通知频道应设有声音。声音文件名应相对于 Android 应用的 `res/raw` 目录指定。		1.0.0
`importance`	`Importance`	发布到该频道的通知的打断级别	`3`	1.0.0
`visibility`	`Visibility`	发布到该频道的通知的可见性。此设置控制发布到此频道的通知是否显示在锁屏界面上，以及如果显示，是否以隐藏形式呈现。		1.0.0
`lights`	`boolean`	发布到该频道的通知是否显示指示灯（在支持的设备上）		1.0.0
`lightColor`	`string`	发布到该频道的通知的指示灯颜色。仅当该频道启用了指示灯且设备支持时才有效。支持的颜色格式为 `#RRGGBB` 和 `#RRGGBBAA`。		1.0.0
`vibration`	`boolean`	发布到该频道的通知是否振动		1.0.0

ListChannelsResult

属性	类型	说明	始于
`channels`	`Channel[]`	你的应用创建的所有频道的列表。	1.0.0

PermissionStatus

属性	类型	说明	始于
`receive`	`PermissionState`	接收通知的权限状态。	1.0.0

PluginListenerHandle

属性	类型
`remove`	`() => Promise<void>`

Token

属性	类型	说明	始于
`value`	`string`	在 iOS 上包含 APNS 令牌。在 Android 上包含 FCM 令牌。	1.0.0

RegistrationError

属性	类型	说明	始于
`error`	`string`	描述注册失败的错误信息。	4.0.0

ActionPerformed

属性	类型	说明	始于
`actionId`	`string`	在通知上执行的操作的 ID。	1.0.0
`inputValue`	`string`	在通知操作中输入的值。仅 iOS 可用。	1.0.0
`notification`	`PushNotificationSchema`	执行了该操作的通知对象。	1.0.0

类型别名

Importance

重要性级别。更多详情请参阅 Android 开发者文档

1 | 2 | 3 | 4 | 5

Visibility

通知可见性。更多详情请参阅 Android 开发者文档

-1 | 0 | 1

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'

安装​

iOS​

Android​

变量​

推送通知图标​

推送通知渠道​

应用在前台时的推送通知显示方式​

示例​

静默推送通知 / 纯数据通知​

iOS​

Android​

常见问题​

示例​

API​

register()​

unregister()​

getDeliveredNotifications()​

removeDeliveredNotifications(...)​

removeAllDeliveredNotifications()​

createChannel(...)​

deleteChannel(...)​

listChannels()​

checkPermissions()​

requestPermissions()​

addListener('registration', ...)​

addListener('registrationError', ...)​

addListener('pushNotificationReceived', ...)​

addListener('pushNotificationActionPerformed', ...)​

removeAllListeners()​

接口​

DeliveredNotifications​

PushNotificationSchema​

Channel​

ListChannelsResult​

PermissionStatus​

PluginListenerHandle​

Token​

RegistrationError​

ActionPerformed​

类型别名​

Importance​

Visibility​

PermissionState​

Contents

安装

iOS

Android

变量

推送通知图标

推送通知渠道

应用在前台时的推送通知显示方式

示例

静默推送通知 / 纯数据通知

iOS

Android

常见问题

示例

API

register()

unregister()

getDeliveredNotifications()

removeDeliveredNotifications(...)

removeAllDeliveredNotifications()

createChannel(...)

deleteChannel(...)

listChannels()

checkPermissions()

requestPermissions()

addListener('registration', ...)

addListener('registrationError', ...)

addListener('pushNotificationReceived', ...)

addListener('pushNotificationActionPerformed', ...)

removeAllListeners()

接口

DeliveredNotifications

PushNotificationSchema

Channel

ListChannelsResult

PermissionStatus

PluginListenerHandle

Token

RegistrationError

ActionPerformed

类型别名

Importance

Visibility

PermissionState