推送实时活动

参数

说明

推送目标

可选项如下：

1. 所有：推送给全部设备。

2. 指定终端：根据设备ID推送。

3. 指定账号：根据设备ID绑定的账号推送。

4. 指定别名：根据设备ID绑定的别名推送。

5. 设备标签：根据设备ID绑定的标签推送。

推送时机

设置本次推送的发送时间。

可选项包括：

• 立即发送

• 定时发送：不能超过7天。

参数

说明

实况窗通知操作类型

实况窗消息操作类型：

• 创建：表示创建实况窗消息，仅允许event值为FLIGHT、TAXI、TRAIN，详情见创建实况窗约束。

• 更新：表示更新实况窗消息（确保activityId对应的实况窗存在）

• 结束：表示结束实况窗消息（确保activityId对应的实况窗存在）

更新和结束实况窗时，对于非必选字段，若无特殊说明和默认值，则不携带时默认继承上一次的状态。

实况窗标识

实况窗唯一标识，取值范围为[-2147483648, 2147483647]，由开发者自行生成。对应Live View Kit中的id字段。

业务场景

业务场景取值，使用限制请参考：HarmonyOS 实况窗推送指南的event。

实况窗消息状态

当实况窗通知操作类型为创建，或当实况窗通知操作类型为更新且更新的实况窗为通过移动推送远程创建的实况窗时必填。

实况窗消息状态（status）的取值范围根据场景类型而定，详情见Status取值范围。

消息体中占位符{{status}}的使用，参见支持携带占位符的字段，满足要求时将替换字段中的占位符为目标值。

厂商通道通知类型

厂商通道通知类型，包括：

• 正式通知（默认）

• 测试通知

降级通知标题

当系统不支持实况窗通知时，展示在通知栏的内容。

降级通知内容

当系统不支持实况窗通知时，展示在通知栏的内容。

静默通知

标识消息更新是否需要提醒。

• 静默提醒（默认）

• 铃声震动提醒

实况窗版本号

更新实况窗通知的版本号，大于等于0，新的实况窗通知版本号需大于当前实况窗通知版本号，否则会刷新失败。

参数

说明

布局类型

包括：

• 进度可视化类型：适用于外卖配送、生鲜配送、车辆接驾进展等涉及进度节点显示的活动。

• 强调文本模板类型：适用于展示取餐码、取件码、车牌号等关键信息的活动。

• 左右文本模板类型：适用于高铁、火车、航班等涉及展示起点、终点的活动。

• 赛事类型：适用于体育赛事比分场景、游戏赛事比分场景等

参数

说明

实况窗关键词

实况窗关键词，实况窗通知操作类型为创建且业务场景为如下场景时，必填。

• 业务场景为FLIGHT时，仅有flightNo一个keyword，表示航班号，占位符格式：{{flightNo}}。

  • 示例：

    {
      "flightNo": "XX1234"
    }

• 业务场景为TRAIN时，仅有trainNo一个keyword，表示火车车次，占位符格式：{{trainNo}}。

  示例：

  {
    "trainNo": "GXXXX"
  }

消息体中占位符的使用，参见支持携带占位符的字段。

存档期

实况窗通知存档期，在结束实况窗通知后，通知仍保留在通知中心的时长，默认0不保留，最多设置1小时，单位为秒(s)。

存档期时间以结束实况窗消息中携带的此字段数据为准，存档期期间不支持再次更新或结束通知。

通知标题

通知标题，长度最大1024字符。

实况窗通知操作类型为创建时必填，且不能为空字符串。

通知内容

通知内容，由多段富文本RichText组成，文本长度总和不超过1024字符，若设置文本颜色，只允许设置为同一种颜色。

实况窗通知操作类型为创建时必填，且不能为空字符串。

显示分割线

是否显示扩展区域的分割线。包括：

• 开启：显示（默认）

• 关闭：不显示

辅助区显示类型

辅助区样式，详细说明请参见Extend结构体。

说明

• 更新布局类型为新布局时，需重新设置该参数。

• 刷新实况窗通知内容时，辅助区显示类型为图片且图片路径填写错误会导致刷新内容失败。

点击行为类型

消息点击行为，详细说明请参见ClickAction结构体。

自定义数据

点击时传递给应用的数据，详细说明参考ClickAction的data。

锁屏沉浸图片

锁屏沉浸实况窗展示的图片，取值为在指定路径下的文件名。

示例：图标文件“icon.png”存放在应用的“/resources/rawfile”路径下，则取值为“icon.png”。

参数

说明

进度百分比

进度值0-100，决定指示器在进度条中的位置。

指示器图标

本地资源，不携带时系统显示时采用上次刷新的图像。当操作类型为创建且指示器显示类型

为：

• 显示在进度线上方

• 显示覆盖在进度线上

必填，且不能为空字符串。

进度颜色

进度指示器左侧的进度点及节点图标的颜色，"#ARGB"16进制格式，长度为9，默认为蓝色。

背景颜色

进度指示器右侧的进度点及节点图标的颜色，"#ARGB"16进制格式，长度为9，默认为灰色。

节点图标

进度条每个节点的图标，数组长度范围为[2, 5]，本地资源，不携带时系统显示时采用上次刷新的图像。当操作类型为创建时必填，且不能为空Array[String]。

进度显示类型

扩展区进度显示类型：

• 虚线进度（默认）

• 普通实线进度

• 粗实线进度

指示器显示类型

扩展区指示器小图标显示类型：

• 不显示指示器小图标（默认）

• 显示在进度线上方

• 显示覆盖在进度线上

参数

说明

首行文本

首行文本，长度不超过128字符，且不能为空字符串。

次行文本

次行文本内容，长度不超过128字符，且不能为空字符串。

下划线颜色

次行文本内容下划线颜色，"#ARGB"16进制格式，长度为9，不设置则不显示下划线。

描述图片

扩展区域描述图片，默认不显示。传值后显示在通知右侧扩展区，未传则沿用上次图像。详细说明请参见NotificationData的descPic字段

参数

说明

胶囊类型

胶囊布局类型：

• 图标+文本：胶囊显示左侧图标，右侧文本。

• 计时器：胶囊显示左侧图标，右侧计时文本。

• 进度：胶囊显示整体进度，左侧图标，右侧百分比/数值占比。

胶囊状态

在状态栏上以实况窗胶囊的形式呈现应用实况业务时：

• 显示：胶囊显示

• 不显示：胶囊不显示

状态图标

状态图标，本地资源。推荐使用 18*18vp 的纯色矢量图标。

示例：图标文件“icon.svg”存放在应用的“/resources/rawfile”路径下，则取值为“icon.svg”。

动态效果

胶囊在状态栏的动态效果，不携带时默认无特殊效果。

• 无特殊效果：无特殊效果。

• 抢占胶囊位置动态：抢占胶囊位置动态，最高支持5次/活动。

• 胶囊自动展开成悬浮卡片：胶囊自动展开成悬浮卡片动态，最高支持2次/活动。

胶囊背景色

胶囊背景色"#ARGB"16进制格式，长度为9。

不允许使用以下颜色：

• #FF000000

• #FFFFFFFF

• #FFF1F3F5

胶囊标题

胶囊状态主文本，长度不超过128字符。

当操作类型为创建且布局类型为图标+文本时必填。

当布局类型为图标+文本时，该字段用于设置胶囊标题。

胶囊内容

长度不超过128字符，当设备为宽屏或设备横屏时，显示该扩展文本。

当操作类型为创建且布局类型为图标+文本或计时器时必填。

当布局类型为图标+文本或计时器时，该字段用于设置胶囊内容。

参数

说明

计时器初始值

胶囊计时器初始值，每秒刷新一次。单位ms，默认为0。

倒计时

是否倒计时显示计时器

• 关闭：正计时显示（默认）

• 开启：倒计时显示

暂停

胶囊计时器是否暂停

• 关闭：不暂停（默认）

• 开启：暂停，计时器暂停时，胶囊会显示暂停的那一秒

参数

说明

最大进度值

进度最大值，范围为[1, 2147483647]。

当前进度值

进度当前值，范围为[0, 2147483647]，小于等于进度最大值。

无限循环

进度显示类型

• 开启：百分比

• 关闭：数值占比

参数

说明

外屏模板类型

包括：

• 默认类型（默认）

• 背景图片类型

外屏背景颜色

"#RGB"16进制格式，长度为7，不设置时使用系统默认颜色。

外屏通知标题

自定义的外屏通知标题，总长度不超过128字符。当操作类型为创建时必填，且不为空字符串。

外屏通知内容

自定义的外屏通知内容，由多段富文本RichText组成，文本长度总和不超过128字符，若设置文本颜色，只允许设置为同一种颜色。

外屏背景图片

本地资源，当模板类型为背景图片类型时，第一次创建图片时必须设置，后续不更新时可不设置。取值为指定路径下的文件名。