JSAPI 概述
JSAPI 是面向网页应用提供的，基于 WPS 协作的网页开发工具包。点击下载最新包。
开发者可调用 JSAPI 使用获取用户信息、选择媒体、地理位置等手机系统的能力，同时可以直接使用分享等 WPS 协作特有的能力，为用户提供更优质的网页体验。
使用注意事项：
- 所有接口都为异步；
- 所有接口必须在 window.ksoxz_sdk.ready(function () { ... }) 回调函数里调用；
- 成功的回调在 onSuccess、错误的回调 onError；
- onSuccess 是一个方法，里面会带出一些参数，比如{auth：boolean}；
- onError 是一个方法，具体会有一些错误信息。
js
const onSuccess = (msg) => {};
const onError = (msg) => {};
window.ksoxz_sdk.ready(function () {
window.ksoxz_sdk.authorize({ params: { scope: "xxx" }, onSuccess, onError });
});
分类 | 名称 | 描述 | iOS | Android | PC |
|---|---|---|---|---|---|
| 基础 | config | 用于对使用到的网页应用 JSAPI 进行鉴权。 | >=3.10.0 | >=3.10.0 | >=3.10.0 |
| 基础 | authorize | 用于向用户发出授权请求。 | >=1.27.0 | >=1.27.0 | >=1.27.0 |
| 基础 | canIUse | 用于判断接口是否可以在当前客户端版本运行。 | >=2.3.0 | >=2.3.0 | >=2.3.0 |
| 业务开放接口-登录 | requestAccess | 应用请求访问权限，用于请求登录授权码实现单点登录等场景。 | >=5.18.0 | >=5.18.0 | >=5.18.0 |
| 业务开放接口-用户信息 | getUserInfo | 用于获取当前登录用户的用户信息。 | >=5.8.0 | >=5.8.0 | >=5.8.0 |
| 业务开放接口-用户信息 | enterProfile | 用于打开用户名片。 | >=5.24.0 | >=5.24.0 | >=5.24.0 |
| 业务开放接口-聊天与通讯录 | createGroupChat | 调用该接口进入创建群聊流程。 | >=5.24.0 | >=5.24.0 | >=5.24.0 |
| 业务开放接口-聊天与通讯录 | chooseGroupMember | 群成员选择器。 | >=5.24.0 | ||
| 业务开放接口-聊天与通讯录 | chooseChat | 打开用户会话列表的选择会话。 | >=5.24.0 | >=5.24.0 | >=5.24.0 |
| 业务开放接口-聊天与通讯录 | chooseContact | 打开联系人选择器，可以选择用户或部门，并返回选择的用户和部门信息。 | >=2.7.0 | >=2.7.0 | >=2.7.0 |
| 业务开放接口-应用信息 | openSetting | 打开设置页面，展示用户设置（包括授予和拒绝）过的权限，关闭页面后返回用户设置过的授权结果。 | >=5.24.0 | >=5.24.0 | >=5.24.0 |
| 业务开放接口-应用信息 | getSetting | 用于获取用户设置（包括授予和拒绝）过的权限列表数据。 | >=5.24.0 | >=5.24.0 | >=5.24.0 |
| 业务开放接口-应用信息 | getWebAppInfo | 获取当前网页应用信息。 | >=2.35.0 | >=2.35.0 | >=2.35.0 |
| 业务开放接口-分享 | shareMessage | 分享内容到第三方应用。 | >=4.25.0 | >=4.25.0 | >=4.25.0 |
| 业务开放接口-自定义业务 | invokeCustomAPI | 执行自定义 JSAPI，该接口适用在移动端集成协作中台 SDK 或插件定制场景，用于拓展自定义 JSAPI。 | >=5.20.0 | >=5.20.0 | >=5.20.0 |
| 业务开放接口-自定义业务 | launchNativeApp | 用于唤起原生应用。 | >=5.20.0 | ||
| 界面-导航栏 | setSidebarButton | 侧边栏导航自定义按钮。 | >=3.10.0 | ||
| 界面-导航栏 | closeNavBar | 隐藏导航栏。 | >=5.24.0 | ||
| 界面-导航栏 | configureMenu | 自定义底部工具菜单条目。 | >=3.10.0 | >=3.10.0 | >=3.10.0 |
| 界面-导航栏 | hideMenuItems | 设置隐藏底部工具菜单的 Items。 | >=3.10.0 | >=3.10.0 | |
| 界面-导航栏 | showMenuItems | 设置底部工具菜单的 Items 展示。 | >=3.10.0 | >=3.10.0 | |
| 界面-导航栏 | setNavigationButton | 自定义导航栏左侧按钮。 | >=3.10.0 | >=3.10.0 | >=3.10.0 |
| 界面-导航栏 | setNavigationBarColor | 设置导航栏颜色。 | >=3.10.0 | >=3.10.0 | |
| 界面-导航栏 | setNavBarTitle | 用于设置导航栏标题。 | >=3.10.0 | >=3.10.0 | >=3.10.0 |
| 界面-交互反馈 | showActionSheet | 用于显示操作菜单。 | >=2.15.0 | >=2.15.0 | |
| 界面-交互反馈 | showPrompt | 展示可输入内容的弹窗。 | >=2.15.0 | >=2.15.0 | >=2.15.0 |
| 界面-交互反馈 | hidePreloader | 隐藏加载弹窗。 | >=2.15.0 | >=2.15.0 | |
| 界面-交互反馈 | showPreloader | 显示加载弹窗。 | >=2.15.0 | >=2.15.0 | |
| 界面-交互反馈 | showToast | 显示提示弹窗。 | >=2.15.0 | >=2.15.0 | >=2.15.0 |
| 界面-交互反馈 | showConfirm | 显示确认框。 | >=2.15.0 | >=2.15.0 | >=2.15.0 |
| 界面-交互反馈 | showAlert | 显示提醒弹窗。 | >=2.15.0 | >=2.15.0 | >=2.15.0 |
| 界面-页面操作 | closeSidebar | 收起侧边面板。 | >=5.24.0 | ||
| 界面-页面操作 | closeApp | 用于关闭网页应用。 | >=3.10.0 | >=3.10.0 | |
| 界面-页面操作 | closeWeb | 关闭当前 web 容器。 | >=3.10.0 | >=3.10.0 | |
| 界面-页面操作 | openUrl | 打开网页。 | >=2.0.0 | >=2.0.0 | >=2.0.0 |
| 界面-页面操作 | rotateScreenView | 旋转屏幕。 | >=4.15.0 | >=4.15.0 | |
| 设备-系统信息 | getDeviceInfo | 获取当前设备信息。 | >=2.3.0 | >=2.3.0 | >=2.3.0 |
| 设备-系统信息 | getAppInfo | 获取当前客户端信息。 | >=2.35.0 | >=2.35.0 | >=2.35.0 |
| 设备-系统信息 | setAppInfoListener | 监听客户端信息变化用于监听应用信息设置变更，如大字体设置变更。 | >=4.20.0 | >=4.20.0 | |
| 设备-系统信息 | removeAppInfoListener | 取消监听客户端信息变化。 | >=4.20.0 | >=4.20.0 | |
| 设备-扫码 | scan | 调起相机扫描一维码、二维码并返回扫描结果。 | >=2.7.0 | >=2.7.0 | |
| 设备-wifi | getConnectedWifi | 获取设备当前所连接的 Wi-Fi。 | >=4.16.0 | >=4.16.0 | |
| 设备-wifi | getWifiStatus | 获取 WI-FI 开关状态。 | >=4.16.0 | >=4.16.0 | |
| 设备-wifi | getWifiList | 获取 Wi-Fi 列表。 | >=4.16.0 | ||
| 设备-wifi | onGetWifiList | 监听获取到 Wi-Fi 列表数据事件。 | >=4.16.0 | ||
| 设备-wifi | offGetWifiList | 取消监听获取到 Wi-Fi 列表数据事件。 | >=4.16.0 | ||
| 设备-网络状态 | getNetworkType | 获取设备当前所处的网络类型。 | >=4.16.0 | >=4.16.0 | |
| 设备-网络状态 | setNetworkListener | 监听网络状态变化。 | >=3.10.0 | >=3.10.0 | >=3.10.0 |
| 设备-网络状态 | removeNetworkListener | 取消监听网络状态变化。 | >=3.10.0 | >=3.10.0 | >=3.10.0 |
| 设备-网络状态 | getNetworkQualityType | 获取当前设备所处的网络质量评级。 | >=3.10.0 | >=3.10.0 | >=3.10.0 |
| 设备-网络状态 | setNetworkQualityChange | 监听网络质量变化。 | >=3.10.0 | >=3.10.0 | >=3.10.0 |
| 设备-网络状态 | removeNetworkQualityChange | 取消监听网络质量评级变化。 | >=3.10.0 | >=3.10.0 | >=3.10.0 |
| 设备-通用蓝牙 | getBluetoothAdapterState | 获取蓝牙适配器状态。 | >=5.19.0 | >=5.19.0 | |
| 设备-通用蓝牙 | openBluetoothAdapter | 初始化蓝牙模块。 | >=5.19.0 | >=5.19.0 | |
| 设备-通用蓝牙 | closeBluetoothAdapter | 关闭蓝牙模块。 | >=5.19.0 | >=5.19.0 | |
| 设备-通用蓝牙 | getBluetoothDevices | 获取全部已发现蓝牙设备。 | >=5.19.0 | >=5.23.0 | |
| 设备-通用蓝牙 | startBluetoothDevicesDiscovery | 查找附近蓝牙设备。 | >=5.19.0 | >=5.23.0 | |
| 设备-通用蓝牙 | stopBluetoothDevicesDiscovery | 停止查找附近蓝牙设备。 | >=5.19.0 | >=5.23.0 | |
| 设备-通用蓝牙 | onBluetoothDeviceFound | 监听寻找新蓝牙设备。 | >=5.19.0 | >=5.23.0 | |
| 设备-通用蓝牙 | offBluetoothDeviceFound | 取消监听寻找新蓝牙设备。 | >=5.19.0 | >=5.23.0 | |
| 设备-通用蓝牙 | getConnectedBluetoothDevices | 获取已处于连接状态的蓝牙设备。 | >=5.19.0 | >=5.23.0 | |
| 设备-通用蓝牙 | onBluetoothAdapterStateChange | 监听蓝牙适配器状态变化。 | >=5.19.0 | >=5.19.0 | |
| 设备-通用蓝牙 | offBluetoothAdapterStateChange | 取消监听蓝牙适配器状态变化。 | >=5.19.0 | >=5.19.0 | |
| 设备-低功耗蓝牙 | setBLEMTU | 设置蓝牙最大传输单元。 | >=5.23.0 | ||
| 设备-低功耗蓝牙 | connectBLEDevice | 低功耗蓝牙连接外围设备。 | >=5.23.0 | >=5.23.0 | |
| 设备-低功耗蓝牙 | disconnectBLEDevice | 断开蓝牙设备连接。 | >=5.23.0 | >=5.23.0 | |
| 设备-低功耗蓝牙 | onBLEConnectionStateChange | 监听蓝牙连接状态变化。 | >=5.23.0 | >=5.23.0 | |
| 设备-低功耗蓝牙 | offBLEConnectionStateChange | 取消监听蓝牙连接状态变化。 | >=5.23.0 | >=5.23.0 | |
| 设备-低功耗蓝牙 | getBLEDeviceServices | 低功耗蓝牙获取设备服务。 | >=5.23.0 | >=5.23.0 | |
| 设备-低功耗蓝牙 | getBLEDeviceCharacteristics | 获取读写特征。 | >=5.23.0 | >=5.23.0 | |
| 设备-低功耗蓝牙 | notifyBLECharacteristicValueChange | 设置启用特征订阅。 | >=5.23.0 | >=5.23.0 | |
| 设备-低功耗蓝牙 | onBLECharacteristicValueChange | 监听特征值变化。 | >=5.23.0 | >=5.23.0 | |
| 设备-低功耗蓝牙 | offBLECharacteristicValueChange | 取消监听特征值变化。 | >=5.23.0 | >=5.23.0 | |
| 设备-低功耗蓝牙 | readBLECharacteristicValue | 读取蓝牙接口数据。 | >=5.23.0 | >=5.23.0 | |
| 设备-低功耗蓝牙 | writeBLECharacteristicValue | 写入蓝牙数据。 | >=5.23.0 | >=5.23.0 | |
| 设备-蓝牙信标 | startBeaconDiscovery | 用于开始搜索附近的 Beacon 设备。 | >=5.25.0 | >=5.25.0 | |
| 设备-蓝牙信标 | stopBeaconDiscovery | 停止搜索附近的 Beacon 设备.。 | >=5.25.0 | >=5.25.0 | |
| 设备-蓝牙信标 | getBeacons | 用于获取所有已搜索到的 Beacon 设备。 | >=5.24.0 | >=5.24.0 | |
| 设备-蓝牙信标 | onBeaconUpdate | 监听 Beacon 设备更新事件，仅能注册一个监听。 | >=5.25.0 | >=5.25.0 | |
| 设备-蓝牙信标 | offBeaconUpdate | 取消监听 Beacon 设备更新事件。 | >=5.25.0 | >=5.25.0 | |
| 设备-蓝牙信标 | onBeaconServiceChange | 监听 Beacon 服务状态变化事件，仅能注册一个监听。 | >=5.24.0 | >=5.24.0 | |
| 设备-蓝牙信标 | offBeaconServiceChange | 取消监听 Beacon 服务状态变化事件。 | >=5.25.0 | >=5.25.0 | |
| 设备-剪贴板 | setClipboard | 设置系统粘贴板数据。 | >=2.7.0 | >=2.7.0 | >=2.7.0 |
| 设备-剪贴板 | getClipboard | 获取系统粘贴板数据。 | >=2.7.0 | >=2.7.0 | >=2.7.0 |
| 设备-键盘 | keyboard | 隐藏 iOS 键盘默认工具栏。 | >=5.1.0 | ||
| 设备-截屏监听 | setScreenShotListener | 设置截图监听。 | >=3.14.0 | >=3.14.0 | |
| 设备-截屏监听 | removeScreenShotListener | 移除截图监听。 | >=3.14.0 | >=3.14.0 | |
| 设备-拨打电话 | makePhoneCall | 拨打电话。 | >=2.7.0 | >=2.7.0 | |
| 设备-摇一摇 | accelerometerWatchShake | 调用该方法启动加速度计"摇一摇"监听。 | >=2.7.0 | >=2.7.0 | |
| 设备-摇一摇 | accelerometerClearShake | 调用该方法停止加速度计"摇一摇"监听。 | >=2.7.0 | >=2.7.0 | |
| 设备-运动与健康 | getStepCount | 获取运动步数。 | >=5.12.0 | >=5.12.0 | |
| 文件 | chooseFile | 选择本地文件。 | >=2.15.0 | >=2.15.0 | |
| 文件 | previewFile | 预览文件。 | >=2.0.0 | >=2.0.0 | |
| 媒体-图片 | chooseImage | 从系统相册中选择图片,或使用来自相机拍摄的图片。 | >=3.0.0 | >=3.0.0 | |
| 媒体-图片 | previewImage | 用于预览图片。 | >=2.0.0 | >=2.0.0 | >=2.0.0 |
| 媒体-图片 | getImageBase64 | 获取图片 base64，仅 iOS 端支持。 | >=2.15.0 | ||
| 媒体-图片 | getImageInfo | 获取图片信息。 | >=5.24.0 | >=5.24.0 | >=5.24.0 |
| 媒体-图片 | compressImage | 压缩图片。 | >=5.24.0 | >=5.24.0 | >=5.24.0 |
| 媒体-图片 | saveImageToAlbum | 保存图片到本地相册。 | >=3.10.0 | >=3.10.0 |