JSAPI总览
轻应用的 JSAPI主要分为两类:
- 调用获取应用或者设备的基础信息,该类 JSAPI 的调用不需要鉴权。
- 轻应用业务相关的部分API,需要开发者先进行鉴权然后再调用。
- 页面加载后,需要鉴权的JSAPI要放到ready中。
系统与设备
| 接口名称 | 接口描述 | 是否鉴权 |
|---|---|---|
| getDeviceInfo | 获取系统信息 | NO |
| getAppInfo | 获取APP信息 | NO |
| getNetworkType | 获取网络状态 | NO |
| scanCode | 扫码 | NO |
通讯录与会话
| 接口名称 | 接口描述 | 是否鉴权 |
|---|---|---|
| selectContacts | 通讯录选人 | YES |
| openUserProfile | 打开联系人详情页 | YES |
| createIMGroupChat | 创建群聊 | YES |
| openIMChat | 打开聊天界面 | YES |
位置
| 接口名称 | 接口描述 | 是否鉴权 |
|---|---|---|
| getLocation | 获取当前地理位置 | YES |
事件
| 接口名称 | 接口描述 | 是否鉴权 |
|---|---|---|
| addEventListener | 添加事件监听,如:回退事件 | NO |
| navigateBack | 返回上级页面 | NO |
媒体
| 接口名称 | 接口描述 | 是否鉴权 |
|---|---|---|
| playAudio | 音频播放 | YES |
鉴权相关
| 接口名称 | 接口描述 | 是否鉴权 |
|---|---|---|
| ready | 页面加载后需要鉴权的JSAPI,需要放在ready中 | NO |
| config | 检验签名信息,并完成注册 | NO |
| error | 鉴权失败,将回调该方法 | NO |
| checkJsApi | 判断JSAPI在当前客户端是否可用 | NO |
其他
| 接口名称 | 接口描述 | 是否鉴权 |
|---|---|---|
| getAuthCode | 获取登录授权码,实现免登,获取当前用户身份等 | NO |
| writeMail | 调起发邮件 | YES |