首页  思维导图  详情

微信小程序API

2020-11-04 14:57:46   0  举报





AI智能生成

微信小程序API

作者其他创作

大纲/内容

位置API

wx.getLocation(object)

获取当前的地理位置、速度。

type

wgs84

gps

gcj02

返回可用于wx.openLocation 的坐标

latitude

纬度

longititude

经度

accuracy

位置的精确度

wx.chooseLocation(object)

打开地图选择位置

wx.openLocation(object)

使用微信内置地图查看位置

设备API

wx.getNetworkType(object)

获取网络类型。

wx.getNetworkType({
  success: function(res) {
    var networkType = res.networkType // 返回网络类型2g，3g，4g，wifi
  }
})

wx.getSystemInfo(object)

获取系统信息。

wx.getSystemInfoSync()

获取系统信息同步接口

wx.onAccelerometerChange(callback)

监听重力感应数据，频率：5次/秒

wx.onCompassChange(callback)

监听罗盘数据，频率：5次/秒

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.navigateBack可以返回到原页面。

wx.redirectTo(object)

关闭当前页面，跳转到应用内的某个页面

wx.navigationBack(object)

关闭当前页面，返回上一页面或多级页面。可通过 getCurrentPages()) 获取当前的页面栈，决定需要返回几层。

动画

wx.createAnimation(object)

创建一个动画实例animation。调用实例的方法来描述动画。最后通过动画实例的export方法导出动画数据传递给组件的animation属性。

animation

绘图

wx.createContext()

创建并返回绘图上下文context对象。

context

context只是一个记录方法调用的容器，用于生成记录绘制行为的actions数组。context跟<canvas/>不存在对应关系，一个context生成画布的绘制动作数组可以应用于多个<canvas/>。

wx.drawCanvas(object)

wx.canvasToTempFilePath(object)

把当前画布的内容导出生成图片，并返回文件路径

其它

wx.hideKeyboard()

收起键盘

wx.stopPullDownRefresh()

停止当前页面下拉刷新。详见页面相关事件处理函数。

开放接口

wx.login(object)

调用接口获取登录凭证（code）进而换取用户登录态信息，包括用户的唯一标识（openid）及本次登录的会话密钥（session_key）。用户数据的加解密通讯需要依赖会话密钥完成。

子主题

总述

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

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

OBJECT中可以指定success, fail, complete来接收接口调用结果。

参数名	类型	必填	说明
success	Function	否	接口调用成功的回调函数
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

网络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 请求，返回文件的本地临时路径。

OBJECT参数说明：

注：文件的临时路径，在小程序本次启动期间可以正常使用，如需持久保存，需在主动调用 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)

监听WebSocket关闭。

媒体API

图片

wx.chooseImage(object)

从本地相册选择图片或使用相机拍照。

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

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)

新开页面打开文档，支持格式：doc, xls, ppt, pdf, docx, xlsx, pptx

视频

wx.chooseVideo(object)

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

音频组件控制

wx.createAudioContext(audiold)

创建并返回 audio 上下文 audioContext 对象

视频组件控制

wx.createVideoContext(videold)

数据API

数据缓存

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

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

wx.setStorage(object)

将数据存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个异步接口。

wx.setSrorageSync(key,data)

将 data 存储在本地缓存中指定的 key 中，会覆盖掉原来该 key 对应的内容，这是一个同步接口。

wx.getStorage(object)

从本地缓存中异步获取指定 key 对应的内容。

wx.getStorageSync(key)

从本地缓存中同步获取指定 key 对应的内容

wx.getStorageInfo(object)

异步获取当前storage的相关信息

wx.getStorageInfoSync()