Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

导航栏

自定义导航栏左侧第二个按钮

使用说明

客户端AndroidiOSPC
支持说明支持支持/
const params = {
    iconId:'home',
};
window.ksoxz_sdk.setNavigationButton({params, onSuccess});

参数说明

参数类型描述备注
iconIdstring图标 ID目前支持的 iconid 只有 home,可用于返回应用首页

设置导航栏按钮

使用说明

客户端AndroidiOSPC
支持说明//支持
const params = {
    iconId:'home',
    tip: '回到首页'
};
window.ksoxz_sdk.setNavigationButton({params, onSuccess});

参数说明

参数类型描述备注
tipstringpc 端 hover 上去的提示移动端暂无
iconIdstring图标 ID参考图标列表(暂无)
directionstring方向非必填,不传默认是左侧(left),右侧:right

会话侧边栏导航自定义按钮

使用说明

客户端AndroidiOSPC
支持说明//支持
const params = {
    type:'share',
    icon: '',
    url: ''
};
window.ksoxz_sdk.setSidebarButton({params, onSuccess});

参数说明

参数类型描述备注
typestring按钮与功能菜单的设置类型必传,只有三种值: indepentWindow、share、custom;
indepentWindow(独立窗口):功能菜单为“分享”、“刷新”、“关于”; share(分享):功能菜单为“独立窗口”、“刷新”、“关于”;
custom(自定义):功能菜单为“分享”、“独立窗口”、“刷新”、“关于”;
iconstring自定义按钮的按钮图标值为一个图片 url,type 是 custom 时必传
urlstring点击自定义按钮后的跳转页值为 url 或 deeplink,type 是 custom 时必传

隐藏导航栏

使用说明

客户端AndroidiOSPC
支持说明//支持
window.ksoxz_sdk.closeNavBar();

批量显示导航栏更多菜单项

使用说明

客户端AndroidiOSPC
支持说明3.26.03.26.0/
const params = {
    items:[
        'share',
        'robot'
    ]
};
window.ksoxz_sdk.showMenuItems({params, onSuccess});

参数说明

参数类型描述备注
itemsstring[]要显示的菜单项列表refresh: 刷新
robot: 机器人
floating: 浮窗
share: 分享
file: 文件
restart: 重启

批量隐藏导航栏更多菜单项

使用说明

客户端AndroidiOSPC
支持说明3.26.03.26.0-
const params = {
    items:[
        'share',
        'robot'
    ]
};
window.ksoxz_sdk.hideMenuItems({params, onSuccess});

参数说明

参数类型描述备注
itemsstring[]要隐藏的菜单项列表refresh: 刷新
robot: 机器人
floating: 浮窗
share: 分享
file: 文件
restart: 重启

设置导航栏颜色

设置导航栏颜色。

使用说明

客户端AndroidiOSPC
支持说明支持支持/
const params = {
    backgroundColor:"#FFFFFF",
    frontColor:""
}
window.ksoxz_sdk.setNavigationBarColor({ params,onSuccess, onError });

参数说明

参数类型描述备注
backgroundColorstring背景颜色值,有效值为十六进制颜色
示例值:#ffffff
/
frontColorstring前景颜色值,包括按钮、标题的颜色
示例值:#000000
/
statusBarModestring手机状态栏主题
可选值:
Light:浅色主题,系统状态栏图标为黑色
Dark:深色主题,系统状态栏图标为白色
/

错误码

errnomsg含义
1001002Invalid request parameter参数格式错误

自定义右上角更多菜单

自定义右上角更多菜单条目。

使用说明

客户端AndroidiOSPC
支持说明支持支持支持
const params = {
    items: [{
        text:"自定义1",
        callbackId:"custom1"
    }]
}
const onSuccess = (res) => {
    if(res.callbackId == null) {
        //configureMenu方法调用成功
        return;
    }
    switch(res.callbackId) {
        case "custom1":
        //点击了“自定义1”
        break;
    }
}
window.ksoxz_sdk.configureMenu({ params,onSuccess, onError });

参数说明

参数类型描述备注
itemsobject[]自定义菜单条目,为空则为清除/
∟textstring菜单条目文本/
∟callbackIdstring事件回调ID/

返回结果

参数类型描述
callbackIdstring事件回调ID,该接口调用成功会返回一个callbackId为null的事件;其它则代表相应的自定义item被点击