合作咨询
我们的专家服务团队将竭诚为您提供专业的合作咨询服务
当前实况窗通知特性及文档为Beta阶段，仅可通过链接访问，请及时保存页面链接，并控制链接的传播范围，感谢理解与支持。
实况窗通知
本文导读
注意
实况窗通知涉及的原生通知接口
接口 | 必选 | 参数类型 | 描述 |
|---|---|---|---|
setContentTitle | 是 | CharSequence | 原生通知标题接口，传递的字符串在通知标题显示。在实况窗通知中，若不设置notification.live.titleOverlay参数，则实况窗通知的标题也显示为ContentTitle。 |
setContentText | 是 | CharSequence | 原生通知内容接口，传递的字符串在通知内容显示。在实况窗通知中，若不设置notification.live.contentOverlay参数，则实况窗通知的内容也显示为ContentText。 |
setUsesChronometer | 否 | boolean | 设置是否使用计时器。在基础类型的实况窗通知中，支持将主标题或副文本使用计时器来替代，需要将该接口设置为true来使计时器生效。 |
setWhen | 否 | long | 设置计时器的初始时间。若已在基础类型的实况窗通知中显示计时器，可使用该接口来设置计时器显示的初始时间，单位为ms，默认为0。 |
setChronometerCountDown | 否 | boolean | 设置计时器是否为倒计时。若已在基础类型的实况窗通知中显示计时器，可使用该接口来设置计时器为倒计时，默认为正计时。 |
setProgress | 否 | int max int progress boolean indeterminate | 设置通知的进度。该接口有3个参数，分别设置进度的最大值、进度的当前值和进度的显示形式。在基础类型的实况窗通知中，通过该接口设置进度可在右侧显示圆形的进度条。在多操作类型的实况窗通知中，通过该接口设置进度可在中间显示直条进度条。在进度类型的实况窗胶囊中，通过该接口设置进度可控制胶囊内显示的进度值，且通过indeterminate可控制进度是以百分比形式还是数值比形式显示。 |
addExtras | 是 | Bundle | 应用可使用该接口来增加扩展参数，将参数添加到Bundle中，然后将bundle添加到通知的extras中，发送时即可携带实况窗通知的扩展参数。 |
setActions | 否 | Action | 设置按钮的接口。在基础类型的实况窗通知中，通过该接口可设置右侧的操作按钮。 |
setLargeIcon | 否 | Icon | 设置大图标的接口。在实况窗通知中若设置了LargeIcon和IconOverlay属性，则会叠加显示LargeIcon和应用图标，否则只显示应用图标。该参数仅适用于基础操作类型模板，建议用于通话等场景。 |
setSmallIcon | 是 | Icon | 设置小图标的接口，该小图标将用于在状态栏和内容视图中表示通知。 |
实况窗通知扩展参数
参数 | 必选 | 参数类型 | 描述 |
|---|---|---|---|
notification.live.operation | 是 | int | 实况窗通知生命周期。
|
notification.live.event | 是 | String | 实况窗通知的应用场景。
|
notification.live.type | 是 | int | 实况窗通知的类型
|
notification.live.titleOverlay | 否 | CharSequence | 若携带该参数，则实况窗通知主标题显示该参数内容，若不携带，则主标题显示原生通知ContentTitle。参数限制最大128个字符。 |
notification.live.contentOverlay | 否 | CharSequence | 若携带该参数，则实况窗通知副文本显示该参数内容，若不携带，则副文本显示原生通知ContentText。参数限制最大128个字符。支持传递SpannableString来设置文本颜色，最多支持设置一种强调色。 |
notification.live.iconOverlay | 否 | boolean | 实况窗通知图标是否叠加显示。
叠加显示功能仅支持基础类型。 |
notification.live.keepTime | 否 | long | 实况窗通知存档期，在结束实况窗通知后，通知保留在通知中心中显示的时长，默认0不保留，最多设置1小时，单位为s。系统会将应用设置的时间规整到标准的时间段。 |
notification.live.feature | 否 | Bundle | 实况窗通知各个类型的独立扩展参数，需设置到bundle中。 |
notification.live.capsule | 否 | Bundle | 实况窗胶囊的扩展参数，需设置到bundle中。 |
notification.live.version | 否 | int | 实况窗通知消息序号，用于消息展示保序，当高序号通知已显示，后来的低序号通知会被拦截丢弃。
|
外屏适配的扩展参数
参数 | 必选 | 参数类型 | 描述 |
|---|---|---|---|
notification.live.externalEnable | 否 | boolean | 实况窗通知是否支持外屏显示，默认为true。 |
notification.live.externalTitle | 否 | CharSequence | 自定义外屏显示的实况窗通知标题，若无则选择实况窗通知原本的标题。参数限制最大为128字符。支持传递SpannableString来设置文本颜色，最多支持设置一种强调色。 |
notification.live.externalBody | 否 | CharSequence | 自定义外屏显示的实况窗通知内容，若无则选择实况窗通知原本的内容。参数限制最大为128字符。支持传递SpannableString来设置文本颜色，最多支持设置一种强调色。 |
notification.live.externalType | 否 | int | 外屏模板类型：
|
notification.live.externalBgImage | 否 | Icon | 外屏背景图。当externalType=1时，首次创建实况窗通知时需携带，后续若不更新可只第一次携带。 |
notification.live.externalBgColor | 否 | int | 外屏背景色。默认为灰色（#F1F3F5）。 |
基础类型的扩展参数
参数 | 必选 | 参数类型 | 描述 |
|---|---|---|---|
notification.live.feature.chronometerPosition | 否 | int | 基础类型的实况窗通知支持将主标题或通知内容替换为计时器，使用本字段决定计时器的位置。
|
notification.live.feature.progressHide | 否 | boolean | 基础类型的实况窗通知是否隐藏右侧的进度显示。
|
多操作类型的扩展参数
参数 | 必选 | 参数类型 | 描述 |
|---|---|---|---|
notification.live.feature.selectedAction | 否 | Notification.Action | 多操作类型的实况窗通知，右上角辅助区的action按钮。默认不显示。 |
进度可视化类型的扩展参数
图示 | 说明 |
|---|---|
| 1 进度条节点图标，对应nodeIcon字段 2 进度条指示器图标，对应indicatorIcon字段 3 进度条进度的颜色，对应progressColor字段 4 进度条背景色，对应progressBgColor字段 |
参数 | 必选 | 参数类型 | 描述 |
|---|---|---|---|
notification.live.feature.nodeIcon | 否 | ArrayList<Icon> | 进度可视化类型的实况窗通知，扩展区进度条上的节点图标。若设置节点图标，则数量要求大于等于2个，小于等于5个。若之后节点图标不更新则可不携带。若不设置节点图标，则会以默认的起点和终点图标显示。
|
notification.live.feature.indicatorIcon | 否 | Icon | 进度可视化类型的实况窗通知，扩展区进度条上方的指示器内的图标。若不设置则指示器内不显示图标，只显示空白的指示器。 |
notification.live.feature.indicatorType | 否 | int | 扩展区指示器小图标显示类型：
|
notification.live.feature.progressType | 否 | int | 扩展区进度显示类型：
|
notification.live.feature.progress | 是 | int | 进度可视化类型的实况窗通知，扩展区进度条的进度值。最大为100。 |
notification.live.feature.progressColor | 否 | int | 进度可视化类型的实况窗通知，扩展区进度条的进度颜色，表示进度条起点到指示器之间的进度点及节点图标的颜色。默认为蓝色（#FF0CA8E6） |
notification.live.feature.progressBgColor | 否 | int | 进度可视化类型的实况窗通知，扩展区进度条的进度背景颜色，表示指示器到进度条终点之间的进度点及节点图标的颜色。默认为灰色（#1A00000） |
notification.live.feature.extendType | 否 | int | 辅助区显示类型：
|
notification.live.feature.extendText | 否 | String | 辅助区显示的普通文本或胶囊文本。 当extendType为1或2时，第一次创建时需携带，后续不更新可只第一次携带。 |
notification.live.feature.extendImage | 否 | Icon | 辅助区显示图片或Icon。 当extendType为3或4时，第一次创建时需携带，后续不更新可只第一次携带。 |
强调文本模板类型的扩展参数
图示 | 说明 |
|---|---|
| 1 辅助标记文本，对应titleText字段 2 强调文本内容，对应contentText字段 3 强调下划线，对应underlineColor字段 4 图片区，对应descPic字段 |
参数 | 必选 | 参数类型 | 描述 |
|---|---|---|---|
notification.live.feature.titleText | 是 | String | 强调文本模板类型的实况窗通知，扩展区的文本标题。参数限制不超过128个字符。 |
notification.live.feature.contentText | 是 | String | 强调文本模板类型的实况窗通知，扩展区的文本内容。参数限制不超过128个字符。 |
notification.live.feature.underlineColor | 否 | int | 强调文本模板类型的实况窗通知，扩展区的文本内容下方下划线的颜色。若不设置则不显示下划线。 |
notification.live.feature.descPic | 否 | Icon | 强调文本模板类型的实况窗通知，扩展区的图标显示。若不设置则不显示图标。 |
notification.live.feature.extendType | 否 | int | 辅助区显示类型：
|
notification.live.feature.extendText | 否 | String | 辅助区显示的普通文本或胶囊文本。 当extendType为1或2时，第一次创建时需携带，后续不更新可只第一次携带。 |
notification.live.feature.extendImage | 否 | Icon | 辅助区显示图片或Icon。 当extendType为3或4时，第一次创建时需携带，后续不更新可只第一次携带。 |
左右文本类型的扩展参数
图示 | 说明 |
|---|---|
| 1 左侧文本标题，对应firstTitleText字段 2 左侧文本内容，对应firstContentText字段 3 右侧文本标题，对应lastTitleText字段 4 右侧文本内容，对应lastContentText字段 5 分割线，对应splitLineEnable字段 6 中间图标区，对应spaceIcon字段 |
参数 | 必选 | 参数类型 | 描述 |
|---|---|---|---|
notification.live.feature.firstTitleText | 是 | String | 多文本类型的实况窗通知，扩展区左侧的文本标题。参数限制不超过128个字符。 |
notification.live.feature.firstContentText | 是 | String | 多文本类型的实况窗通知，扩展区左侧的文本内容。参数限制不超过128个字符。 |
notification.live.feature.lastTitleText | 是 | String | 多文本类型的实况窗通知，扩展区右侧的文本标题。参数限制不超过128个字符。 |
notification.live.feature.lastContentText | 是 | String | 多文本类型的实况窗通知，扩展区右侧的文本内容。参数限制不超过128个字符。 |
notification.live.feature.splitLineEnable | 否 | boolean | 多文本类型的实况窗通知，扩展区上方是否显示分割线。默认显示。 |
notification.live.feature.spaceIcon | 否 | Icon | 多文本类型的实况窗通知，扩展区中间的间隔图标显示。默认不显示。
|
notification.live.feature.extendType | 否 | int | 辅助区显示类型。
|
notification.live.feature.extendText | 否 | String | 辅助区显示的普通文本或胶囊文本。 当extendType为1或2时，第一次创建时需携带，后续不更新可只第一次携带。 |
notification.live.feature.extendImage | 否 | Icon | 辅助区显示图片或Icon。 当extendType为3或4时，第一次创建时需携带，后续不更新可只第一次携带。 |
赛事类型的扩展参数
图示 | 说明 |
|---|---|
| 1 左侧队伍图标，对应hostIcon字段 2 左侧队伍名称，对应hostName字段 3 左侧队伍比分，对应hostScore字段 4 右侧队伍图标，对应guestIcon字段 5 右侧队伍名称，对应guestName字段 6 右侧队伍比分，对应guestScore字段 7 赛事描述文本，对应competitionDesc字段 8 比赛时间，对应competitionTime字段 |
参数 | 必选 | 参数类型 | 描述 |
|---|---|---|---|
notification.live.feature.hostIcon | 是 | Icon | 赛事类型的实况窗通知，扩展区左侧的图标。 |
notification.live.feature.hostName | 是 | String | 赛事类型的实况窗通知，扩展区左侧的名称。参数限制不超过128个字符。 |
notification.live.feature.hostScore | 是 | String | 赛事类型的实况窗通知，扩展区左侧的比分。参数限制不超过128个字符。 |
notification.live.feature.guestIcon | 是 | Icon | 赛事类型的实况窗通知，扩展区右侧的图标。 |
notification.live.feature.guestName | 是 | String | 赛事类型的实况窗通知，扩展区右侧的名称。参数限制不超过128个字符。 |
notification.live.feature.guestScore | 是 | String | 赛事类型的实况窗通知，扩展区右侧的比分。参数限制不超过128个字符。 |
notification.live.feature.competitionDesc | 是 | String | 赛事类型的实况窗通知，扩展区中间上方描述文本。参数限制不超过128个字符。 |
notification.live.feature.competitionTime | 是 | String | 赛事类型的实况窗通知，扩展区中间下方比赛时间。参数限制不超过128个字符。 |
notification.live.feature.splitLineEnable | 否 | boolean | 赛事类型的实况窗通知，扩展区分割线是否显示。默认显示。 |
notification.live.feature.extendType | 否 | int | 辅助区显示类型：
|
notification.live.feature.extendText | 否 | String | 辅助区显示的普通文本或胶囊文本。 当extendType为1或2时，第一次创建时需携带，后续不更新可只第一次携带。 |
notification.live.feature.extendImage | 否 | Icon | 辅助区显示图片或Icon。 当extendType为3或4时，第一次创建时需携带，后续不更新可只第一次携带。 |
实况窗胶囊的扩展参数
参数 | 必选 | 参数类型 | 描述 |
|---|---|---|---|
notification.live.capsuleStatus | 是 | int | 实况窗胶囊的显示状态。
|
notification.live.capsuleType | 是 | int | 实况窗胶囊的类型。
|
notification.live.capsuleIcon | 是 | Icon | 实况窗胶囊的图标，显示在胶囊左侧。在创建胶囊时必填，更新时可不携带。 |
notification.live.capsuleBgColor | 是 | int | 实况窗胶囊的背景颜色。在创建胶囊时必填，更新时可不携带。 |
notification.live.capsuleTitle | 否 | String | 实况窗胶囊的标题文本，在图标+文本类型的胶囊中会显示该文本。在创建图标+文本类型的胶囊时必填，更新时可不携带。参数限制不能为空，最大128个字符。 |
notification.live.capsuleContent | 否 | String | 实况窗胶囊的扩展文本，当设备为宽屏设备，或设备横屏时，图标+文本类型和计时器类型的胶囊中会显示该文本。在创建图标+文本类型或计时器类型的胶囊时必填，更新时可不携带。参数限制不能为空，最大128个字符。 |
notification.live.capsuleTime | 否 | long | 计时器类型的胶囊的初始时间，单位为ms，默认为0。 |
notification.live.capsuleCountdown | 否 | boolean | 表示计时器类型的胶囊是否为倒计时，默认为false。 |
notification.live.capsulePause | 否 | boolean | 表示计时器类型的胶囊是否暂停计时，默认为false。 |
notification.live.capsuleRemind | 否 | boolean | 表示实况窗胶囊更新时是否提醒用户，需要提醒时则在更新胶囊时设置此字段为true，默认为false。胶囊存在时间内最多提醒5次。 |
搜索
请输入您想要搜索的关键词