概览
JSAPI 是对 JSBridge 的一个标准封装， 解决了移动网页能力不足的问题，开放了设备、媒体、存储、分享等几十个 API，让所有开发者都可以使用到 App 的原生能力，去完成一些之前做不到或者难以做到的事情。
JSAPI 接口
基础
| 名称 | 功能说明 |
|---|---|
| ok.canIUse | 判断 API 是否在当前版本可用 |
| ok.getVersion | 获取基础库版本号信息 |
| ok.config | 获取网页应用鉴权 |
界面
| 名称 | 功能说明 |
|---|---|
| ok.showToast | 显示消息提示框 |
| ok.showLoading | 显示 loading 提示框 |
| ok.hideLoading | 隐藏 loading 提示框 |
| ok.showModal | 显示模态对话框 |
| ok.setNavigationBar | 设置导航条 |
| ok.showHistoryBack | 导航栏显示返回按钮 |
| ok.hideHistoryBack | 导航栏隐藏返回按钮 |
| ok.showShareMenu | 导航栏显示分享按钮 |
| ok.hideShareMenu | 导航栏隐藏分享按钮 |
| ok.showNavigationBar | 导航栏隐藏分享按钮 |
| ok.hideNavigationBar | 导航栏隐藏分享按钮 |
设备
| 名称 | 功能说明 |
|---|---|
| ok.getSystemInfo | 获取系统信息 |
| ok.getNetworkType | 获取网络类型 |
| ok.setClipboardData | 设置剪切板内容 |
| ok.getClipboardData | 获取剪切板内容 |
| ok.vibrateLong | 使手机发生较长时间的振动 |
| ok.vibrateShort | 使手机发生较端时间的振动 |
| ok.setScreenBrightness | 设置屏幕亮度 |
| ok.getScreenBrightness | 获取屏幕亮度 |
| ok.setKeepScreenOn | 设置保持常亮状态 |
| ok.scanCode | 调起客户端扫码界面进行扫码 |
| ok.makePhoneCall | 拨打电话 |
| ok.getSysAuthorizeSetting | 获取用户是否开启系统授权 |
| ok.sysAuthorize | 请求系统授权 |
跳转
| 名称 | 功能说明 |
|---|---|
| ok.launchWebView | 打开新页面窗口 |
| ok.launchMiniProgram | 客户端唤起微信小程序 |
| ok.launchNative | 小程序/H5 唤起原生页面 |
| ok.launchApp | 小程序/H5 唤起原生页面 |
媒体
| 名称 | 功能说明 |
|---|---|
| ok.chooseLocalImage | 从本地相册选择图片 |
| ok.clearLocalImage | 清理当前小程序已选的图片数据 |
| ok.chooseLocalVideo | 从本地相册选择视频 |
| ok.startRecord | 开始录音 |
| ok.onRecord | 录音事件监听 |
| ok.stopRecord | 结束录音 |
| ok.clearRecord | 清理当前小程序已录音的临时文件 |
| ok.saveMediaToAlbum | 保存照片或视频到手机系统相册 |
| ok.removeMediaToAlbum | 删除手机系统相册的图片/视频 |
| ok.openDocument | 打开预览文档类型文件（TXT/DOC/EXCEL/PPT/PDF） |
| ok.playAudio | 播放音频文件（MP3/OGG/WAV） |
| ok.playVideo | 播放视频文件（MP4/AVI） |
支付
| 名称 | 功能说明 |
|---|---|
| ok.checkPayApp | 检测当前手机是否安装支付应用程序 |
位置
| 名称 | 功能说明 |
|---|---|
| ok.getLocation | 获取位置信息（经度、纬度） |
文件
| 名称 | 功能说明 |
|---|---|
| ok.chooseLocalFile | 从本地文件中选择文件 |
| ok.saveFile | 保存照片/视频/文件到本地 |
| ok.removeFile | 删除手机某个本地文件 |
| ok.clearFiles | 清理当前小程序已选的文件数据 |
分享
| 名称 | 功能说明 |
|---|---|
| ok.shareAppMessage | 从客户端分享消息至微信社交平台 |
| ok.shareMiniProgramMessage | 客户端分享消息至小程序卡片 |
| ok.shareToWechat | 从客户端分享消息至微信 App 可选择（好友列表/朋友圈） |
| ok.setShareOptions | 设置分享选项内容 |
AI 图像处理
| 名称 | 功能说明 |
|---|---|
| ok.generalBasicOCR | 通用文字识别（OCR） |
| ok.changeFaceAge | 人脸年龄变换 |
| ok.swapFaceGender | 人脸性别变换 |
| ok.makeFaceCartoon | 人脸动漫化 |
| ok.morphFaceGradient | 人脸渐变短视频合成（处理任务） |
| ok.queryFaceGradient | 人脸渐变短视频合成（查询结果） |
| ok.fuseFaceFusion | 人脸融合 |
地理信息类
| 名称 | 功能说明 |
|---|---|
| ok.covertGeoCoding | 地理编码转换（地址位置 -> 经纬度） |
| ok.reverseGeoCoding | 拟地理编码（经纬度 -> 地址位置） |
| ok.getIpLocation | 普通IP定位（IP地址 -> 地址位置） |
| ok.searchRegion | 行政区划查询 |