Firebase Messaging Capacitor 插件

使用 @capgo/capacitor-firebase-messaging

用于 Firebase Cloud Messaging (FCM) 的 Capacitor 插件

安装

bun add @capgo/capacitor-firebase-messaging
bunx cap sync

bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。

导入

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

API 概览

方法	描述
checkPermissions	检查接收推送通知的权限。
requestPermissions	请求接收推送通知的权限。
isSupported	检查所有必需的 API 是否存在。
getToken	注册应用以接收推送通知。返回一个 FCM token，可用于向该 Messaging 实例发送推送消息。
deleteToken	删除 FCM token 并取消注册应用，以停止接收推送通知。例如，可以在用户登出时调用。
getDeliveredNotifications	获取通知栏中可见的通知列表。
removeDeliveredNotifications	从通知栏中移除指定通知。
removeAllDeliveredNotifications	从通知栏中移除所有通知。
subscribeToTopic	在后台订阅主题。
unsubscribeFromTopic	在后台取消订阅主题。
createChannel	创建一个通知渠道。
deleteChannel	删除一个通知渠道。
listChannels	列出所有可用的通知渠道。

示例

checkPermissions()

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

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.checkPermissions();
console.log(result);

requestPermissions()

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

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.requestPermissions();
console.log(result);

isSupported()

检查所有必需的 API 是否存在。

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.isSupported();
console.log(result);

getToken()

注册应用以接收推送通知。返回一个 FCM token，可用于向该 Messaging 实例发送推送消息。

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.getToken();
// The result holds sensitive values: use it without logging it.

deleteToken()

删除 FCM token 并取消注册应用，以停止接收推送通知。例如，可以在用户登出时调用。

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

await FirebaseMessaging.deleteToken();

getDeliveredNotifications()

获取通知栏中可见的通知列表。

import { FirebaseMessaging } from '@capgo/capacitor-firebase-messaging';

const result = await FirebaseMessaging.getDeliveredNotifications();
console.log(result);

上表列出了 13 个核心方法。监听器、版本辅助函数以及每个方法的完整约定，请参阅 GitHub 仓库.

监听事件

addListener 会返回一个句柄。调用 handle.remove() 在屏幕卸载时，或者调用 FirebaseMessaging.removeAllListeners() 以清除所有监听器。

完整参考文档

• GitHub 仓库
• 文档
• API 参考文档

从“使用 @capgo/capacitor-firebase-messaging”继续

如果你正在使用 使用 @capgo/capacitor-firebase-messaging 要规划原生插件工作，请将其与 Capgo 插件目录 查看 Capgo 插件目录中的产品工作流， Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节， 添加或更新插件 查看添加或更新插件中的实现细节， Ionic Enterprise 插件替代方案 查看 Ionic Enterprise 插件替代方案中的产品工作流，以及 Capgo Native Build 查看 Capgo Native Builds 中的产品工作流。