框架提供丰富的微信原生api,可以方便的调起微信提供的能力,如获取用户信息,本地存储,支付功能等。
说明:
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| success | function | 否 | 接口调用成功的回调函数 |
| fail | function | 否 | 接口调用失败的回调函数 |
| complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
api列表:
网络api列表:
| api | 说明 |
|---|---|
| wx.request | 发起网络请求 |
| wx.uploadfile | 上传文件 |
| wx.downloadfile | 下载文件 |
| wx.connectsocket | 创建websocket连接 |
| wx.onsocketopen | 监听websocket打开 |
| wx.onsocketerror | 监听websocket错误 |
| wx.sendsocketmessage | 发送websocket消息 |
| wx.onsocketmessage | 接受websocket消息 |
| wx.closesocket | 关闭websocket连接 |
| wx.onsocketclose | 监听websocket关闭 |
媒体api列表:
| api | 说明 |
|---|---|
| wx.chooseimage | 从相册选择图片,或者拍照 |
| wx.previewimage | 预览图片 |
| wx.startrecord | 开始录音 |
| wx.stoprecord | 结束录音 |
| wx.playvoice | 播放语音 |
| wx.pausevoice | 暂停播放语音 |
| wx.stopvoice | 结束播放语音 |
| wx.getbackgroundaudioplayerstate | 获取音乐播放状态 |
| wx.playbackgroundaudio | 播放音乐 |
| wx.pausebackgroundaudio | 暂停播放音乐 |
| wx.seekbackgroundaudio | 控制音乐播放进度 |
| wx.stopbackgroundaudio | 停止播放音乐 |
| wx.onbackgroundaudioplay | 监听音乐开始播放 |
| wx.onbackgroundaudiopause | 监听音乐暂停 |
| wx.onbackgroundaudiostop | 监听音乐结束 |
| wx.choosevideo | 从相册选择视频,或者拍摄 |
文件 api 列表:
| api | 说明 |
|---|---|
| wx.savefile | 保存文件 |
| wx.getsavedfilelist | 获取已保存的文件列表 |
| wx.getsavedfileinfo | 获取已保存的文件信息 |
| wx.removesavedfile | 删除已保存的文件信息 |
| wx.opendocument | 打开文件 |
数据 api 列表:
| api | 说明 |
|---|---|
| wx.getstorage | 获取本地数据缓存 |
| wx.getstoragesync | 获取本地数据缓存 |
| wx.setstorage | 设置本地数据缓存 |
| wx.setstoragesync | 设置本地数据缓存 |
| wx.getstorageinfo | 获取本地缓存的相关信息 |
| wx.getstorageinfosync | 获取本地缓存的相关信息 |
| wx.removestorage | 删除本地缓存内容 |
| wx.removestoragesync | 删除本地缓存内容 |
| wx.clearstorage | 清理本地数据缓存 |
| wx.clearstoragesync | 清理本地数据缓存 |
位置 api 列表:
| api | 说明 |
|---|---|
| wx.getlocation | 获取当前位置 |
| wx.chooselocation | 打开地图选择位置 |
| wx.openlocation | 打开内置地图 |
| wx.createmapcontext | 地图组件控制 |
设备 api 列表:
| api | 说明 |
|---|---|
| wx.getnetworktype | 获取网络类型 |
| wx.onnetworkstatuschange | 监听网络状态变化 |
| wx.getsysteminfo | 获取系统信息 |
| wx.getsysteminfosync | 获取系统信息 |
| wx.onaccelerometerchange | 监听加速度数据 |
| wx.startaccelerometer | 开始监听加速度数据 |
| wx.stopaccelerometer | 停止监听加速度数据 |
| wx.oncompasschange | 监听罗盘数据 |
| wx.startcompass | 开始监听罗盘数据 |
| wx.stopcompass | 停止监听罗盘数据 |
| wx.setclipboarddata | 设置剪贴板内容 |
| wx.getclipboarddata | 获取剪贴板内容 |
| wx.makephonecall | 拨打电话 |
| wx.scancode | 扫码 |
界面 api 列表:
| api | 说明 |
|---|---|
| wx.showtoast | 显示提示框 |
| wx.showloading | 显示加载提示框 |
| wx.hidetoast | 隐藏提示框 |
| wx.hideloading | 隐藏提示框 |
| wx.showmodal | 显示模态弹窗 |
| wx.showactionsheet | 显示菜单列表 |
| wx.setnavigationbartitle | 设置当前页面标题 |
| wx.shownavigationbarloading | 显示导航条加载动画 |
| wx.hidenavigationbarloading | 隐藏导航条加载动画 |
| wx.navigateto | 新窗口打开页面 |
| wx.redirectto | 原窗口打开页面 |
| wx.switchtab | 切换到 tabbar 页面 |
| wx.navigateback | 退回上一个页面 |
| wx.createanimation | 动画 |
| wx.createcanvascontext | 创建绘图上下文 |
| wx.drawcanvas | 绘图 |
| wx.stoppulldownrefresh | 停止下拉刷新动画 |
wxml节点信息 api 列表:
| api | 说明 |
|---|---|
| wx.createselectorquery | 创建查询请求 |
| selectorquery.select | 根据选择器选择单个节点 |
| selectorquery.selectall | 根据选择器选择全部节点 |
| selectorquery.selectviewport | 选择显示区域 |
| nodesref.boundingclientrect | 获取布局位置和尺寸 |
| nodesref.scrolloffset | 获取滚动位置 |
| nodesref.fields | 获取任意字段 |
| selectorquery.exec | 执行查询请求 |
开放接口:
| api | 说明 |
|---|---|
| wx.login | 登录 |
| wx.getuserinfo | 获取用户信息 |
| wx.chooseaddress | 获取用户收货地址 |
| wx.requestpayment | 发起微信支付 |
| wx.addcard | 添加卡券 |
| wx.opencard | 打开卡券 |