JSAPI总览
轻应用的 JSAPI主要分为两类:
- 调用获取应用或者设备的基础信息,该类 JSAPI 的调用不需要鉴权。
- 轻应用业务相关的部分API,需要开发者先进行鉴权然后再调用。
- 页面加载后,需要鉴权的JSAPI要放到ready中。
| 分类 | 接口说明 | JSAPI名称 | 是否需要鉴权 | Android | iOS | PC-WeLink |
|---|---|---|---|---|---|---|
| 免登 | 获取免登授权码 | getAuthCode | 否 | 支持 | 支持 | 支持 |
| 设备 | 获取系统信息 | getDeviceInfo | 否 | 支持 | 支持 | 支持 |
| 获取当前APP的信息 | getAppInfo | 否 | 支持 | 支持 | 支持 | |
| 获取网络类型 | getNetworkType | 否 | 支持 | 支持 | 支持 | |
| 横屏/取消横屏 | horizontalScreen / offHorizontalScreen | 否 | 支持 | 支持 | 不支持 | |
| 界面 | 设置标题到导航栏 | setNavigationBarTitle | 否 | 支持 | 支持 | 不支持 |
| 位置 | 获取当前地理位置 | getLocation | 是 | 支持 | 支持 | 不支持 |
| H5轻应用跳转 | 关闭当前轻应用 | close | 否 | 支持 | 支持 | 支持 |
| 打开We码小程序 | navigateToWecode | 否 | 支持 | 支持 | 不支持 | |
| 缓存管理 | 设置缓存 | setStorage | 是 | 支持 | 支持 | 支持 |
| 获取缓存 | getStorage | 是 | 支持 | 支持 | 支持 | |
| 清除缓存 | clearStorage | 是 | 支持 | 支持 | 支持 | |
| 删除缓存 | removeStorage | 是 | 支持 | 支持 | 支持 | |
| 事件 | 添加监听事件 | addEventListener | 否 | 支持 | 支持 | 支持 |
| 回到上一个页面 | navigateBack | 否 | 支持 | 支持 | 支持 | |
| 媒体 | 选择图片或使用相机拍照 | chooseImage | 是 | 支持 | 支持 | 支持 |
| 打开在线图片预览界面 | previewImage | 否 | 支持 | 支持 | 支持 | |
| 录音 | recordAudio | 是 | 支持 | 支持 | 不支持 | |
| 音视频播放 | playMedia | 是 | 支持 | 支持 | 支持 | |
| 音频播放 | playAudio | 是 | 支持 | 支持 | 支持 | |
| 开放接口 | 扫码 | scanCode | 否 | 支持 | 支持 | 不支持 |
| 调起选择联系人界面 | selectContacts | 是 | 支持 | 支持 | 支持 | |
| 打开联系人详情页面 | openUserProfile | 是 | 支持 | 支持 | 支持 | |
| 创建IM聊天群组 | createIMGroupChat | 是 | 支持 | 支持 | 支持 | |
| 打开IM聊天界面 | openIMChat | 是 | 支持 | 支持 | 支持 | |
| 调起发邮件页面 | writeMail | 是 | 支持 | 支持 | 支持 | |
| 分享 | share | 是 | 支持 | 支持 | 支持 | |
| 鉴权相关 | 页面加载后需要鉴权的JSAPI,需要放在ready中 | ready | 否 | 支持 | 支持 | 支持 |
| 检验签名信息,并完成注册 | config | 否 | 支持 | 支持 | 支持 | |
| 鉴权失败,将回调该方法 | error | 否 | 支持 | 支持 | 支持 | |
| 判断JSAPI在当前客户端是否可用 | checkJsApi | 否 | 支持 | 支持 | 支持 |