firebase-admin.messaging package

Firebase 云消息传递 (FCM)。

功能

功能描述
获取消息(应用程序)获取默认应用程序或给定应用程序的消息传递服务。可以不带任何参数调用admin.messaging()来访问默认应用程序的Messaging服务,或者作为admin.messaging(app)来访问与特定应用程序关联的Messaging服务。

课程

班级描述
消息传递消息服务绑定到所提供的应用程序。

接口

界面描述
Android配置表示可以包含在消息中的 Android 特定选项
AndroidFcm选项表示适用于 Android 的 FCM SDK 提供的功能选项。
Android通知表示可以包含在AndroidConfig中的 Android 特定通知选项
Apns配置表示可以包含在消息中的 APN 特定选项。有关 APN 支持的各种标头和有效负载字段,请参阅Apple 文档
ApnsFcm选项表示适用于 iOS 的 FCM SDK 提供的功能选项。
Apns有效负载表示 APNs 消息的负载。主要由aps字典组成。但也可能包含其他任意自定义键。
阿普斯表示属于 APNs 消息一部分的aps 字典
Aps警报
基本消息
批量响应表示来自Messaging.sendAll()Messaging.sendMulticast()方法的服务器响应的接口。
条件消息
批判声音表示可包含在 APNs 有效负载的aps字典中的关键声音配置。
数据消息有效负载表示 FCM 旧版 API 数据消息有效负载的接口。数据消息允许开发人员发送最多 4KB 的自定义键值对。键和值必须都是字符串。键可以是任何自定义字符串,但以下保留字符串除外:
  • from
  • 一切以google.
请参阅构建发送请求以获取代码示例和详细文档。
Fcm选项表示 FCM SDK 提供的功能的独立于平台的选项。
灯光设置表示控制可包含在AndroidNotification中的通知 LED 的设置
消息条件响应表示来自旧版Messaging.sendToCondition()方法的服务器响应的接口。请参阅发送到条件以获取代码示例和详细文档。
消息设备组响应表示来自Messaging.sendToDeviceGroup()方法的服务器响应的接口。请参阅向设备组发送消息以获取代码示例和详细文档。
消息设备结果来自单个设备的单独状态响应负载
消息传递设备响应表示通过 FCM 旧版 API 发送到单个设备的消息状态的接口。请参阅发送到各个设备以获取代码示例和详细文档。
消息选项表示通过 FCM 旧版 API 发送消息时可以提供的选项的接口。请参阅构建发送请求以获取代码示例和详细文档。
消息有效负载表示 Firebase Cloud Messaging 消息负载的接口。需要datanotification密钥之一或两者。请参阅构建发送请求以获取代码示例和详细文档。
消息传递主题管理响应表示来自Messaging.subscribeToTopic()Messaging.unsubscribeFromTopic()方法的服务器响应的接口。请参阅从服务器管理主题以获取代码示例和详细文档。
消息主题响应表示来自旧Messaging.sendToTopic()方法的服务器响应的接口。请参阅发送到主题以获取代码示例和详细文档。
组播消息Messaging.sendMulticast()方法的负载。有效负载包含 BaseMessage 类型中的所有字段以及令牌列表。
通知可包含在消息中的通知
通知消息负载表示 FCM 旧版 API 通知消息负载的接口。通知消息允许开发人员发送最多 4KB 的预定义键值对。接受的密钥概述如下。请参阅构建发送请求以获取代码示例和详细文档。
发送响应表示作为批量请求的一部分发送的单个消息的状态的接口。
令牌消息
主题留言
Webpush配置表示可以包含在消息中的 WebPush 协议选项
WebpushFcm选项表示 FCM SDK for Web 提供的功能选项(不属于 Webpush 标准的一部分)。
网页推送通知表示可以包含在WebpushConfig中的特定于 WebPush 的通知选项。这支持 Web 通知规范中定义的大多数标准选项

类型别名

类型别名描述
信息Messaging.send()操作的有效负载。有效负载包含 BaseMessage 类型中的所有字段,并且恰好是令牌、主题或条件之一。

获取消息传递()

获取默认应用程序或给定应用程序的消息传递服务。

可以不带任何参数调用admin.messaging()来访问默认应用程序的Messaging服务,或者作为admin.messaging(app)来访问与特定应用程序关联的Messaging服务。

签名:

export declare function getMessaging(app?: App): Messaging;

参数

范围类型描述
应用程序应用程序返回其Messaging服务的可选应用程序。如果未提供,将返回默认的Messaging服务。

返回:

消息传递

默认Messaging服务(如果未提供应用程序)或与所提供的应用程序关联的Messaging服务。

实施例1

// Get the Messaging service for the default app
const defaultMessaging = getMessaging();

实施例2

// Get the Messaging service for a given app
const otherMessaging = getMessaging(otherApp);

信息

Messaging.send()操作的有效负载。有效负载包含 BaseMessage 类型中的所有字段,并且恰好是令牌、主题或条件之一。

签名:

export type Message = TokenMessage | TopicMessage | ConditionMessage;