Skip to content

应用红点数字

阅读本文,你将了解:

  • 应用红点的所有类型;
  • 应用红点生成的链接规则,以及消除的方式。

什么是应用红点数字

应用红点

如上图中的流程大师应用右上角的红点数字,当前支持显示红点、数字及图标。除了默认的“应用中心”栏目,在工作台上的应用同样支持。通过约定好链接的方式,在管理后台上架应用时可以指定红点请求的地址。

在添加“应用入口”时,可以根据实际需求添加“红点数字提醒源”,如下图:

应用红点设置

显示规则

  • 接口由各轻应用提供,但调用的URL及返回数据,需遵守WorkPlus设定的规则;
  • 对于应用Tab页中的各个轻应用,在应用Tab显示对应轻应用时调用API更新显示此值;
  • 用户点击进入轻应用后,由轻应用自己负责清除当前用户的红点,数字或图标;当返回到Tab页时,APP 会重新再次拉取以刷新。

API 调用规则

调用 URL 规则:

js
${URL}&tenantId={{tenantId}}&username={{username}}&ticket={{ticket}}

参数说明:

参数类型说明
URLString这个值由轻应用提供,此项在后台中配置
tenantIdString租户ID,当前移动端的用户的域id,由移动端自动填充
usernameString当前用户帐号,由移动端自动填充
ticketString给轻应用做单点登陆所用,由移动端自动填充

应用访问地址的参数,在这里同样适用,约定参数均需要使用双花括号括着。

返回格式规则:

js
{
 status: 0
 message: 'Everything is ok'
 tip:{
   notify_type: 'dot',
   icon_url: 'url',
   num: 2
 }
}

status0时,表示接口调用成功;非0时,表示接口调用失败,message此时表示失败的原因。

notify_type包括4种类型,如下:

  • dot 在轻应用上显示一个红点
  • digit 在轻应用上显示一个数字
  • icon 在轻应用上显示一个图标
  • nothing 轻应用上不显示红点或数字或图标

icon_url,只有在notify_typeicon时才会获取,此值为图标资源地址。

num 当notify_type为digit 时,此值表示一个数字。

关于清空提醒

如果应用添加了“红点数字提醒源”,在需要清空的时候,接口必须返回nothingtype,而不是返回一个空的结果。