API

框架提供丰富的微信原生API,可以方便的调起微信提供的能力,如获取用户信息,本地存储,支付功能等。
说明:
-
wx.on开头的API是监听某个事件发生的API接口,接受一个CALLBACK函数作为参数。当该事件触发时,会调用CALLBACK函数。
-
如未特殊约定,其他API接口都接受一个OBJECT作为参数。
-
OBJECT中可以指定success,fail,complete来接收接口调用结果。
参数名 |
类型 |
必填 |
说明 |
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 |
打开卡券 |