版本：v4

@capacitor/push-notifications

推送通知 API 提供对原生推送通知的访问。

安装

npm install @capacitor/push-notifications
npx cap sync

iOS

在 iOS 上，您必须启用推送通知（Push Notifications）能力。请参阅设置能力了解如何启用该能力的说明。

启用推送通知能力后，将以下内容添加到您的应用的 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

推送通知 API 使用 Firebase Cloud Messaging SDK 处理通知。请参阅在 Android 上设置 Firebase Cloud Messaging 客户端应用并按照说明创建 Firebase 项目并注册您的应用程序。无需将 Firebase SDK 添加到您的应用或编辑应用清单——推送通知插件会为您提供这些。您只需要将 Firebase 项目的 google-services.json 文件添加到应用的模块（应用级）目录中。

变量

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

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

推送通知图标

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

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

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

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

前台推送通知显示

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

属性	类型	描述	起始版本
`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('注册令牌: ', token.value);
  });

  await PushNotifications.addListener('registrationError', err => {
    console.error('注册错误: ', err.error);
  });

  await PushNotifications.addListener('pushNotificationReceived', notification => {
    console.log('收到推送通知: ', notification);
  });

  await PushNotifications.addListener('pushNotificationActionPerformed', notification => {
    console.log('推送通知操作已执行', 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('用户拒绝了权限！');
  }

  await PushNotifications.register();
}

const getDeliveredNotifications = async () => {
  const notificationList = await PushNotifications.getDeliveredNotifications();
  console.log('已投递的通知', notificationList);
}

API

register()
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

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 上，状态始终为已授予（granted），因为您始终可以接收推送通知。如果您需要检查用户是否允许显示通知，请使用 local-notifications 插件。

返回：

Promise<PermissionStatus>

起始版本： 1.0.0

requestPermissions()

requestPermissions() => Promise<PermissionStatus>

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

在 Android 上，它不会提示授权，因为您始终可以接收推送通知。

在 iOS 上，第一次使用此函数时，它将提示用户授予推送通知权限，并根据用户选择返回 granted 或 denied。后续调用将获取权限的当前状态而不会再次提示。

返回：

Promise<PermissionStatus>

起始版本： 1.0.0

addListener('registration', ...)

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

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

提供推送通知令牌。

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

返回：

Promise<PluginListenerHandle> & PluginListenerHandle

起始版本： 1.0.0

addListener('registrationError', ...)

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

当推送通知注册出错时调用。

提供包含注册问题的错误信息。

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

返回：

Promise<PluginListenerHandle> & PluginListenerHandle

起始版本： 1.0.0

addListener('pushNotificationReceived', ...)

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

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

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

返回：

Promise<PluginListenerHandle> & PluginListenerHandle

起始版本： 1.0.0

addListener('pushNotificationActionPerformed', ...)

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

当在推送通知上执行操作时调用。

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

返回：

Promise<PluginListenerHandle> & 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`	在通知上执行的操作。	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()​

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()

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