openUrl
描述
打开网页
网页应用需要完成鉴权后调用该接口。
支持说明
| 客户端平台 | WPS协作版本要求 |
|---|---|
| iOS | >=2.0.0 |
| Android | >=2.0.0 |
| PC | >=2.0.0 |
输入
| 名称 | 数据类型 | 是否必填 | 描述 |
|---|---|---|---|
| params | object | 是 | |
| ∟ mode | string | 否 | 打开模式，仅PC端支持 window：新窗口打开 independentWindow：独立窗口打开 browser：浏览器打开 |
| ∟ newTab | boolean | 否 | 是否在新的 tab 上打开网页。当传入true时，会通过新的应用容器打开页面。 默认 false |
| ∟ toolbar | array<string> | 否 | 自定义工具栏。传[]表示隐藏工具栏，需要自定义工具栏可按需传下列参数： • doc_create：创建文档 • history：历史记录 • robot：机器人会话 • browser：浏览器打开 • share：分享 • more：更多 注意：自定义工具栏仅 PC 端支持，默认显示应用工具栏 |
| ∟ url | string | 是 | 需要打开的网页 url。 注意：在5.24.0之后，增加了url scheme白名单功能，不在白名单内会禁止跳转。 默认支持 scheme：["http","https","rtsp","woa","ksoxz","kim"] |
| onSuccess | Function | 否 | |
| onError | Function | 否 |
输出
- 无返回值
示例代码
ts
const params = {
url: 'https://www.baidu.com',
newTab: false,
mode: 'window',
toolbar: ['doc_create', 'history', 'robot', 'browser', 'share', 'more']
};
window.ksoxz_sdk.openUrl({params, onSuccess, onError});错误码
参考：公共错误码