电源火库云通讯插件

非官方电容插件 火地云通讯[^1]

使用大小写

Firebase Cloud Message 插件通常用于与用户接触并重新接触,并使用按键通知,例如:

• 推动通知:将新内容,消息,或报价通知用户,即使应用程序不在前台.
• 基于主题的信息:让用户订阅新闻类等专题,并同时向某一专题的所有订阅者发送信息.
• 设备瞄准: 获取设备的FCM令牌,向特定用户或设备发送推取消息.
• 背景数据同步: 接收背景中的数据驱动通知以保持应用程序内容的更新.
• 通知管理: 列出、删除或清除通知屏幕上可见的通知.

兼容性

指南

• 电容推进通知指南
• 如何在电容App中使用火把:从推动通知到分析与崩溃报告——一个指南中的每个Firebase插件.

安装

你可以用我们的 AI 辅助设置 以安装插件. 添加数据 超级技能 至您的 AI 工具,使用以下命令:

npx skills add capawesome-team/skills --skill capacitor-plugins

然后使用下列提示:

Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-firebase/messaging` plugin in my project.

如果你喜欢 手动设置,通过运行以下命令来安装插件,并遵循下面的平台特定指令:

npm install @capacitor-firebase/messaging firebase
npx cap sync

如果您还没有将 Firebase 添加到您的项目中(机器人 编号 : iOS系统 编号 : 网页) (中文(简体) ).

机器人

变量

如果需要, 您可以在您的应用程序中定义以下工程变量 variables.gradle 要更改依赖的默认版本的文件 :

• $firebaseMessagingVersion 版本 com.google.firebase:firebase-messaging (默认 : 25.0.1(中文(简体) )

如果您在工程中遇到其它插件的依赖性冲突, 这会有所帮助 .

按下通知图标

带有相应名称的 Push 通知图标应添加到 android/app/src/main/AndroidManifest.xml 文件 :

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

如果没有指定图标,Android会使用应用程序图标,但推出图标应该在透明背景上为白色像素. 由于应用程序图标通常不像这样外观,它显示一个白色正方形或圆形. 因此,建议为推进通知提供一个单独的图标.

防止自动初始化

当生成注册符后,库会将标识符和配置数据上传至Firebase. 如果您更喜欢防止符号自动生成, 请通过将这些元数据值添加到 android/app/src/main/AndroidManifest.xml 文件 :

<meta-data
    android:name="firebase_messaging_auto_init_enabled"
    android:value="false" />
<meta-data
    android:name="firebase_analytics_collection_enabled"
    android:value="false" />

iOS系统

Swift 软件包管理器

在您的 capacitor.config.json (或 capacitor.config.ts) 避免 SwiftPM 软件包识别相撞数字 :

{
  "experimental": {
    "ios": {
      "spm": {
        "packageOptions": {
          "@capacitor-firebase/messaging": {
            "symlink": true
          }
        }
      }
    }
  }
}

请注意目标 packageOptions 支持需要控制器 CLI 8.4.0+ (中文(简体) )。 。 。 .

设置

重要: 确保没有安装其他 Capacitor Push 通知插件(参见 这里) (中文(简体) ).

见 先决条件 并首先完成先决条件.

见 上传 APNS 证书或密钥到 Firebase 并遵循将 APNS 证书或 APNS Auth 密钥上传至 Firebase 的指令.

如果您对指令有困难,您也可以查看其中的相应章节 本指南。 。 。 .

在您的应用程序中添加以下内容 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)
}

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
    NotificationCenter.default.post(name: Notification.Name.init("didReceiveRemoteNotification"), object: completionHandler, userInfo: userInfo)
}

请注意: 如果您结合使用此插件 @capacitor-firebase/authentication,然后在应用程序中添加以下内容: AppDelegate.swift数字 :

+ import FirebaseAuth

func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
+    if Auth.auth().canHandle(url) {
+      return true
+    }
    return ApplicationDelegateProxy.shared.application(app, open: url, options: options)
}

防止自动初始化

当生成注册符后,库会将标识符和配置数据上传至Firebase. 如果您喜欢防止符号自动生成, 请编辑您的 FCM 自动初始化 ios/App/App/Info.plist 设置 FirebaseMessagingAutoInitEnabled 键到 NO。 。 。 .

网页

1. 见 用 FCM 配置网络证书 并遵守正确配置您网络证书的指令.
2. 添加一个 firebase-messaging-sw.js 文件到域名的根。 如果您不想在背景中收到按键通知, 此文件可能为空 . 见 在服务人员中设定通知选项 更多信息.

配置

在 iOS 上, 您可以配置当应用程序处于前景时, 如何显示按键通知 .

实例

单位 capacitor.config.json数字 :

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

单位 capacitor.config.ts数字 :

/// <reference types="@capacitor-firebase/messaging" />

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

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

export default config;

演示

这里有一个实例: robingenz/电容器-火力基地-插座-demo

启动模板

以下启动模板可供使用:

• 角起火点

使用量

以下例子说明如何检查和请求通知权限、管理FCM令牌、倾听收到的通知及其行动、订阅专题和管理已发送的通知.

检查和请求权限

检查并请求允许接收推出通知 。 在Android上,这些方法只需要调用Android 13+:

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

const checkPermissions = async () => {
  const result = await FirebaseMessaging.checkPermissions();
  return result.receive;
};

const requestPermissions = async () => {
  const result = await FirebaseMessaging.requestPermissions();
  return result.receive;
};

获取或删除 FCM 令牌

注册应用程序以接收推取通知并取回可用于向设备发送推取消息的 FCM 令牌. 删除指使符,例如当一个用户签名退出时,以停止接收按键通知. 当您收到使用 tokenReceived 事件,仅可在Android和iOS上获取:

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

const getToken = async () => {
  const result = await FirebaseMessaging.getToken();
  return result.token;
};

const deleteToken = async () => {
  await FirebaseMessaging.deleteToken();
};

const addTokenReceivedListener = async () => {
  await FirebaseMessaging.addListener('tokenReceived', event => {
    console.log('tokenReceived', { event });
  });
};

收听收到的按键通知

收到催促通知后予以通知。 如果应用程序在背景中,这个收听器只用于Android上的数据推取通知和iOS上无声推取通知:

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

const addNotificationReceivedListener = async () => {
  await FirebaseMessaging.addListener('notificationReceived', event => {
    console.log('notificationReceived', { event });
  });
};

对通知行动的反应

在按推器通知采取行动时,例如用户点击时,应通知。 仅在Android和iOS上提供:

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

const addNotificationActionPerformedListener = async () => {
  await FirebaseMessaging.addListener('notificationActionPerformed', event => {
    console.log('notificationActionPerformed', { event });
  });
};

订阅主题

订阅或不订阅一个主题,以接收发送到该主题的按键信息。 仅在Android和iOS上提供:

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

const subscribeToTopic = async () => {
  await FirebaseMessaging.subscribeToTopic({ topic: 'news' });
};

const unsubscribeFromTopic = async () => {
  await FirebaseMessaging.unsubscribeFromTopic({ topic: 'news' });
};

管理已送达的通知

获取、删除或清除目前在通知屏幕上可见的通知 :

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

const getDeliveredNotifications = async () => {
  const result = await FirebaseMessaging.getDeliveredNotifications();
  return result.notifications;
};

const removeDeliveredNotifications = async () => {
  await FirebaseMessaging.removeDeliveredNotifications({
    notifications: [
      {
        id: '798dfhliblqew89pzads',
      },
    ],
  });
};

const removeAllDeliveredNotifications = async () => {
  await FirebaseMessaging.removeAllDeliveredNotifications();
};

删除所有听众

删除所有为此插件添加的听众 :

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

const removeAllListeners = async () => {
  await FirebaseMessaging.removeAllListeners();
};

API 密码

• checkPermissions()
• requestPermissions()
• isSupported()
• getToken(...)
• deleteToken()
• getDeliveredNotifications()
• removeDeliveredNotifications(...)
• removeAllDeliveredNotifications()
• subscribeToTopic(...)
• unsubscribeFromTopic(...)
• createChannel(...)
• deleteChannel(...)
• listChannels()
• addListener('tokenReceived', ...)
• addListener('notificationReceived', ...)
• addListener('notificationActionPerformed', ...)
• addListener('apnsTokenReceived', ...)
• removeAllListeners()
• 接口
• 类型异名
• 数字

检查( )

checkPermissions() => Promise<PermissionStatus>

请检查date=中的日期值 (帮助) .

打开 机器人,这种方法只需要调用Android 13+.

回返情况: Promise<PermissionStatus>

自: 0.2.2 (中文(简体) )

请求( )

requestPermissions() => Promise<PermissionStatus>

请求允许接收按压通知 .

打开 机器人,这种方法只需要调用Android 13+.

回返情况: Promise<PermissionStatus>

自: 0.2.2 (中文(简体) )

已支持 ()

isSupported() => Promise<IsSupportedResult>

检查所有需要的API是否存在 .

总是返回 true (原始内容存档于2019-10-12). Android and iOS.

回返情况: Promise<IsSupportedResult>

自: 0.3.1 (中文(简体) )

获取托肯(...)

getToken(options?: GetTokenOptions | undefined) => Promise<GetTokenResult>

注册应用程序以接收按下通知 . 返回一个 FCM 令牌, 该令牌可用于向 Message 实例发送按键消息 .

这种方法还可以重新使用FCM自動活化.

回返情况: Promise<GetTokenResult>

自: 0.2.2 (中文(简体) )

删除 Token ()

deleteToken() => Promise<void>

删除 FCM 令牌并取消该应用程序的注册, 以停止接收按键通知 . 例如,当用户签名退出时,可以调用.

自: 0.2.2 (中文(简体) )

获得交付通知( )

getDeliveredNotifications() => Promise<GetDeliveredNotificationsResult>

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

说明: 这将退回所有已送达的通知,包括当地通知,而不仅仅是联邦管理通知.

关于Android,FCM通知的数据字段将不包含.

回返情况: Promise<GetDeliveredNotificationsResult>

自: 0.2.2 (中文(简体) )

删除已交付通知(...)

removeDeliveredNotifications(options: RemoveDeliveredNotificationsOptions) => Promise<void>

从通知屏幕上删除特定通知 .

自: 0.2.2 (中文(简体) )

删除所有已交付通知( )

removeAllDeliveredNotifications() => Promise<void>

从通知屏幕上删除所有通知 .

说明: 这将删除所有已发送的通知,包括当地通知,而不只是联邦管理通知.

自: 0.2.2 (中文(简体) )

订阅TOTOPIC(...)

subscribeToTopic(options: SubscribeToTopicOptions) => Promise<void>

订阅背景主题 .

仅供Android和iOS使用.

自: 0.2.2 (中文(简体) )

从Topic(...) 取消订阅

unsubscribeFromTopic(options: UnsubscribeFromTopicOptions) => Promise<void>

在背景中不订阅主题 .

仅供Android和iOS使用.

自: 0.2.2 (中文(简体) )

创建频道(...)

createChannel(options: CreateChannelOptions) => Promise<void>

创建通知通道 .

仅供Android(SDK 26+)使用.

自: 1.4.0 (中文(简体) )

删除频道(...)

deleteChannel(options: DeleteChannelOptions) => Promise<void>

删除通知频道.

仅供Android(SDK 26+)使用.

自: 1.4.0 (中文(简体) )

列表频道( )

listChannels() => Promise<ListChannelsResult>

列出可用的通知渠道.

仅供Android(SDK 26+)使用.

回返情况: Promise<ListChannelsResult>

自: 1.4.0 (中文(简体) )

添加收听器( 'token reading',...)

addListener(eventName: 'tokenReceived', listenerFunc: TokenReceivedListener) => Promise<PluginListenerHandle>

收到新的 FCM 令牌后调用 .

仅供Android和iOS使用.

回返情况: Promise<PluginListenerHandle>

自: 0.2.2 (中文(简体) )

添加倾听器( 通知已收到,...)

addListener(eventName: 'notificationReceived', listenerFunc: NotificationReceivedListener) => Promise<PluginListenerHandle>

接到新的催促通知后打电话.

打开 机器人如果应用程序在 前景。 。 。 . 如果应用程序在 背景情况,那么这个收听器只被调用到数据驱动通知上. 见 https://firebase.google.com/docs/cloud-message/android/receive# 处理 messages (英语) 更多信息.

打开 iOS系统如果应用程序在 前景。 。 。 . 如果应用程序在 背景情况,那么这个收听器只被叫作无声的按键通知(与 content-available ) (中文(简体) ). 见 https://developer.apple.com/library/archive/documentation/Networking Internet/Conceptual/Remote NotificationsPG/PayloadKeyReference.html 互联网档案馆的存檔,存档日期2013-12-02 更多信息.

回返情况: Promise<PluginListenerHandle>

自: 0.2.2 (中文(简体) )

添加倾听器( “ 通知动作已执行 ” ,...)

addListener(eventName: 'notificationActionPerformed', listenerFunc: NotificationActionPerformedListener) => Promise<PluginListenerHandle>

执行新的推动通知行动时呼叫.

仅供Android和iOS使用.

回返情况: Promise<PluginListenerHandle>

自: 0.2.2 (中文(简体) )

添加倾听器( “ apnsTokenreaived ” ,...)

addListener(eventName: 'apnsTokenReceived', listenerFunc: ApnsTokenReceivedListener) => Promise<PluginListenerHandle>

收到APNs的令牌后调用.

仅供iOS使用.

回返情况: Promise<PluginListenerHandle>

自: 8.2.0 (中文(简体) )

删除所有收听器( )

removeAllListeners() => Promise<void>

删除此插件的所有听众 .

自: 0.2.2 (中文(简体) )

接口

权限状态

支持的结果

获取托肯结果

获取托肯选项

获取交付通知

通知

删除已交付通知选项

订阅选项

取消从选项订阅

频道

删除频道选项

ListChannels 结果

插件听筒

收件活动

通知 收到活动

通知动作已执行

Apns 接收事件

类型异名

权限状态

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

创建频道选项

Channel

已接收 听众

召回以接收收到的指使事件 .

(event: TokenReceivedEvent): void

通知 实收 听众

召回收到通知的事件.

(event: NotificationReceivedEvent): void

通知动作已执行

召回接收已执行的通知动作事件 .

(event: NotificationActionPerformedEvent): void

已接收 听众

召回接收APNs所收到事件.

(event: ApnsTokenReceivedEvent): void

数字

重要性

可见度

财务问题

Capacitor Firebase Cloud 消息插件和Capacitor Push通知插件有什么区别??

这个 推进通知 插件支持Android(FCM)和iOS(APNs). 另一方面,Capacitor Firebase Cloud 消息插件则使用 Firebase SDK 用于 机器人, (中文(简体) ), iOS系统 财务报告和审定财务报表 网页 并提供其他功能,如主题订阅和在前场接收通知的能力.

为什么 notificationReceived 应用程序在后台时不打电话吗?

这是基础平台的预期行为. 在Android上,仅当应用程序处于前台时,就要求收听者发出每次推取通知. 如果该应用程序处于后台,则仅用于数据推取通知. 在iOS上,听众仅在背景中被调用为无声的按键通知,这些是带有: content-available 键.

为什么我在Android上的推力通知图标是白方块?

Android预计推取通知图标由透明背景上白色像素组成. 如果未指定专用图标,Android会倒回应用程序图标,通常不符合这一要求,因此被显示为白色正方形或圆形. 按 安装 节.

我在收到推车通知前需要请求许可吗?

是的,用那个 checkPermissions() 财务报告和审定财务报表 requestPermissions() 检查和请求允许接收按键通知的方法,如 使用示例 见上文。 在Android上,这些方法只需要被调用到Android 13+上.

相关插件

• Firebase 验证:在用户中以 Firebase 认证签名.
• 火场分析: 记录带有Firebase分析器的事件和用户属性.
• 徽标: 访问并更新应用程序图标的徽标编号.

通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 《卡帕索克通讯》。 。 。 .

更改日志

见 变动情况。 。 。 .

许可证

见 自由主义。 。 。 .

[^1]: 这个项目不附属于Google LLC或其任何子公司或子公司,也不获得其认可、支持、赞助或批准.