Firebase Cloud Messaging (FCM)。
函数
| 函数 | 说明 |
|---|---|
| getMessaging(应用) | 获取默认应用或指定应用的 Messaging 服务。无需任何参数即可调用 admin.messaging() 以访问默认应用的 Messaging 服务，或以 admin.messaging(app) 的形式调用与特定应用关联的 Messaging 服务。 |
类
| 类 | 说明 |
|---|---|
| FirebaseMessagingError | Firebase Messaging 错误代码结构。这会扩展 PrefixedFirebaseError。 |
| 消息传送 | 绑定到提供的应用的通讯服务。 |
| MessagingClientErrorCode | 消息传递客户端错误代码及其默认消息。 |
接口
| 接口 | 说明 |
|---|---|
| AndroidConfig | 表示可包含在 Message 中的 Android 专用选项。 |
| AndroidFcmOptions | 表示 FCM SDK for Android 所提供功能的选项。 |
| Android 通知 | 表示可包含在 AndroidConfig 中的 Android 专用通知选项。 |
| ApnsConfig | 表示可包含在 Message 中的 APNs 专用选项。有关 APNs 支持的各种标头和载荷字段，请参阅 Apple 文档。 |
| ApnsFcmOptions | 表示适用于 iOS 的 FCM SDK 所提供功能的选项。 |
| ApnsPayload | 表示 APNs 消息的载荷。主要由 aps 字典组成。但还可能包含其他任意自定义键。 |
| Aps | 表示作为 APNs 消息一部分的 aps 字典。 |
| ApsAlert 发出通知 | |
| BaseMessage | |
| BatchResponse | 表示来自 Messaging.sendAll() 和 Messaging.sendMulticast() 方法的服务器响应的接口。 |
| ConditionMessage | |
| SensitiveSound | 表示可包含在 APNs 载荷的 aps 字典中的关键声音配置。 |
| DataMessagePayload | 表示 FCM 旧版 API 数据消息载荷的接口。数据消息可让开发者发送不超过 4KB 的自定义键值对。键和值都必须是字符串。键可以是任何自定义字符串，但以下预留字符串除外：
|
| FcmOptions | 表示 FCM SDK 所提供功能与平台无关的选项。 |
| LightSettings | 表示用于控制可包含在 AndroidNotification 中的通知 LED 的设置。 |
| MessagingConditionResponse | 表示来自旧版 Messaging.sendToCondition() 方法的服务器响应的接口。如需查看代码示例和详细文档，请参阅发送到条件。 |
| MessagingDeviceGroupResponse | 表示来自 Messaging.sendToDeviceGroup() 方法的服务器响应的接口。如需查看代码示例和详细文档，请参阅向设备组发送消息。 |
| MessagingDeviceResult | 来自单个设备的各个状态响应载荷 |
| MessagingDevicesResponse | 此接口表示通过 FCM 旧版 API 向单个设备发送消息的状态。如需查看代码示例和详细文档，请参阅发送到单个设备。 |
| MessagingOptions | 此接口表示通过 FCM 旧版 API 发送消息时可提供的选项。如需查看代码示例和详细文档，请参阅构建发送请求。 |
| Messaging 载荷 | 表示 Firebase Cloud Messaging 消息载荷的接口。必须提供 data 和 notification 键中的一个或两个。如需查看代码示例和详细文档，请参阅构建发送请求。 |
| MessagingTopicManagementResponse | 表示来自 Messaging.subscribeToTopic() 和 Messaging.unsubscribeFromTopic() 方法的服务器响应的接口。如需查看代码示例和详细文档，请参阅从服务器管理主题。 |
| MessagingTopicResponse | 表示来自旧版 Messaging.sendToTopic() 方法的服务器响应的接口。如需查看代码示例和详细文档，请参阅发送到主题。 |
| MulticastMessage | Messaging.sendMulticast() 方法的负载。载荷包含 BaseMessage 类型中的所有字段以及令牌列表。 |
| 通知 | 可以包含在消息 中的通知。 |
| NotificationMessagePayload | 表示 FCM 旧版 API 通知消息载荷的接口。开发者可通过通知消息发送不超过 4KB 的预定义键值对。下面列出了可接受的键。如需查看代码示例和详细文档，请参阅构建发送请求。 |
| SendResponse | 表示作为批处理请求的一部分发送的单个消息的状态的界面。 |
| TokenMessage | |
| TopicMessage | |
| WebpushConfig | 表示可包含在 Message 中的 WebPush 协议选项。 |
| WebpushFcmOptions | 表示适用于 Web 的 FCM SDK（不属于 Webpush 标准的一部分）所提供功能的选项。 |
| WebpushNotification | 表示可包含在 WebpushConfig 中的 WebPush 专用通知选项。它支持网络通知规范中定义的大多数标准选项。 |
类型别名
| 类型别名 | 说明 |
|---|---|
| 短信 | Messaging.send() 操作的负载。载荷包含 BaseMessage 类型中的所有字段，且只包括令牌、主题或条件中的一个。 |
getMessaging(应用)
获取默认应用或指定应用的 Messaging 服务。
可以在不使用任何参数的情况下调用 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;