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从相册选择视频,或者拍摄
wx.saveFile保存文件

数据 API 列表:

API说明
wx.getStorage获取本地数据缓存
wx.setStorage设置本地数据缓存
wx.clearStorage清理本地数据缓存

位置 API 列表:

API说明
wx.getLocation获取当前位置
wx.openLocation打开内置地图

设备 API 列表:

API说明
wx.getNetworkType获取网络类型
wx.getSystemInfo获取系统信息
wx.onAccelerometerChange监听重力感应数据
wx.onCompassChange监听罗盘数据

界面 API 列表:

API说明
wx.setNavigationBarTitle设置当前页面标题
wx.showNavigationBarLoading显示导航条加载动画
wx.hideNavigationBarLoading隐藏导航条加载动画
wx.navigateTo新窗口打开页面
wx.redirectTo原窗口打开页面
wx.navigateBack退回上一个页面
wx.createAnimation动画
wx.createContext创建绘图上下文
wx.drawCanvas绘图
wx.hideKeyboard隐藏键盘
wx.stopPullDownRefresh停止下拉刷新动画

开放接口:

API说明
wx.login登录
wx.getUserInfo获取用户信息
wx.requestPayment发起微信支付

个结果 ""

    没有找到相关内容 ""