Skip to content

setSidebarButton

描述

侧边栏导航自定义按钮

网页应用需要完成鉴权后调用该接口。

支持说明

客户端平台WPS协作版本要求
PC>=3.10.0

输入

名称数据类型是否必填描述
paramsobject
∟ iconstring值为一个图片 url,type 是 custom 时必传
∟ typestring必传,只有三种值: indepentWindow、share、custom;
indepentWindow(独立窗口):功能菜单为分享、刷新、关于。
share(分享):功能菜单为独立窗口、刷新、关于。
custom(自定义):功能菜单为分享、独立窗口、刷新、关于。
∟ urlstring值为 url 或 deeplink,type 是 custom 时必传

输出

  • 无返回值

示例代码

ts
window.ksoxz_sdk.setSidebarButton({
params:{
  type: 'indepentWindow',
  icon: 'icon',
  url: 'url'
},
onSuccess,
onError
})

错误码

参考:公共错误码