消息服务绑定到所提供的应用程序。
签名:
export declare class Messaging
特性
财产 | 修饰符 | 类型 | 描述 |
---|---|---|---|
应用程序 | 应用程序 | 与当前Messaging 服务实例关联的应用程序。 |
方法
方法 | 修饰符 | 描述 |
---|---|---|
发送(消息,dryRun) | 通过 FCM 发送给定消息。 | |
发送全部(消息,dryRun) | 通过 Firebase Cloud Messaging 发送给定数组中的所有消息。采用批处理将整个列表作为单个 RPC 调用发送。与send() 方法相比,此方法是发送多条消息的更有效的方法。从返回值获得的响应列表对应于MulticastMessage 中的标记顺序。此方法的错误表示完全失败,这意味着列表中的任何消息都无法发送。部分失败由BatchResponse 返回值指示。 | |
sendEach(消息,dryRun) | 通过 Firebase Cloud Messaging 发送给定数组中的每条消息。与Messaging.sendAll()不同,此方法对给定数组中的每条消息进行一次 RPC 调用。从返回值中获得的响应列表与messages 的顺序相对应。此方法的错误或全部失败的BatchResponse 表示完全失败,这意味着列表中的任何消息都无法发送。部分失败或无失败仅由BatchResponse 返回值指示。 | |
sendEachForMulticast(消息,dryRun) | 将给定的多播消息发送到其中指定的所有 FCM 注册令牌。此方法在底层使用Messaging.sendEach() API 将给定消息发送给所有目标收件人。从返回值获得的响应列表对应于MulticastMessage 中的标记顺序。此方法中的错误或包含所有失败的BatchResponse 表示完全失败,这意味着可以发送列表中的消息。部分失败或失败仅由BatchResponse 返回值指示。 | |
发送多播(消息,dryRun) | 将给定的多播消息发送到其中指定的所有 FCM 注册令牌。此方法在底层使用sendAll() API 将给定消息发送给所有目标收件人。从返回值获得的响应列表对应于MulticastMessage 中的标记顺序。此方法的错误表示完全失败,这意味着消息未发送到列表中的任何令牌。部分失败由BatchResponse 返回值指示。 | |
sendToCondition(条件,有效负载,选项) | 向条件发送 FCM 消息。请参阅发送到条件以获取代码示例和详细文档。 | |
sendToDevice(registrationTokenOrTokens,有效负载,选项) | 将 FCM 消息发送到与所提供的注册令牌相对应的单个设备。请参阅发送到各个设备以获取代码示例和详细文档。接受一个registrationToken 发送到单个设备,或者接受一个包含令牌数组的registrationTokens 参数发送到多个设备。 | |
sendToDeviceGroup(通知密钥、有效负载、选项) | 将 FCM 消息发送到与提供的通知密钥对应的设备组。请参阅发送到设备组以获取代码示例和详细文档。 | |
sendToTopic(主题,有效负载,选项) | 向主题发送 FCM 消息。请参阅发送到主题以获取代码示例和详细文档。 | |
subscribeToTopic(registrationTokenOrTokens,主题) | 为设备订阅 FCM 主题。请参阅订阅主题以获取代码示例和详细文档。或者,您可以提供一系列令牌来订阅多个设备。 | |
取消订阅主题(registrationTokenOrTokens,主题) | 取消设备对 FCM 主题的订阅。请参阅取消订阅主题以获取代码示例和详细文档。或者,您可以提供一系列令牌来取消订阅多个设备。 |
消息传递.app
与当前Messaging
服务实例关联的应用程序。
签名:
get app(): App;
例子
var app = messaging.app;
消息传递.send()
通过 FCM 发送给定消息。
签名:
send(message: Message, dryRun?: boolean): Promise<string>;
参数
范围 | 类型 | 描述 |
---|---|---|
信息 | 信息 | 消息有效负载。 |
干运行 | 布尔值 | 是否以试运行(仅验证)模式发送消息。 |
返回:
承诺<字符串>
在消息成功移交给 FCM 服务进行传递后,通过唯一的消息 ID 字符串履行承诺。
消息传递.sendAll()
请改用Messaging.sendEach() 。
通过 Firebase Cloud Messaging 发送给定数组中的所有消息。采用批处理将整个列表作为单个 RPC 调用发送。与send()
方法相比,此方法是发送多条消息的更有效的方法。
从返回值中获取的响应列表与MulticastMessage
中的标记顺序相对应。此方法的错误表示完全失败,这意味着列表中的任何消息都无法发送。部分失败由BatchResponse
返回值指示。
签名:
sendAll(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
参数
范围 | 类型 | 描述 |
---|---|---|
消息 | 信息[] | 最多包含 500 条消息的非空数组。 |
干运行 | 布尔值 | 是否以试运行(仅验证)模式发送消息。 |
返回:
Promise<批量响应>
用表示发送操作结果的对象来实现的 Promise。
消息传递.sendEach()
通过 Firebase Cloud Messaging 发送给定数组中的每条消息。
与Messaging.sendAll()不同,此方法对给定数组中的每条消息进行一次 RPC 调用。
从返回值得到的响应列表对应messages
的顺序。此方法的错误或全部失败的BatchResponse
表示完全失败,这意味着列表中的任何消息都无法发送。部分失败或无失败仅由BatchResponse
返回值指示。
签名:
sendEach(messages: Message[], dryRun?: boolean): Promise<BatchResponse>;
参数
范围 | 类型 | 描述 |
---|---|---|
消息 | 信息[] | 最多包含 500 条消息的非空数组。 |
干运行 | 布尔值 | 是否以试运行(仅验证)模式发送消息。 |
返回:
Promise<批量响应>
用表示发送操作结果的对象来实现的 Promise。
消息传递.sendEachForMulticast()
将给定的多播消息发送到其中指定的所有 FCM 注册令牌。
此方法在底层使用Messaging.sendEach() API 将给定消息发送给所有目标收件人。从返回值中获取的响应列表与MulticastMessage
中的标记顺序相对应。此方法中的错误或包含所有失败的BatchResponse
表示完全失败,这意味着可以发送列表中的消息。部分失败或失败仅由BatchResponse
返回值指示。
签名:
sendEachForMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
参数
范围 | 类型 | 描述 |
---|---|---|
信息 | 组播消息 | 最多包含 500 个令牌的多播消息。 |
干运行 | 布尔值 | 是否以试运行(仅验证)模式发送消息。 |
返回:
Promise<批量响应>
用表示发送操作结果的对象来实现的 Promise。
消息传递.sendMulticast()
将给定的多播消息发送到其中指定的所有 FCM 注册令牌。
此方法在底层使用sendAll()
API 将给定消息发送给所有目标收件人。从返回值中获取的响应列表与MulticastMessage
中的标记顺序相对应。此方法的错误表示完全失败,这意味着消息未发送到列表中的任何令牌。部分失败由BatchResponse
返回值指示。
签名:
sendMulticast(message: MulticastMessage, dryRun?: boolean): Promise<BatchResponse>;
参数
范围 | 类型 | 描述 |
---|---|---|
信息 | 组播消息 | 最多包含 500 个令牌的多播消息。 |
干运行 | 布尔值 | 是否以试运行(仅验证)模式发送消息。 |
返回:
Promise<批量响应>
用表示发送操作结果的对象来实现的 Promise。
消息传递.sendToCondition()
向条件发送 FCM 消息。
请参阅发送到条件以获取代码示例和详细文档。
签名:
sendToCondition(condition: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingConditionResponse>;
参数
范围 | 类型 | 描述 |
---|---|---|
状况 | 细绳 | 确定将消息发送到哪些主题的条件。 |
有效负载 | 消息有效负载 | 消息有效负载。 |
选项 | 消息选项 | 用于更改消息的可选选项。 |
返回:
Promise<消息条件响应>
消息发送后服务器响应履行的承诺。
消息传递.sendToDevice()
请改用Messaging.send() 。
将 FCM 消息发送到与所提供的注册令牌相对应的单个设备。
请参阅发送到各个设备以获取代码示例和详细文档。接受一个registrationToken
发送到单个设备,或者接受一个包含令牌数组的registrationTokens
参数发送到多个设备。
签名:
sendToDevice(registrationTokenOrTokens: string | string[], payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDevicesResponse>;
参数
范围 | 类型 | 描述 |
---|---|---|
注册令牌或令牌 | 字符串|细绳[] | |
有效负载 | 消息有效负载 | 消息有效负载。 |
选项 | 消息选项 | 用于更改消息的可选选项。 |
返回:
Promise< MessagingDevicesResponse >
消息发送后服务器响应履行的承诺。
消息传递.sendToDeviceGroup()
请改用Messaging.send() 。
将 FCM 消息发送到与提供的通知密钥对应的设备组。
请参阅发送到设备组以获取代码示例和详细文档。
签名:
sendToDeviceGroup(notificationKey: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingDeviceGroupResponse>;
参数
范围 | 类型 | 描述 |
---|---|---|
通知键 | 细绳 | 向其发送消息的设备组的通知键。 |
有效负载 | 消息有效负载 | 消息有效负载。 |
选项 | 消息选项 | 用于更改消息的可选选项。 |
返回:
Promise< MessagingDeviceGroupResponse >
消息发送后服务器响应履行的承诺。
消息传递.sendToTopic()
向主题发送 FCM 消息。
请参阅发送到主题以获取代码示例和详细文档。
签名:
sendToTopic(topic: string, payload: MessagingPayload, options?: MessagingOptions): Promise<MessagingTopicResponse>;
参数
范围 | 类型 | 描述 |
---|---|---|
话题 | 细绳 | 要将消息发送到的主题。 |
有效负载 | 消息有效负载 | 消息有效负载。 |
选项 | 消息选项 | 用于更改消息的可选选项。 |
返回:
Promise<消息主题响应>
消息发送后服务器响应履行的承诺。
消息传递.subscribeToTopic()
为设备订阅 FCM 主题。
请参阅订阅主题以获取代码示例和详细文档。或者,您可以提供一系列令牌来订阅多个设备。
签名:
subscribeToTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
参数
范围 | 类型 | 描述 |
---|---|---|
注册令牌或令牌 | 字符串|细绳[] | |
话题 | 细绳 | 要订阅的主题。 |
返回:
Promise< MessagingTopicManagementResponse >
设备订阅主题后,通过服务器的响应履行承诺。
消息传递.unsubscribeFromTopic()
取消设备对 FCM 主题的订阅。
请参阅取消订阅主题以获取代码示例和详细文档。或者,您可以提供一系列令牌来取消订阅多个设备。
签名:
unsubscribeFromTopic(registrationTokenOrTokens: string | string[], topic: string): Promise<MessagingTopicManagementResponse>;
参数
范围 | 类型 | 描述 |
---|---|---|
注册令牌或令牌 | 字符串|细绳[] | |
话题 | 细绳 | 要取消订阅的主题。 |
返回:
Promise< MessagingTopicManagementResponse >
设备取消订阅主题后,服务器的响应将履行承诺。