微信小程序开发 专题
专题目录
您的位置:微信小程序开发 > 微信小程序开发专题 > 微信小程序 API
微信小程序 API
作者:--    发布时间:2019-11-20

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

网站声明:
本站部分内容来自网络,如您发现本站内容
侵害到您的利益,请联系本站管理员处理。
联系站长
373515719@qq.com
关于本站:
编程参考手册