表示通过 FCM 旧版 API 发送消息时可以提供的选项的接口。
请参阅构建发送请求以获取代码示例和详细文档。
签名:
export interface MessagingOptions
特性
财产 | 类型 | 描述 |
---|---|---|
折叠键 | 细绳 | 标识一组可以折叠的消息(例如“可用更新”)的字符串,以便在可以恢复传递时仅发送最后一条消息。这用于避免当设备恢复在线或变为活动状态时发送太多相同的消息。无法保证消息发送的顺序。在任何给定时间最多允许有四个不同的折叠键。这意味着 FCM 服务器可以为每个客户端应用程序同时存储四个不同的发送同步消息。如果超过此数量,则无法保证 FCM 服务器将保留哪四个折叠键。 **默认值:** 无 |
内容可用 | 布尔值 | 在 iOS 上,使用此字段表示 APNs 负载中content-available 。当发送通知或数据消息并将其设置为true 时,将唤醒不活动的客户端应用程序。在 Android 上,默认情况下数据消息会唤醒应用程序。在 Chrome 上,当前不支持此标志。 **默认值:** false |
干运行 | 布尔值 | 消息是否应该实际发送。当设置为true 时,允许开发人员测试请求而无需实际发送消息。当设置为false 时,将发送消息。 **默认值:** false |
可变内容 | 布尔值 | 在 iOS 上,使用此字段来表示 APNs 负载中的mutable-content 。发送通知并将其设置为true 时,可以使用通知服务应用扩展在显示通知之前修改通知的内容。在 Android 和 Web 上,此参数将被忽略。 **默认值:** false |
优先事项 | 细绳 | 消息的优先级。有效值为"normal" 和"high". 在 iOS 上,这些对应于 APN 优先级5 和10 。默认情况下,通知消息以高优先级发送,数据消息以普通优先级发送。正常优先级可优化客户端应用程序的电池消耗,除非需要立即交付,否则应使用正常优先级。对于具有正常优先级的消息,应用程序可能会以未指定的延迟接收消息。当以高优先级发送消息时,它会立即发送,并且应用程序可以唤醒休眠的设备并打开与服务器的网络连接。有关详细信息,请参阅设置消息优先级。 **默认值:** 通知消息为"high" ,数据消息为"normal" |
受限制的包名称 | 细绳 | 注册令牌必须匹配的应用程序的包名称才能接收消息。 **默认值:** 无 |
生存时间 | 数字 | 如果设备离线,消息应在 FCM 存储中保留多长时间(以秒为单位)。支持的最长生存时间是四个星期,默认值也是四个星期。有关详细信息,请参阅设置消息的生命周期。 **默认值:** 2419200 (代表四个星期,单位为秒) |
MessagingOptions.collapseKey
标识一组可以折叠的消息(例如“可用更新”)的字符串,以便在可以恢复传递时仅发送最后一条消息。这用于避免当设备恢复在线或变为活动状态时发送太多相同的消息。
无法保证消息发送的顺序。
在任何给定时间最多允许有四个不同的折叠键。这意味着 FCM 服务器可以为每个客户端应用程序同时存储四个不同的发送同步消息。如果超过此数量,则无法保证 FCM 服务器将保留哪四个折叠键。
**默认值:** 无
签名:
collapseKey?: string;
MessagingOptions.contentAvailable
在 iOS 上,使用此字段表示 APNs 负载中content-available
。当发送通知或数据消息且此项设置为true
时,不活动的客户端应用程序被唤醒。在 Android 上,默认情况下数据消息会唤醒应用程序。在 Chrome 上,当前不支持此标志。
**默认值:** false
签名:
contentAvailable?: boolean;
消息传递选项.dryRun
消息是否应该实际发送。当设置为true
时,允许开发人员测试请求而无需实际发送消息。当设置为false
时,消息将被发送。
**默认值:** false
签名:
dryRun?: boolean;
MessagingOptions.mutableContent
在 iOS 上,使用此字段来表示 APNs 负载中的mutable-content
。当发送通知并将其设置为true
时,可以使用通知服务应用扩展在显示之前修改通知的内容。
在 Android 和 Web 上,此参数将被忽略。
**默认值:** false
签名:
mutableContent?: boolean;
MessagingOptions.priority
消息的优先级。有效值为"normal"
和"high".
在 iOS 上,这些对应于 APN 优先级5
和10
。
默认情况下,通知消息以高优先级发送,数据消息以普通优先级发送。正常优先级可优化客户端应用程序的电池消耗,除非需要立即交付,否则应使用正常优先级。对于具有正常优先级的消息,应用程序可能会以未指定的延迟接收消息。
当以高优先级发送消息时,它会立即发送,并且应用程序可以唤醒休眠的设备并打开与服务器的网络连接。
有关详细信息,请参阅设置消息优先级。
**默认值:** 通知消息为"high"
,数据消息为"normal"
签名:
priority?: string;
MessagingOptions.restrictedPackageName
注册令牌必须匹配的应用程序的包名称才能接收消息。
**默认值:** 无
签名:
restrictedPackageName?: string;
MessagingOptions.timeToLive
如果设备离线,消息应在 FCM 存储中保留多长时间(以秒为单位)。支持的最长生存时间是四个星期,默认值也是四个星期。有关详细信息,请参阅设置消息的生命周期。
**默认值:** 2419200
(代表四个星期,单位为秒)
签名:
timeToLive?: number;