JSAPI总览
系统与设备
| API名称 | 简介 |
|---|---|
| getDeviceInfo | 获取系统信息：包含设备OS类型、设备版本、设备名称 |
| getAppInfo | 获取WeLink APP的信息，如版本号、语言设置等 |
| getWecodeInfo | 获取We码信息 |
| getNetworkType | 获取网络状态 |
| scanQR | 扫码 |
| vibrate | 振动 |
| getConnectedWifi | 获取热点接入信息 |
| horizontalScreen | 横屏 |
网络请求
| API名称 | 简介 |
|---|---|
| fetchInternet | 发起网络请求 |
文件与图片
| API名称 | 简介 |
|---|---|
| chooseImage | 从本地相册选择图片或使用相机拍照 |
| uploadFile | 上传文件 |
| uploadFileOperation | 上传取消任务 |
| downloadFile | 下载文件 |
| downloadFileOperation | 下载取消任务 |
| openFile | 打开文件 |
| removeFile | 删除文件 |
| previewImage | 在线图片预览 |
通讯录与会话
| API名称 | 简介 |
|---|---|
| selectContacts | 通讯录选人 |
| openUserProfile | 打开联系人详情页 |
| createIMGroupChat | 创建群聊 |
| openIMChat | 根据chatID，打开IM聊天界面 |
| makePhoneCall | 拨打电话 |
| openVideoMeeting | 打开视频会议界面 |
| startMeeting | 发起视频和语音会议 |
| audioConferenceDirectly | 打开语音会议界面 2 |
| openMeeting | 跳转到会议主界面 |
位置
| API名称 | 简介 |
|---|---|
| getLocation | 获取当前设备所在地理位置的经纬度，返回值为gcj02坐标 |
分享
| API名称 | 简介 |
|---|---|
| share | 分享 |
We码跳转
| API名称 | 简介 |
|---|---|
| openWebview | 打开We码/网页 |
| close | 关闭We码/页面 |
缓存
| API名称 | 简介 |
|---|---|
| setStorage | 缓存只能存入字符串的内容，暂不支持音频、图片等资源 |
| getStorage | 获取指定key值的缓存 |
| clearStorage | 清理当前We码所有的缓存记录 |
| deletecache | 删除当前We码指定key值的缓存记录 |
界面
| API名称 | 简介 |
|---|---|
| setNavigationBarTitle | 设置导航标题 |
| showToast | 设置吐司信息 |
| showLoading / hideLoading | 动态调用并控制loading组件的显示/隐藏 |
| showExceptionTip | 各类异常提示组件 |
| setWatermark | 设置水印 |
事件
| API名称 | 简介 |
|---|---|
| addEventListener | 添加事件监听，如：回退事件 |
| navigateBack | 返回上级页面 |
| app | 生命周期事件 |
| onNetworkStatusChange | 监听网络状态 |
| onUserCaptureScreen | 监听截屏事件 |
媒体
| API名称 | 简介 |
|---|---|
| recordAudio | 录音 |
| playMedia | 音视频播放 |
| playAudio | 音频播放 |
| getBackgroundAudioManager | 背景音频管理 |
权限管理
| API名称 | 简介 |
|---|---|
| getPermissionList | 获取权限列表 |
| canIUse | 检查JSAPI权限 |
| app | 生命周期事件 |
NFC芯片
| API名称 | 简介 |
|---|---|
| readNFCTagId | 读取NFC芯片ID |
| readNFC | 读取NFC芯片ID和内容 |
| writeNFC | 写NFC芯片 |
其他
| API名称 | 简介 |
|---|---|
| writeMail | 调起发邮件 |
| shareLinkToScreen | 无线投屏 |