参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
testMessage | 否 | Boolean | 测试消息标识:
说明: 当testMessage为true时,单个项目最多可推送1000条测试消息,每次推送携带Token数不超过10个。推送授权订阅消息与卡片刷新消息时,每次仅能携带一个Token。 |
ttl | 否 | Integer | 消息缓存时间,单位是秒。在用户设备离线时,消息在Push服务器进行缓存,在消息缓存时间内用户设备上线,消息会下发,超过缓存时间后消息会丢弃,默认值为86400秒(1天),最大值为1296000秒(15天)。 说明: 推送应用内通话消息场景、推送通知消息(VOIP消息类型)场景以及推送通知扩展消息(VOIP消息类型)场景,ttl建议设置为30~60秒。 |
biTag | 否 | String | 批量任务消息标识,消息回执时会返回给应用服务器,长度最大64字节。 |
receiptId | 否 | String | 输入一个唯一的回执ID指定本次下行消息的回执地址及配置,该回执ID可以在配置回执参数中查看。 |
collapseKey | 否 | Integer | 用户设备离线时,Push服务器对离线消息缓存机制的控制方式,用户设备上线后缓存消息会再次下发,取值如下:
如果您发送了10条消息,其中前5条的collapseKey为1,后5条的collapseKey为2,那么待用户上线后collapseKey为1和2的分别下发最新的一条消息给最终用户。 须知: collapseKey字段只对push-type为0或2的消息生效。 0:通知消息 2:通知扩展消息 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
token | 是 | Array [String] | 按照Token向目标用户推送消息。 示例: {
"token": ["IQAAA*******"]
} 须知: 消息订阅和卡片刷新场景单次只允许携带1个Token,其他消息单次最多携带1000个Token。 |
请求体示例请参见通知消息。
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
notification | 是 | Notification Object | 通知消息结构体,详情请参见Notification结构体。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
category | 是 | String | 通知消息类别。完成申请通知消息自分类权益后,用于标识消息类型,不同的通知消息类型影响消息展示和提醒方式。取值如下:
说明:
|
title | 是 | String | 通知消息标题。(注意消息体大小限制,详情参见使用约束) |
body | 是 | String | 通知消息内容。(注意消息体大小限制,详情参见使用约束) |
image | 否 | String | 通知右侧大图标URL,URL使用的协议必须是HTTPS协议。 说明: 支持图片格式为PNG、JPG、JPEG、BMP,图片长*宽建议小于128*128像素,若超过49152像素,则图片不展示。 |
style | 否 | Integer | 通知消息样式:
须知: style=1 大文本样式将要废弃,建议直接使用 style=0 普通通知。 |
bigTitle | 否 | String | 大文本样式的标题,当style为1时必选。设置bigTitle后通知栏展示时,使用bigTitle而不用title。(注意消息体大小限制,详情参见使用约束) 须知: 此字段将要废弃,建议直接使用title字段。 |
bigBody | 否 | String | 大文本样式的内容,当style为1时必选。设置bigBody后通知栏展示时,使用bigBody而不用body。(注意消息体大小限制,详情参见使用约束) 须知: 此字段将要废弃,建议直接使用body字段。 |
notifyId | 否 | Integer | 每条消息在通知显示时的唯一标识。不携带或者设置-1时,推送服务自动为每条消息生成一个唯一标识;不同的通知消息可以拥有相同的notifyId,实现新消息覆盖旧消息功能。若要用于消息撤回则必填,且范围为[0, 2147483647],即非负值。详情请参见消息撤回。 |
appMessageId | 否 | String | 应用消息的唯一标识,不携带时默认无appMessageId。长度范围为[1,64],支持大小写字母、数字、+、/、=、-、_和空白字符。 须知:
|
profileId | 否 | String | 应用内账号id匿名标识,最大长度为64。 |
inboxContent | 否 | Array [String] | 多行文本样式的内容,当style为3时,本字段必填,最多支持3条内容,每条最大长度1024且无法完全展示时以“...”截断。 示例: {
"data": {
"key1": "value1",
"key2": "value2"
}
} |
clickAction | 是 | ClickAction Object | 点击消息动作,详情请参见ClickAction结构体。 |
badge | 否 | Badge Object | 通知消息角标控制参数,详情请参见Badge结构体,不设置时应用不显示角标数字,若当前已存在角标,则角标数字不变化。 示例: {
"badge": { "addNum": 1 }
} |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
actionType | 是 | Integer | 消息点击后的行为。 0:打开应用首页 1:打开应用自定义页面 3:清除通知 5:打开拨号界面 在不同的场景下支持actionType不同,详细参考点击行为类型。 |
action | 否 | String | 应用内置页面ability对应的action。当actionType为1时,字段uri和action至少填写一个。 action如何设置请参见点击消息进入应用内页并传递数据。 |
uri | 否 | String | 应用内置页面ability对应的uri,uri对象内部结构请参见skills标签。当actionType为1时,字段uri和action至少填写一个。当存在多个Ability时,分别填写不同Ability的action和uri,优先使用action查找对应的应用内置页面。 uri如何设置请参见点击消息进入应用内页并传递数据。 |
data | 否 | Object | 点击时传递给应用的数据,格式为JSON对象。(注意消息体大小限制,详情参见使用约束) actionType为5时,data必填。固定携带{"tel": "xxx"} value为电话号码,长度最大为20,允许包含字符:
示例: {
"data": {
"key1": "value1",
"key2": "value2"
}
} 须知: 当actionType为5时,首位字符必须为+或0-9。 |
push-type | 字段 | actionType枚举值 |
|---|---|---|
0 Alert消息 | notification.clickAction | 0:打开应用首页 1:打开应用自定义页面 |
subscription.clickAction | 0:打开应用首页 1:打开应用自定义页面 | |
2 通知扩展消息 | notification.clickAction | 0:打开应用首页 1:打开应用自定义页面 |
7 实况窗 | notificationData.clickAction | 0:打开应用首页 1:打开应用自定义页面 |
notificationData.extend.clickAction | 0:打开应用首页 1:打开应用自定义页面 3:清除通知 5:打开拨号界面 须知: 如果设备不支持拨号,当actionType取值5时则无法创建实况窗。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
addNum | 否 | Integer | 应用角标累加数字(大于0小于100的整数),非应用角标实际显示数字。 说明:
|
setNum | 否 | Integer | 角标设置数字(大于等于0小于100的整数),应用角标实际显示数字。 说明: setNum优先级高于addNum:
|
请求体示例请参见授权订阅消息。
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
subscription | 是 | Subscription Object | 订阅消息内容,详情请参考Subscription结构体。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
entityId | 是 | String | 订阅消息对应的模板实例ID,详情请参见查看模板详情。 |
data | 否 | Object | 若订阅消息模板里有占位符,则本字段填写模板中的占位符需要被替换的变量值,否则不需要填写;格式为:key-value,其中value长度不超过50个字符。 示例: {
"data": {
"key1": "value1",
"key2": "value2"
}
} |
clickAction | 是 | ClickAction Object | 消息点击行为,详情请参见ClickAction结构体。 |
profileId | 否 | String | 应用内账号id匿名标识,最大长度为64。 |
请求体示例请参见通知扩展消息。
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
notification | 是 | Notification Object | 通知消息结构体,详情请参见Notification结构体。 须知: notification.category必填,且取值为“EXPRESS”,发送通知扩展消息前请先申请开通对应的消息自分类权益,详情请参见申请通知消息自分类权益;同时,还需要申请推送通知扩展消息权益,请参见申请推送通知扩展消息权益。 |
extraData | 是 | String | 通知扩展消息的额外数据。(注意消息体大小限制,详情参见使用约束) extraData数据获取请参考示例代码。 |
请求体示例请参见卡片刷新消息。
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
formId | 是 | Long | 服务卡片的实例ID,当卡片onAddForm(卡片使用方添加卡片至桌面)时获取。请注意,当前端侧生成formId最大值为2^31-1,formId字段支持输入的最大值为2^63-1。 |
version | 是 | Integer | 卡片刷新消息的版本号,最小值为0,最大值为2^31-1。
|
images | 否 | Array [FormImage Object] | 服务卡片图片数据,结构为数组,数组每个元素为一个object,详情请参见FormImage结构体。当前仅允许携带一个数组元素。 示例: {
"images": [{
"keyName": "icon",
"url": "https://xxx.png",
"require": 1
}]
} |
moduleName | 是 | String | 服务卡片模块名称。 项目模块级别下的src/main/module.json5中的module标签下的name值。 |
formName | 是 | String | 服务卡片名称。 该数据来源于卡片配置文件中forms标签下的某个卡片配置信息的name值,卡片配置文件位于项目模块级别下的src/main/resources/base/profile,请参见指南。 |
abilityName | 是 | String | 服务卡片Ability名称。 项目模块级别下的 src/main/module.json5中的extensionAbilities标签下的服务卡片的ability名称。 |
formData | 是 | Object | 待刷新服务卡片的业务数据,key-value格式, 示例: {
"formData": {
"content": "newContent"
}
} 该数据来源于卡片页面文件中的声明式范式组件名称,卡片页面文件位于项目模块级别下的src/main/ets/widgets,请参见指南。 须知:
|
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
keyName | 否 | String | 图片的对应的key,该值不能与formData中自定义的变量数据的key重复。 该数据来源于卡片页面文件中的图片组件名称,卡片页面文件位于项目模块级别下的src/main/ets/widgets,请参见指南。 |
url | 否 | String | 图片下载地址,URL使用的协议必须是HTTPS协议。 须知: 支持图片的格式为PNG、JPG、JPEG,图片文件最大为512KB,图片长*宽<12800像素。 |
require | 否 | Integer | 图片刷新策略控制。
|
为了确保用户看到内容的时效性,请您确保对实况窗内容进行及时更新。系统将在实况窗超过2小时未更新时,隐藏实况窗在状态栏胶囊和锁屏的展示,保留通知中心展示;超过4小时未更新,系统会认为实况窗结束,并从各个展示入口清除该实况窗。
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
activityId | 是 | Integer | 实况窗唯一标识,取值范围为[-2147483648, 2147483647],由开发者自行生成。对应Live View Kit中的id字段。 须知: 若发送的activityId对应的实况窗不存在(更新或结束实况窗的场景中),将限制使用该activityId发送实况窗消息24小时。 |
operation | 是 | Integer | 实况窗消息操作类型:
更新和结束实况窗时,对于非必选字段,若无特殊说明和默认值,则不携带时默认继承上一次的状态。 |
event | 是 | String | 业务场景取值,必须为以下内容之一:
使用对应场景需要申请权益,详情请参见实况窗权益申请填写要求。 须知: 当创建实况窗消息(operation取值为0)时,event取值仅允许为FLIGHT、TAXI、TRAIN。 |
status | 否 | String | 表示实况窗消息状态。 当operation为0,或operation为1且更新的实况窗为通过REST API创建的实况窗时必填。 status的取值范围根据场景类型而定,详情见Status取值范围。 消息体中占位符{{status}}的使用,参见支持携带占位符的字段,满足要求时将替换字段中的占位符为目标值。 |
title | 否 | String | 可选,当系统不支持实况窗通知时,展示在通知栏的标题。 |
content | 否 | String | 可选,当系统不支持实况窗通知时,展示在通知栏的内容。 |
mute | 否 | Boolean | 标识消息更新是否需要提醒。
|
version | 否 | Integer | 更新实况窗通知的版本号,大于等于0,新的实况窗通知版本号需大于当前实况窗通知版本号,否则会刷新失败。 |
activityData | 是 | ActivityData Object | 实况窗通知详细数据,具体字段请参见ActivityData结构体。 |
创建实况窗的消息示例请参见创建实况窗消息。
布局类型 | 字段 |
|---|---|
进度可视化类型 赛事类型 | activityData.notificationData.contentTitle activityData.notificationData.contentText.text |
强调文本模板类型 | activityData.notificationData.contentTitle activityData.notificationData.contentText.text activityData.notificationData.extend.text activityData.notificationData.singleTextBlock.firstLine activityData.notificationData.singleTextBlock.secondLine |
左右文本模板类型 | activityData.notificationData.contentTitle activityData.notificationData.contentText.text activityData.notificationData.extend.text activityData.notificationData.firstTextBlock.firstLine activityData.notificationData.firstTextBlock.secondLine activityData.notificationData.lastTextBlock.firstLine activityData.notificationData.lastTextBlock.secondLine |
event | status取值 | 消息体中{{status}}占位符将替换的词 | 场景说明 |
|---|---|---|---|
FLIGHT | DEPART | 计划 | 计划出发。航班计划起飞前一段时间,提醒用户准备出发。 |
WAITING_FOR_CHECK_IN | 未值机 | 未值机。 | |
CHECKED_IN | 已值机 | 已值机。 | |
PASSED_SECURITY_CHECK | 已安检 | 已安检。 | |
START_BOARDING | 开始登机 | 开始登机。 | |
URGE_BOARDING | 催促登机 | 催促登机。 | |
BOARDED | 已登机 | 已登机。 | |
END_BOARDING | 结束登机 | 结束登机。 | |
ABOUT_TO_TAKE_OFF | 即将起飞 | 即将起飞。 | |
TAKEN_OFF | 起飞 | 航班起飞。用户关注了某个航班后,向用户提醒航班已经起飞。 | |
ARRIVED | 到达 | 航班到达。 | |
TRANSFER | 中转提醒 | 中转提醒。用户有多趟航班中转,在到达后提醒用户下一趟航班的信息。 若是新航班信息,建议新建一张实况窗卡片承载。 | |
NEW_ITINERARY | 新行程开启 | 中转航班新行程提醒 | |
GATE_CHANGE | 登机口变更 | 登机口变更。 | |
FLIGHT_DELAY | 延误 | 航班延误。 | |
FLIGHT_CANCEL | 取消 | 航班取消。 | |
FLIGHT_DIVERSION | 备降 | 航班备降。 | |
FLIGHT_RETURN | 返航 | 航班返航。 | |
TAXI | CALLING | 呼叫车辆中 | 呼叫车辆中。 |
ABOUT_TO_BEGIN | 行程即将开始 | 行程即将开始。预约订单、顺风车订单的场景,在行程即将开始时,提醒用户出发。 | |
DRIVER_ON_THE_WAY | 司机正在赶来 | 司机正在赶来。 | |
DRIVER_ARRIVE | 司机已到达上车点 | 司机已到达上车点。 | |
HEADING_TO_DESTINATION | 正在去往目的地 | 正在去往目的地。订单有多个目的地时,可持续使用本状态直到行程结束。 | |
COMPLETED | 行程结束 | 行程结束。 | |
RE_CALLING | 重新呼叫车辆中 | 重新呼叫车辆中。订单改派、司机取消订单等导致的车辆重新呼叫。 | |
CANCELED | 订单已取消 | 订单已取消。用户取消订单、因周边运力不足无法成单的订单,均属于订单已取消。 | |
TRAIN | DEPART | 计划出发 | 列车计划出发前一段时间,提醒用户准备出发。 |
PASSED_SECURITY_CHECK | 已安检 | 用户已完成安检。 | |
TICKET_CHECK | 检票提醒 | 列车开始检票。 | |
CHECKED | 已检票 | 用户已完成检票。 | |
CHECK_IN_CLOSED | 停止检票 | 检票口截止检票进站。 | |
SET_OFF | 已出发 | 列车驶离出发点。 | |
HEADING_TO_DESTINATION | 列车运行中 | 列车运行过程中,可以同步向用户展示途径站点、预计剩余时间。 | |
ARRIVED | 已到达 | 列车到达目的地。 | |
GATE_CHANGE | 检票口变更 | 检票口变更。 | |
TRAIN_DELAY | 列车晚点 | 列车晚点。 | |
TRAIN_CANCEL | 列车停运 | 列车停运。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
notificationData | 是 | NotificationData Object | 消息通知布局数据,具体字段请参见NotificationData结构体。 |
capsuleData | 否 | CapsuleData Object | 胶囊通知布局数据,具体字段请参见CapsuleData结构体。 |
externalData | 否 | ExternalData Object | 小外屏(Pocket等系列手机外屏)展示数据,具体字段请参见ExternalData结构体。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
type | 是 | Integer | 布局类型:
|
keywords | 否 | Map<String, String> | 实况窗关键词,operation为0且event为如下场景时,必填。
消息体中占位符的使用,参见支持携带占位符的字段。 |
additionalText | 否 | String | 提示信息/免责声明。仅在NotificationData.type=5时可用。 |
keepTime | 否 | Long | 实况窗通知存档期,在结束实况窗通知后,通知仍保留在通知中心的时长,默认0不保留,最多设置1小时,单位为秒(s)。 存档期时间以结束实况窗消息中携带的此字段数据为准,存档期期间不支持再次更新或结束通知。 |
contentTitle | 否 | String | 通知标题,长度最大1024字符。 operation为0时必填,且不能为空字符串。 |
contentText | 否 | Array [RichText Object] | 通知内容,由多段富文本RichText组成,文本长度总和不超过1024字符,若设置文本颜色,只允许设置为同一种颜色。 operation为0时必填,且不能为空字符串。 |
richProgress | 否 | RichProgress Object | 丰富进度信息,type为3时必填,具体字段请参见RichProgress结构体。 |
singleTextBlock | 否 | SingleTextBlock Object | 强调文本模板样式中,强调的文本块,type为4时必填,默认占据左侧扩展区,具体字段请参见SingleTextBlock结构体。 |
firstTextBlock | 否 | FirstTextBlock Object | 多文本块布局中的左侧文本块,type为5时必填,详情可参见FirstTextBlock结构体。 |
lastTextBlock | 否 | LastTextBlock Object | 多文本块布局中的右侧文本块,type为5时必填,详情可参见LastTextBlock结构体。 |
displayHorizontalLine | 否 | Boolean | 是否显示扩展区域的分割线,不设置默认显示分割线。
说明: 当type为5或7时才会显示分割线。 |
spaceIcon | 否 | String | 间隔图标,本地资源,type为5时占据扩展区中间。 operation为0且type为5时必填,且不能为空字符串。 取值为在指定路径下的文件名。 示例:图标文件“icon.png”存放在应用的“/resources/rawfile”路径下,则取值为“icon.png”。 |
extend | 否 | Extend Object | 辅助区样式,无更新时可不携带。具体字段请参见Extend结构体。 说明:
|
game | 否 | Game Object | 赛事信息扩展区,type为7时必填,具体字段请参见Game结构体。 |
descPic | 否 | String | 扩展区域描述图片,默认不显示,当type为4时且传值会占据右侧扩展区。不携带时系统显示时采用上次刷新的图像。 operation为0且type为4时必填,且不能为空字符串。 取值为在指定路径下的文件名。 示例:图标文件“icon.png”存放在应用的“/resources/rawfile”路径下,则取值为“icon.png” |
clickAction | 是 | ClickAction Object | 消息点击行为,具体字段请参见ClickAction结构体。 |
lockScreen | 否 | LiveViewLockScreen Object | 锁屏沉浸实况窗相关字段,具体字段请参见LiveViewLockScreen结构体。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
type | 否 | Integer | 辅助区显示类型:
|
text | 否 | String | 辅助区文本信息,当type为1或2时必填,且不能为空字符串。 |
pic | 否 | String | 辅助区图片信息,当type为3或4时必填,且不能为空字符串。 取值为在指定路径下的文件名。 示例:图标文件“icon.png”存放在应用的“/resources/rawfile”路径下,则取值为“icon.png”。 注意: 本字段即将停止维护,请及时切换使用image字段。 |
image | 否 | String | 辅助区图片信息,当type为3或4时必填,且不能为空字符串。 取值为在指定路径下的文件名。 示例:图标文件“icon.png”存放在应用的“/resources/rawfile”路径下,则取值为“icon.png”。 |
clickAction | 否 | ClickAction Object | 辅助区的点击行为,具体字段请参见ClickAction结构体的定义。 若不携带该字段,则辅助区不支持点击跳转。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
host | 是 | Team Object | 扩展区左侧样式,具体字段请参见Team结构体。 |
guest | 是 | Team Object | 扩展区右侧样式,具体字段请参见Team结构体。 |
competition | 是 | Competition Object | 扩展区中部样式,具体字段请参见Competition结构体。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
icon | 否 | String | 展示区队伍图标,当operation为0时必填,且不可为空字符串。 取值为在指定路径下的文件名。 示例:图标文件“icon.png”存放在应用的“/resources/rawfile”路径下,则取值为“icon.png”。 |
name | 否 | String | 队伍名称,当operation为0时必填,且不可为空字符串。 |
score | 否 | String | 赛事比分,当operation为0时必填,且不可为空字符串。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
desc | 否 | String | 扩展区中间上方描述文本,当operation为0时必填,且不可为空字符串。 |
time | 否 | String | 扩展区中间下方比赛时间,当operation为0时必填,且不可为空字符串。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
picture | 否 | String | 锁屏沉浸实况窗展示的图片。 取值为在指定路径下的文件名。 示例:图标文件“icon.png”存放在应用的“/resources/rawfile”路径下,则取值为“icon.png”。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
type | 是 | Integer | 胶囊布局类型:
|
status | 是 | Integer | 在状态栏上以实况窗胶囊的形式呈现应用实况业务时:
|
icon | 是 | String | 状态图标,本地资源。推荐使用 18*18vp 的纯色矢量图标。 示例:图标文件“icon.svg”存放在应用的“/resources/rawfile”路径下,则取值为“icon.svg”。 |
bgColor | 是 | String | 胶囊背景色"#ARGB"16进制格式,长度为9。 不允许使用以下颜色:
|
remind | 否 | String | 胶囊在状态栏的动态效果,不携带时默认无特殊效果。
|
title | 否 | String | 胶囊状态主文本,长度不超过128字符。 当operation为0且type为1时必填。 当type为1时,该字段用于设置胶囊标题。 |
content | 否 | String | 胶囊状态内容,长度不超过128字符;当设备为宽屏或设备横屏时,显示该扩展文本。 当operation为0且type为1或2时必填。 当type为1或2时,该字段用于设置胶囊内容。 |
capsuleTimer | 否 | CapsuleTimer Object | 胶囊计时器,具体字段请参见CapsuleTimer结构体。 当type为2时必选,该字段用于设置胶囊计时器信息。 |
progress | 否 | Progress Object | 胶囊进度信息,具体字段请参见Progress结构体。 当type为3时必选,该字段用于设置胶囊进度信息。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
max | 否 | Integer | 进度最大值,默认为1,范围为[1, 2147483647]。 |
progress | 是 | Integer | 进度当前值,范围为[0, 2147483647],小于等于进度最大值 |
indeterminate | 否 | Boolean | 进度显示类型,默认显示为数值占比。
|
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
firstLine | 是 | String | 首行文本,长度不超过128字符,且不能为空字符串。 |
secondLine | 是 | String | 次行文本内容,长度不超过128字符,且不能为空字符串。 |
underlineColor | 否 | String | 次行文本内容下划线颜色,"#ARGB"16进制格式,长度为9,不设置则不显示下划线。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
firstLine | 是 | String | 首行文本,长度不超过128字符,且不能为空字符串。 |
secondLine | 是 | String | 次行文本内容,长度不超过128字符,且不能为空字符串。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
firstLine | 是 | String | 首行文本,长度不超过128字符,且不能为空字符串。 |
secondLine | 是 | String | 次行文本内容,长度不超过128字符,且不能为空字符串。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
indicatorIcon | 否 | String | 进度条指示器图标,本地资源,不携带时系统显示时采用上次刷新的图像。 当operation为0且indicatorType为1或2时,必填,且不能为空字符串。 取值为在指定路径下的文件名。 示例:图标文件“icon.png”存放在应用的“/resources/rawfile”路径下,则取值为“icon.png” |
progress | 是 | Integer | 进度百分比,进度值0-100,决定指示器在进度条中的位置。 |
color | 否 | String | 进度指示器左侧的进度点及节点图标的颜色,"#ARGB"16进制格式,长度为9,默认为蓝色。 |
bgColor | 否 | String | 进度指示器右侧的进度点及节点图标的颜色,"#ARGB"16进制格式,长度为9,默认为灰色。 |
nodeIcons | 否 | Array [String] | 进度条每个节点的图标,数组长度范围为[2, 5],本地资源,不携带时系统显示时采用上次刷新的图像。 当operation为0时必填,且不能为空Array[String]。 取值为在指定路径下的文件名。 示例:图标文件“icon.png”存放在应用的“/resources/rawfile”路径下,则取值为“icon.png” |
type | 否 | Integer | 扩展区进度显示类型:
|
indicatorType | 否 | Integer | 扩展区指示器小图标显示类型:
|
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
time | 否 | Long | 胶囊计时器初始值,每秒刷新一次。单位ms,默认为0。 |
countDown | 否 | Boolean | 是否倒计时显示计时器,默认正计时。
|
pause | 否 | Boolean | 胶囊计时器是否暂停,默认不暂停。
|
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
type | 否 | Integer | 外屏模板类型:
|
bgColor | 否 | String | 外屏背景颜色,"#RGB"16进制格式,长度为7,不设置时使用系统默认颜色。 |
bgImage | 否 | String | 外屏背景图片,本地资源,当type为1时,第一次创建图片时必须设置,后续不更新时可不设置。 当operation为0且type为1时必填,且不为空字符串。 取值为在指定路径下的文件名。 示例:图标文件“icon.png”存放在应用的“/resources/rawfile”路径下,则取值为“icon.png”。 |
title | 否 | String | 自定义的外屏通知标题,总长度不超过128字符。 当operation为0时必填,且不为空字符串。 |
body | 否 | Array [RichText Object] | 自定义的外屏通知内容,由多段富文本RichText组成,文本长度总和不超过128字符,若设置文本颜色,只允许设置为同一种颜色。 当operation为0时必填,且不为空数组。 |