微信小程序 API

由 路飞 创建,Carrie 最后一次修改 2016-09-22

API

框架提供丰富的微信原生API,可以方便的调起微信提供的能力,如获取用户信息,本地存储,支付功能等。

说明:

  • wx.on开头的API是监听某个事件发生的API接口,接受一个CALLBACK函数作为参数。当该事件触发时,会调用CALLBACK函数。
  • 如未特殊约定,其他API接口都接受一个OBJECT作为参数。
  • OBJECT中可以指定success,fail,complete来接收接口调用结果。
参数名类型必填说明
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数
completeFunction接口调用结束的回调函数(调用成功、失败都会执行)

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打开卡券

以上内容是否对您有帮助:
python零基础入门到爬虫实战
二维码
建议反馈
二维码