JSAPI 总览
设备
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 判断接口是否可以在当前客户端版本运行 | canIUse | 支持 | 支持 | 支持 |
| 获取设备信息 | getDeviceInfo | 支持 | 支持 | / |
| 获取客户端信息 | getAppInfo | 支持 | 支持 | 支持 |
| 获取授权的接口 | authorize | 支持 | 支持 | / |
| 获取网络类型 | getNetworkType | 支持 | 支持 | 支持 |
| 网络质量评级 | getNetworkType | / | 支持 | 支持 |
| 监听网络状态变化 | setNetworkListener | / | 支持 | 支持 |
| 取消监听网络状态变化 | removeNetworkListener | 支持 | 支持 | 支持 |
| 监听网络质量变化 | setNetworkQualityChange | / | 支持 | 支持 |
| 取消监听网络质量变化 | removeNetworkQualityChange | / | 支持 | 支持 |
导航栏
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 设置导航栏左侧第二个按钮 | setNavigationButton | 支持 | 支持 | 支持 |
| 设置导航栏按钮 | setNavigationButton | / | / | 支持 |
| 会话侧边栏导航自定义按钮 | setSidebarButton | / | / | 支持 |
| 隐藏导航栏 | closeNavBar | / | / | 支持 |
| 批量显示导航栏更多菜单项 | showMenuItems | 3.26.0 | 3.26.0 | / |
| 批量隐藏导航栏更多菜单项 | hideMenuItems | 3.26.0 | 3.26.0 | / |
| 设置导航栏颜色 | setNavigationBarColor | 支持 | 支持 | / |
| 自定义右上角更多菜单 | configureMenu | 支持 | 支持 | / |
通讯录选人
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 选择部门和人 | chooseContact | 支持 | 支持 | 支持 |
| 创建群聊 | createGroupChat | 支持 | 支持 | 支持 |
| 群成员选择器 | chooseGroupMember | / | / | 支持 |
业务
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 获取用户授权 | requestAccess | 支持 | 支持 | / |
| 设置内容到剪贴板 | setClipboard | 支持 | 支持 | 支持 |
| 获取剪贴板数据 | getClipboard | 支持 | 支持 | 支持 |
| 分享 | shareMessage | 支持 | 支持 | 支持 |
| 扫码 | scan | 支持 | 支持 | / |
| 获取地理位置 | getLocationInfo | 支持 | 支持 | / |
| 获取应用信息 | getWebAppInfo | 支持 | 支持 | / |
| 启动摇一摇 | accelerometerWatchShake | 支持 | 支持 | / |
| 停止摇一摇 | accelerometerClearShake | 支持 | 支持 | / |
| 隐藏键盘完成栏 | keyboard | / | 支持 | / |
| 运动与健康 | getStepCount | 支持 | 支持 | / |
地理位置
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 获取位置信息 | getLocationInfo | 支持 | 支持 | / |
| 开启持续定位 | startLocationUpdate | 支持 | 支持 | / |
| 关闭持续定位 | stopLocationUpdate | 支持 | 支持 | / |
| 监听实时地理位置事件 | onLocationChange | 支持 | 支持 | / |
| 移除实时地理位置事件 | offLocationChange | 支持 | 支持 | / |
WiFi
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 获取设备当前所连的 Wifi | getConnectedWifi | 支持 | 支持 | / |
| 获取 Wi-Fi 开关状态 | getWifiStatus | 支持 | 支持 | / |
| 获取 Wi-Fi 列表 | getWifiList | 支持 | / | / |
| 监听获取到 Wi-Fi 列表数据事件 | onGetWifiList | 支持 | / | / |
| 取消监听获取到 Wi-Fi 列表数据事件 | offGetWifiList | 支持 | / | / |
图片
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 选择本地图片 | chooseImage | 支持 | 支持 | / |
| 预览图片 | previewImage | 支持 | 支持 | 支持 |
| 获取图片 base64 | getImageBase64 | / | 支持 | / |
| 保存图片到相册 | saveImageToAlbum | 支持 | 支持 | / |
视频
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 获取视频详细信息 | getVideoInfo | 支持 | 支持 | 支持 |
| 拍摄、选择媒体文件 | chooseMedia | 支持 | 支持 | 支持 |
文件
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 选择本地文件 | chooseFile | 支持 | / | / |
| 预览文件 | previewFile | 支持 | 支持 | / |
| 上传文件 | uploadFile | 支持 | 支持 | / |
| 下载文件 | downloadFile | 支持 | 支持 | / |
打开新页面
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 打开网页 | openUrl | 支持 | 支持 | 支持 |
| 关闭网页 | closeWeb | 支持 | 支持 | 支持 |
| 关闭应用 | closeApp | 支持 | 支持 | / |
| 收起侧边面板 | closeSidebar | / | / | 支持 |
旋转界面
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 旋转界面 | rotateScreenView | 支持 | 支持 | / |
弹窗
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| alert | showAlert | 支持 | 支持 | 支持 |
| confirm | showConfirm | 支持 | 支持 | 支持 |
| prompt | showPrompt | 支持 | 支持 | 支持 |
| toast | showToast | 支持 | 支持 | 支持 |
| preloader（显示） | showPreloader | 支持 | 支持 | / |
| preloader（隐藏） | hidePreloader | 支持 | 支持 | / |
| 弹窗 | showActionSheet | 支持 | 支持 | / |
页面监听
| 接口说明 | JSAPI 名称 | Android | iOS | PC |
|---|---|---|---|---|
| 页面 关闭事件 的回调监听 | 查看详情 | 支持 | 支持 | \ |
| 页面 返回事件 的回调监听 | 查看详情 | 支持 | 支持 | \ |
| 设置截图监听 | setScreenShotListener | 支持 | 支持 | \ |
| 移除截图监听 | removeScreenShotListener | 支持 | 支持 | \ |