微信小程序API

微信小程序接口

位置API

wx.getLocation(object)

span style=\

type

wgs84

gps

gcj02

返回可用于wx.openLocation 的坐标

latitude

纬度

longititude

经度

accuracy

位置的精确度

wx.chooseLocation(object)

wx.openLocation(object)

设备API

wx.getNetworkType(object)

pre style=\

wx.getSystemInfo(object)

wx.getSystemInfoSync()

wx.onAccelerometerChange(callback)

wx.onCompassChange(callback)

wx.mackPhoneCall(object)

拨打电话

界面API

交互反馈

wx.showToast(object)

wx.hideToast()

wx.showModal(object)

wx.showActionSheet(object)

设置导航条

wx.setNavigationBarTitle(object)

wx.showNavigationBarLoading()

wx.hideNavigationBarLoading()

导航

wx.navigateTo(object)

wx.redirectTo(object)

wx.navigationBack(object)

动画

wx.createAnimation(object)

animation

绘图

wx.createContext()

context

code style=\

wx.drawCanvas(object)

wx.canvasToTempFilePath(object)

其它

wx.hideKeyboard()

wx.stopPullDownRefresh()

开放接口

wx.login(object)

子主题

总述

wx.on 开头的 API 是监听某个事件发生的API接口，接受一个 CALLBACK 函数作为参数。当该事件触发时，会调用 CALLBACK 函数。

如未特殊约定，其他 API 接口都接受一个OBJECT作为参数。

table style=\

网络API

发起请求

wx.request(OBJECT)

wx.request发起的是https请求。一个微信小程序，同时只能有5个网络请求连接。

OBJECT参数说明

上传下载

wx.uploadFile(OBJECT)

将本地资源上传到开发者服务器。如页面通过 wx.chooseImage 等接口获取到一个本地资源的临时文件路径后，可通过此接口将本地资源上传到指定服务器。客户端发起一个 HTTPS POST 请求，其中 Content-Type 为 multipart/form-data 。

OBJECT参数说明：

success返回参数说明：

wx.downloadFile(OBJECT)

下载文件资源到本地。客户端直接发起一个 HTTP GET 请求，返回文件的本地临时路径。

注：文件的临时路径，在小程序本次启动期间可以正常使用，如需持久保存，需在主动调用 wx.saveFile，在小程序下次启动时才能访问得到。

WebSocket

wx.connectSocket(object)

创建一个 WebSocket 连接；一个微信小程序同时只能有一个 WebSocket 连接，如果当前已存在一个 WebSocket 连接，会自动关闭该连接，并重新创建一个 WebSocket 连接。

wx.onSocketOpen(callback)

监听WebSocket连接打开事件。

wx.onSocketError(callback)

监听WebSocket错误。

wx.sendSocketMessage(object)

通过 WebSocket 连接发送数据，需要先 wx.connectSocket，并在 wx.onSocketOpen 回调之后才能发送。

wx.onSocketMessage(callback)

监听WebSocket接受到服务器的消息事件。

wx.closeSocket()

关闭WebSocket连接。

wx.onSocketClose(callback)

媒体API

图片

wx.chooseImage(object)

wx.previewImage(object)

预览图片

wx.getImageInfo(object)

录音

wx.startRecord(object)

开始录音。当主动调用wx.stopRecord，或者录音超过1分钟时自动结束录音，返回录音文件的临时文件路径。

wx.stolpRecord()

主动调用停止录音。

音频播放控制

wx.playVoice(object)

开始播放语音，同时只允许一个语音文件正在播放，如果前一个语音文件还没播放完，将中断前一个语音播放。

wx.pauseVoice()

暂停正在播放的语音。再次调用wx.playVoice播放同一个文件时，会从暂停处开始播放。如果想从头开始播放，需要先调用 wx.stopVoice。

wx.stopVoice()

结束播放语音。

音乐播放控制

wx.getBackgroundAudioPlayerState(object)

获取音乐播放状态。

wx.playBackgroundAudio(object)

播放音乐，同时只能有一首音乐正在播放。

wx.pauseBackgroundAudio()

wx.seekBackgroundAudio(object)

wx.stopBackgroundAudio()

wx.onBackgroundAudioPlay(callback)

wx.onBackgroundAudioPause(callback)

wx.onBackgroundAudioStop(callback)

文件

wx.saveFile(object)

wx.getSavedFileList(object)

wx.getSavedFileInfo(object)

wx.removeSaveFile(object)

wx.openDocument(object)

视频

wx.chooseVideo(object)

拍摄视频或从手机相册中选视频，返回视频的临时文件路径。

音频组件控制

wx.createAudioContext(audiold)

视频组件控制

wx.createVideoContext(videold)

数据API

数据缓存

每个微信小程序都可以有自己的本地缓存，可以通过 wx.setStorage（wx.setStorageSync）、wx.getStorage（wx.getStorageSync）、wx.clearStorage（wx.clearStorageSync）可以对本地缓存进行设置、获取和清理。本地缓存最大为10MB。

注意： localStorage 是永久存储的，但是我们不建议将关键信息全部存在 localStorage，以防用户换设备的情况。

wx.setStorage(object)

wx.getStorage(object)

wx.getStorageSync(key)

wx.getStorageInfo(object)

wx.getStorageInfoSync()

wx.removeStorage(object)

wx.removeStorageSync(key)

wx.clearStorage()

wx.clearStorageSync()