此接口表示在通过 FCM 旧版 API 发送消息时可提供的选项。
如需查看代码示例和详细文档,请参阅构建发送请求。
签名:
export interface MessagingOptions
属性
属性 | 类型 | 说明 |
---|---|---|
collapseKey | 字符串 | 用于标识一组可收起(以便当恢复递送时只发送最后一条消息)的邮件(例如“有更新可用”)的字符串。这用于避免在设备恢复在线状态或变为活动状态时发送过多相同的消息。无法保证消息的发送顺序。在任何给定时间,系统最多允许提供 4 个不同的折叠键。这意味着 FCM 服务器可以为每个客户端应用同时存储四条不同的“发送以同步”消息。如果超出此限值,FCM 服务器将无法保证会保留哪四个折叠键。**默认值:** 无 |
contentAvailable | 布尔值 | 在 iOS 中,使用此字段表示 APNs 载荷中的 content-available 。当发送通知或数据消息且此字段设为 true 时,将会唤醒处于非活动状态的客户端应用。在 Android 中,默认情况下,数据消息会唤醒应用。Chrome 目前不支持此标志。**默认值:** false |
dryRun | 布尔值 | 是否实际应发送消息。设置为 true 时,开发者可在不实际发送消息的情况下测试请求。如果设置为 false ,系统会发送消息。**默认值:** false |
mutableContent | 布尔值 | 在 iOS 中,使用此字段表示 APNs 载荷中的 mutable-content 。如果发送通知时此字段设为 true ,则可以使用 Notification Service 附加应用信息 在通知显示之前修改通知的内容。在 Android 和 Web 上,此参数将被忽略。**默认值:** false |
优先级 | 字符串 | 消息的优先级。有效值为 "normal" 和 "high". 。在 iOS 中,这些值相当于 APNs 优先级 5 和 10 。默认情况下,通知消息以高优先级发送,数据消息以普通优先级发送。普通优先级可优化客户端应用的电池消耗,除非需要立即传递,否则应使用普通优先级。对于普通优先级消息,应用可能会收到未指定延迟时间的消息。当以高优先级发送消息时,应用会立即发送消息,并且可以唤醒休眠设备并打开与服务器的网络连接。如需了解详情,请参阅设置消息的优先级。**默认值:** 对于通知消息,默认值为 "high" ,数据消息为 "normal" |
restrictedPackageName | 字符串 | 应用的软件包名称,其注册令牌必须匹配才能接收消息。**默认值:** 无 |
timeToLive | 数字 | 当设备离线时,消息在 FCM 存储空间中保留的时长(以秒为单位)。支持的最长生存时间为 4 周,默认值也是 4 周。如需了解详情,请参阅设置消息的有效期。**默认值:** 2419200 (表示四周,以秒为单位) |
MessagingOptions.collapseKey
用于标识一组可收起(以便当恢复递送时只发送最后一条消息)的邮件(例如“有更新可用”)的字符串。这是为了避免当设备恢复在线状态或变为活动状态时重复发送过多相同的信息。
消息发送顺序并不固定。
在任意指定时间内最多允许 4 个不同的折叠键。这意味着 FCM 服务器可以为每个客户端应用同时存储四条不同的“发送以同步”消息。如果超出此限值,FCM 服务器将无法保证会保留哪四个折叠键。
**默认值**:无
签名:
collapseKey?: string;
MessagingOptions.contentAvailable
在 iOS 中,使用此字段表示 APNs 载荷中的 content-available
。当发送通知或数据消息且此字段设为 true
时,将会唤醒处于非活跃状态的客户端应用。在 Android 中,默认情况下,数据消息会唤醒应用。Chrome 目前不支持此标志。
**默认值**:false
签名:
contentAvailable?: boolean;
MessagingOptions.dryRun
是否实际应发送消息。设置为 true
时,开发者可在不实际发送消息的情况下对请求进行测试。如果设为 false
,系统就会发送消息。
**默认值**:false
签名:
dryRun?: boolean;
MessagingOptions.mutableContent
在 iOS 中,使用此字段表示 APNs 载荷中的 mutable-content
。如果发送通知时此字段设为 true
,则可以使用通知服务附加应用信息在通知显示之前修改通知的内容。
在 Android 和 Web 上,此参数将被忽略。
**默认值**:false
签名:
mutableContent?: boolean;
MessagingOptions.Priority
消息的优先级。有效值为 "normal"
和 "high".
。在 iOS 中,这些值相当于 APNs 优先级 5
和 10
。
默认情况下,通知消息以高优先级发送,数据消息以普通优先级发送。普通优先级可优化客户端应用的电池消耗,除非需要立即传递,否则应使用普通优先级。对于普通优先级消息,应用可以接收未指定延迟时间的消息。
当以高优先级发送消息时,将会立即发送消息,应用可能会唤醒睡眠中的设备并打开服务器网络连接。
如需了解详情,请参阅设置消息的优先级。
**默认值:** "high"
表示通知消息,"normal"
表示数据消息
签名:
priority?: string;
MessagingOptions.restrictedPackageName
应用的软件包名称,其注册令牌必须匹配才能接收消息。
**默认值**:无
签名:
restrictedPackageName?: string;
MessagingOptions.timeToLive
当设备离线时,消息在 FCM 存储空间中保留的时长(以秒为单位)。支持的最长生存时间为 4 周,默认值也是 4 周。如需了解详情,请参阅设置消息的有效期。
**默认值**:2419200
(表示四周,以秒为单位)
签名:
timeToLive?: number;