指南
如何在 Capacitor 中使用 Firebase 消息
使用@capgo/capacitor-firebase-messaging
Capacitor插件用于Firebase Cloud Messaging (FCM).
安装
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令牌,可以用来向该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令牌,可以用来向该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令牌并注销应用程序以停止接收推送通知。可以在用户注销时调用。
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() 以清除所有监听器。
完整参考
继续使用@capgo/capacitor-firebase-messaging
如果您正在使用 使用@capgo/capacitor-firebase-messaging 为native插件工作制定计划,连接它到 Capgo插件目录 在Capgo插件目录中 Capacitor由Capgo 在Capacitor由Capgo中 添加或更新插件 在添加或更新插件中 Ionic 企业插件替代方案 为 Ionic 企业插件替代方案中的产品工作流程 Capgo 本机构建 为 Capgo 本机构建中的产品工作流程