基础

系统

系统信息

名称 功能说明
wx.getSystemInfoSync wx.getSystemInfo 的同步版本
wx.getSystemInfo 获取系统信息

更新

名称 功能说明
wx.updateWeChatApp 更新客户端版本
wx.getUpdateManager 获取全局唯一的版本更新管理器,用于管理小程序更新

UpdateManager

名称 功能说明
UpdateManager.applyUpdate 强制小程序重启并使用新版本
UpdateManager.onCheckForUpdate 监听向微信后台请求检查更新结果事件
UpdateManager.onUpdateFailed 监听小程序更新失败事件
UpdateManager.onUpdateReady 监听小程序有版本更新事件

小程序

生命周期

名称 功能说明
wx.onShow 监听小游戏回到前台的事件
wx.onHide 监听小游戏隐藏到后台事件
wx.offShow 取消监听小游戏回到前台的事件
wx.offHide 取消监听小游戏隐藏到后台事件
wx.getLaunchOptionsSync 获取小游戏启动时的参数
wx.exitMiniProgram 退出当前小游戏

应用级事件

名称 功能说明
wx.onUnhandledRejection 监听未处理的 Promise 拒绝事件
wx.onError 监听全局错误事件
wx.onAudioInterruptionEnd 监听音频中断结束事件
wx.onAudioInterruptionBegin 监听音频因为受到系统占用而被中断开始事件
wx.offUnhandledRejection 取消监听未处理的 Promise 拒绝事件
wx.offError 取消监听全局错误事件
wx.offAudioInterruptionEnd 取消监听音频中断结束事件
wx.offAudioInterruptionBegin 取消监听音频因为受到系统占用而被中断开始事件

触摸事件

名称 功能说明
wx.onTouchStart 监听开始触摸事件
wx.onTouchMove 监听触点移动事件
wx.onTouchEnd 监听触摸结束事件
wx.onTouchCancel 监听触点失效事件
wx.offTouchStart 取消监听开始触摸事件
wx.offTouchMove 取消监听触点移动事件
wx.offTouchEnd 取消监听触摸结束事件
wx.offTouchCancel 取消监听触点失效事件
Touch 在触控设备上的触摸点

键盘事件

名称 功能说明
wx.onKeyUp 监听键盘按键弹起事件,仅适用于 PC 平台
wx.onKeyDown 监听键盘按键按下事件,仅适用于 PC 平台
wx.offKeyUp 取消监听键盘按键弹起事件
wx.offKeyDown 取消监听键盘按键按下事件

鼠标事件

名称 功能说明
wx.onMouseUp 监听鼠标按键弹起事件
wx.onMouseMove 监听鼠标移动事件
wx.onMouseDown 监听鼠标按键按下事件
wx.offMouseUp 取消监听鼠标按键弹起事件
wx.offMouseMove 取消监听鼠标移动事件
wx.offMouseDown 取消监听鼠标按键按下事件

滚轮事件

名称 功能说明
wx.onWheel 监听鼠标滚轮事件
wx.offWheel 取消监听鼠标滚轮事件

性能

名称 功能说明
wx.triggerGC 加快触发 JavaScriptCore 垃圾回收(Garbage Collection)
wx.reportPerformance 小程序测速上报
wx.getPerformance 获取性能管理器

Performance

名称 功能说明
Performance.now 可以获取当前时间以微秒为单位的时间戳

分包加载

名称 功能说明
wx.loadSubpackage 触发分包加载,详见 分包加载

LoadSubpackageTask

名称 功能说明
LoadSubpackageTask.onProgressUpdate 监听分包加载进度变化事件

调试

名称 功能说明
wx.setEnableDebug 设置是否打开调试开关
wx.getLogManager 获取日志管理器对象

console

名称 功能说明
console.debug 向调试面板中打印 debug 日志
console.error 向调试面板中打印 error 日志
console.group 在调试面板中创建一个新的分组
console.groupEnd 结束由 console.group 创建的分组
console.info 向调试面板中打印 info 日志
console.log 向调试面板中打印 log 日志
console.warn 向调试面板中打印 warn 日志

LogManager

名称 功能说明
LogManager.debug 写 debug 日志
LogManager.info 写 info 日志
LogManager.log 写 log 日志
LogManager.warn 写 warn 日志

定时器

名称 功能说明
clearInterval 取消由 setInterval 设置的定时器
clearTimeout 取消由 setTimeout 设置的定时器
setInterval 设定一个定时器
setTimeout 设定一个定时器

渲染

画布

名称 功能说明
wx.createCanvas 创建一个画布对象

Canvas

名称 功能说明
Canvas.getContext 获取画布对象的绘图上下文
Canvas.toDataURL 把画布上的绘制内容以一个 data URI 的格式返回
Canvas.toTempFilePath 将当前 Canvas 保存为一个临时文件
Canvas.toTempFilePathSync Canvas.toTempFilePath 的同步版本
RenderingContext 画布对象的绘图上下文
WebGLRenderingContext.wxBindCanvasTexture 将一个 Canvas 对应的 Texture 绑定到 WebGL 上下文

帧率

名称 功能说明
wx.setPreferredFramesPerSecond 可以修改渲染帧率
cancelAnimationFrame 取消由 requestAnimationFrame 添加到计划中的动画帧请求
requestAnimationFrame 在下次进行重绘时执行

字体

名称 功能说明
wx.loadFont 加载自定义字体文件
wx.getTextLineHeight 获取一行文本的行高

图片

名称 功能说明
wx.createImage 创建一个图片对象
Image 图片对象

鼠标样式

名称 功能说明
wx.setCursor 加载自定义光标,仅支持 PC 平台

广告

名称 功能说明
wx.createRewardedVideoAd 创建激励视频广告组件
wx.createInterstitialAd 创建插屏广告组件
wx.createGridAd 创建 grid(格子) 广告组件
wx.createBannerAd 创建 banner 广告组件

CustomAd

名称 功能说明
CustomAd.offError 取消监听原生模板广告错误事件
CustomAd.offLoad 取消监听原生模板广告加载事件
CustomAd.onClose 监听原生模板广告关闭事件
CustomAd.onError 监听原生模板广告错误事件
CustomAd.onLoad 监听原生模板广告加载事件
CustomAd.show 显示原生模板广告
CustomAd.destroy 销毁原生模板广告
CustomAd.hide 隐藏原生模板广告
CustomAd.isShow 查询原生模板广告展示状态
CustomAd.offClose 取消监听原生模板广告关闭事件

GridAd

名称 功能说明
GridAd.destroy 销毁 grid(格子) 广告
GridAd.hide 隐藏 grid(格子) 广告
GridAd.offError 取消监听 grid(格子) 广告错误事件
GridAd.offLoad 取消监听 grid(格子) 广告加载事件
GridAd.offResize 取消监听 grid(格子) 广告尺寸变化事件
GridAd.onError 监听 grid(格子) 广告错误事件
GridAd.onLoad 监听 grid(格子) 广告加载事件
GridAd.onResize 监听 grid(格子) 广告尺寸变化事件
GridAd.show 显示 grid(格子) 广告

InterstitialAd

名称 功能说明
InterstitialAd.destroy 销毁插屏广告实例
InterstitialAd.load 加载插屏广告
InterstitialAd.offClose 取消监听插屏广告关闭事件
InterstitialAd.offError 取消监听插屏错误事件
InterstitialAd.offLoad 取消监听插屏广告加载事件
InterstitialAd.onClose 监听插屏广告关闭事件
InterstitialAd.onError 监听插屏错误事件
InterstitialAd.onLoad 监听插屏广告加载事件
InterstitialAd.show 显示插屏广告

RewardedVideoAd

名称 功能说明
RewardedVideoAd.destroy 销毁激励视频广告实例
RewardedVideoAd.load 加载激励视频广告
RewardedVideoAd.offClose 取消监听用户点击 关闭广告 按钮的事件
RewardedVideoAd.offError 取消监听激励视频错误事件
RewardedVideoAd.offLoad 取消监听激励视频广告加载事件
RewardedVideoAd.onClose 监听用户点击 关闭广告 按钮的事件
RewardedVideoAd.onError 监听激励视频错误事件
RewardedVideoAd.onLoad 监听激励视频广告加载事件
RewardedVideoAd.show 显示激励视频广告

BannerAd

名称 功能说明
BannerAd.onResize 监听 banner 广告尺寸变化事件
BannerAd.show 显示 banner 广告
BannerAd.destroy 销毁 banner 广告
BannerAd.hide 隐藏 banner 广告
BannerAd.offError 取消监听 banner 广告错误事件
BannerAd.offLoad 取消监听 banner 广告加载事件
BannerAd.offResize 取消监听 banner 广告尺寸变化事件
BannerAd.onError 监听 banner 广告错误事件
BannerAd.onLoad 监听 banner 广告加载事件

界面

交互

名称 功能说明
wx.showToast 显示消息提示框
wx.showModal 显示模态对话框
wx.showLoading 显示 loading 提示框
wx.showActionSheet 显示操作菜单
wx.hideToast 隐藏消息提示框
wx.hideLoading 隐藏 loading 提示框

键盘

名称 功能说明
wx.updateKeyboard 更新键盘输入框内容
wx.showKeyboard 显示键盘
wx.onKeyboardInput 监听键盘输入事件
wx.onKeyboardConfirm 监听用户点击键盘 Confirm 按钮时的事件
wx.onKeyboardComplete 监听监听键盘收起的事件
wx.offKeyboardInput 取消监听键盘输入事件
wx.offKeyboardConfirm 取消监听用户点击键盘 Confirm 按钮时的事件
wx.offKeyboardComplete 取消监听监听键盘收起的事件
wx.hideKeyboard 隐藏键盘

菜单

名称 功能说明
wx.setMenuStyle 动态设置通过右上角按钮拉起的菜单的样式
wx.getMenuButtonBoundingClientRect 获取菜单按钮(右上角胶囊按钮)的布局位置信息

状态栏

名称 功能说明
wx.setStatusBarStyle 当在配置中设置 showStatusBarStyle 时,屏幕顶部会显示状态栏

窗口

名称 功能说明
wx.setWindowSize 设置窗口大小,该接口仅适用于 PC 平台,使用细则请参见指南
wx.onWindowResize 监听窗口尺寸变化事件
wx.offWindowResize 取消监听窗口尺寸变化事件

网络

发起请求

名称 功能说明
wx.request 发起 HTTPS 网络请求

RequestTask

名称 功能说明
RequestTask.abort 中断请求任务
RequestTask.offHeadersReceived 取消监听 HTTP Response Header 事件
RequestTask.onHeadersReceived 监听 HTTP Response Header 事件

下载

名称 功能说明
wx.downloadFile 下载文件资源到本地

DownloadTask

名称 功能说明
DownloadTask.abort 中断下载任务
DownloadTask.offHeadersReceived 取消监听 HTTP Response Header 事件
DownloadTask.offProgressUpdate 取消监听下载进度变化事件
DownloadTask.onHeadersReceived 监听 HTTP Response Header 事件
DownloadTask.onProgressUpdate 监听下载进度变化事件

上传

名称 功能说明
wx.uploadFile 将本地资源上传到服务器

UploadTask

名称 功能说明
UploadTask.abort 中断上传任务
UploadTask.offHeadersReceived 取消监听 HTTP Response Header 事件
UploadTask.offProgressUpdate 取消监听上传进度变化事件
UploadTask.onHeadersReceived 监听 HTTP Response Header 事件
UploadTask.onProgressUpdate 监听上传进度变化事件

WebSocket

名称 功能说明
wx.sendSocketMessage 通过 WebSocket 连接发送数据
wx.onSocketOpen 监听 WebSocket 连接打开事件
wx.onSocketMessage 监听 WebSocket 接受到服务器的消息事件
wx.onSocketError 监听 WebSocket 错误事件
wx.onSocketClose 监听 WebSocket 连接关闭事件
wx.connectSocket 创建一个 WebSocket 连接
wx.closeSocket 关闭 WebSocket 连接

SocketTask

名称 功能说明
SocketTask.close 关闭 WebSocket 连接
SocketTask.onClose 监听 WebSocket 连接关闭事件
SocketTask.onError 监听 WebSocket 错误事件
SocketTask.onMessage 监听 WebSocket 接受到服务器的消息事件
SocketTask.onOpen 监听 WebSocket 连接打开事件
SocketTask.send 通过 WebSocket 连接发送数据

UDP 通信

名称 功能说明
wx.createUDPSocket 创建一个 UDP Socket 实例

UDPSocket

名称 功能说明
UDPSocket.bind 绑定一个系统随机分配的可用端口,或绑定一个指定的端口号
UDPSocket.close 关闭 UDP Socket 实例,相当于销毁
UDPSocket.offClose 取消监听关闭事件
UDPSocket.offError 取消监听错误事件
UDPSocket.offListening 取消监听开始监听数据包消息的事件
UDPSocket.offMessage 取消监听收到消息的事件
UDPSocket.onClose 监听关闭事件
UDPSocket.onError 监听错误事件
UDPSocket.onListening 监听开始监听数据包消息的事件
UDPSocket.onMessage 监听收到消息的事件
UDPSocket.send 向指定的 IP 和 port 发送消息

转发

名称 功能说明
wx.updateShareMenu 更新转发属性
wx.showShareMenu 显示当前页面的转发按钮
wx.shareAppMessage 主动拉起转发,进入选择通讯录界面
wx.setMessageToFriendQuery 设置 wx.shareMessageToFriend 接口 query 字段的值
wx.onShareTimeline 监听用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件
wx.onShareMessageToFriend 监听主域接收 wx.shareMessageToFriend 接口的成功失败通知
wx.onShareAppMessage 监听用户点击右上角菜单的「转发」按钮时触发的事件
wx.onAddToFavorites 监听用户点击菜单「收藏」按钮时触发的事件(安卓7.0.15起支持,iOS 暂不支持)
wx.offShareTimeline 取消监听用户点击右上角菜单的「分享到朋友圈」按钮时触发的事件
wx.offShareAppMessage 取消监听用户点击右上角菜单的「转发」按钮时触发的事件
wx.offAddToFavorites 取消监听用户点击菜单「收藏」按钮时触发的事件
wx.hideShareMenu 隐藏当前页面的转发按钮
wx.getShareInfo 获取转发详细信息

虚拟支付

名称 功能说明
wx.requestMidasPayment 发起米大师支付

数据缓存

名称 功能说明
wx.setStorageSync wx.setStorage 的同步版本
wx.setStorage 将数据存储在本地缓存中指定的 key 中
wx.removeStorageSync wx.removeStorage 的同步版本
wx.removeStorage 从本地缓存中移除指定 key
wx.getStorageSync wx.getStorage 的同步版本
wx.getStorageInfoSync wx.getStorageInfo 的同步版本
wx.getStorageInfo 异步获取当前storage的相关信息
wx.getStorage 从本地缓存中异步获取指定 key 的内容
wx.clearStorageSync wx.clearStorage 的同步版本
wx.clearStorage 清理本地数据缓存

媒体

音频

名称 功能说明
wx.setInnerAudioOption 设置 InnerAudioContext 的播放选项
wx.getAvailableAudioSources 获取当前支持的音频输入源
wx.createInnerAudioContext 创建内部 audio 上下文 InnerAudioContext 对象

InnerAudioContext

名称 功能说明
InnerAudioContext.destroy 销毁当前实例
InnerAudioContext.offCanplay 取消监听音频进入可以播放状态的事件
InnerAudioContext.offEnded 取消监听音频自然播放至结束的事件
InnerAudioContext.offError 取消监听音频播放错误事件
InnerAudioContext.offPause 取消监听音频暂停事件
InnerAudioContext.offPlay 取消监听音频播放事件
InnerAudioContext.offSeeked 取消监听音频完成跳转操作的事件
InnerAudioContext.offSeeking 取消监听音频进行跳转操作的事件
InnerAudioContext.offStop 取消监听音频停止事件
InnerAudioContext.offTimeUpdate 取消监听音频播放进度更新事件
InnerAudioContext.offWaiting 取消监听音频加载中事件
InnerAudioContext.onCanplay 监听音频进入可以播放状态的事件
InnerAudioContext.onEnded 监听音频自然播放至结束的事件
InnerAudioContext.onError 监听音频播放错误事件
InnerAudioContext.onPause 监听音频暂停事件
InnerAudioContext.onPlay 监听音频播放事件
InnerAudioContext.onSeeked 监听音频完成跳转操作的事件
InnerAudioContext.onSeeking 监听音频进行跳转操作的事件
InnerAudioContext.onStop 监听音频停止事件
InnerAudioContext.onTimeUpdate 监听音频播放进度更新事件
InnerAudioContext.onWaiting 监听音频加载中事件
InnerAudioContext.pause 暂停
InnerAudioContext.play 播放
InnerAudioContext.seek 跳转到指定位置
InnerAudioContext.stop 停止

图片

名称 功能说明
wx.saveImageToPhotosAlbum 保存图片到系统相册
wx.previewMedia 预览图片和视频
wx.previewImage 在新页面中全屏预览图片
wx.chooseImage 从本地相册选择图片或使用相机拍照

录音

名称 功能说明
wx.getRecorderManager 获取全局唯一的录音管理器 RecorderManager

RecorderManager

名称 功能说明
RecorderManager.onError 监听录音错误事件
RecorderManager.onFrameRecorded 监听已录制完指定帧大小的文件事件
RecorderManager.onInterruptionBegin 监听录音因为受到系统占用而被中断开始事件
RecorderManager.onInterruptionEnd 监听录音中断结束事件
RecorderManager.onPause 监听录音暂停事件
RecorderManager.onResume 监听录音继续事件
RecorderManager.onStart 监听录音开始事件
RecorderManager.onStop 监听录音结束事件
RecorderManager.pause 暂停录音
RecorderManager.resume 继续录音
RecorderManager.start 开始录音
RecorderManager.stop 停止录音

视频

名称 功能说明
wx.createVideo 创建视频

Video

名称 功能说明
Video.destroy 销毁视频
Video.exitFullScreen 视频退出全屏
Video.offEnded 取消监听视频播放到末尾事件
Video.offError 取消监听视频错误事件
Video.offPause 取消监听视频暂停事件
Video.offPlay 取消监听视频播放事件
Video.offProgress 取消监听视频下载(缓冲)事件
Video.offTimeUpdate 取消监听视频播放进度更新事件
Video.offWaiting 取消监听视频由于需要缓冲下一帧而停止时触发
Video.onEnded 监听视频播放到末尾事件
Video.onError 监听视频错误事件
Video.onPause 监听视频暂停事件
Video.onPlay 监听视频播放事件
Video.onProgress 监听视频下载(缓冲)事件
Video.onTimeUpdate 监听视频播放进度更新事件
Video.onWaiting 监听视频由于需要缓冲下一帧而停止时触发
Video.pause 暂停视频
Video.play 播放视频
Video.requestFullScreen 视频全屏
Video.seek 视频跳转
Video.stop 停止视频

相机

名称 功能说明
wx.createCamera 创建相机

Camera

名称 功能说明
Camera.closeFrameChange 关闭监听帧数据
Camera.destroy 销毁相机
Camera.listenFrameChange 开启监听帧数据
Camera.onAuthCancel 监听用户不允许授权使用摄像头的情况
Camera.onCameraFrame 监听摄像头实时帧数据
Camera.onStop 监听摄像头非正常终止事件,如退出后台等情况
Camera.startRecord 开始录像
Camera.stopRecord 结束录像,成功则返回封面与视频
Camera.takePhoto 拍照,可指定质量,成功则返回图片

视频解码器

名称 功能说明
wx.createVideoDecoder 创建视频解码器,可逐帧获取解码后的数据

VideoDecoder

名称 功能说明
VideoDecoder.getFrameData 获取下一帧的解码数据
VideoDecoder.off 取消监听录制事件
VideoDecoder.on 注册监听录制事件的回调函数
VideoDecoder.remove 移除解码器
VideoDecoder.seek 跳到某个时间点解码
VideoDecoder.start 开始解码
VideoDecoder.stop 停止解码

实时语音

名称 功能说明
wx.updateVoIPChatMuteConfig 更新实时语音静音设置
wx.onVoIPChatSpeakersChanged 监听实时语音通话成员通话状态变化事件
wx.onVoIPChatMembersChanged 监听实时语音通话成员在线状态变化事件
wx.onVoIPChatInterrupted 监听被动断开实时语音通话事件
wx.offVoIPChatSpeakersChanged 取消监听实时语音通话成员通话状态变化事件
wx.offVoIPChatMembersChanged 取消监听实时语音通话成员在线状态变化事件
wx.offVoIPChatInterrupted 取消监听被动断开实时语音通话事件
wx.joinVoIPChat 加入 (创建) 实时语音通话,更多信息可见 实时语音指南
wx.exitVoIPChat 退出(销毁)实时语音通话

位置

名称 功能说明
wx.getLocation 获取当前的地理位置、速度

文件

名称 功能说明
wx.saveFileToDisk 保存文件系统的文件到用户磁盘,仅在 PC 端支持
wx.getFileSystemManager 获取全局唯一的文件管理器

FileSystemManager

名称 功能说明
FileSystemManager.access 判断文件/目录是否存在
FileSystemManager.accessSync FileSystemManager.access 的同步版本
FileSystemManager.appendFile 在文件结尾追加内容
FileSystemManager.appendFileSync FileSystemManager.appendFile 的同步版本
FileSystemManager.copyFile 复制文件
FileSystemManager.copyFileSync FileSystemManager.copyFile 的同步版本
FileSystemManager.getFileInfo 获取该小程序下的 本地临时文件 或 本地缓存文件 信息
FileSystemManager.getSavedFileList 获取该小程序下已保存的本地缓存文件列表
FileSystemManager.mkdir 创建目录
FileSystemManager.mkdirSync FileSystemManager.mkdir 的同步版本
FileSystemManager.readdir 读取目录内文件列表
FileSystemManager.readdirSync FileSystemManager.readdir 的同步版本
FileSystemManager.readFile 读取本地文件内容
FileSystemManager.readFileSync FileSystemManager.readFile 的同步版本
FileSystemManager.removeSavedFile 删除该小程序下已保存的本地缓存文件
FileSystemManager.rename 重命名文件
FileSystemManager.renameSync FileSystemManager.rename 的同步版本
FileSystemManager.rmdir 删除目录
FileSystemManager.rmdirSync FileSystemManager.rmdir 的同步版本
FileSystemManager.saveFile 保存临时文件到本地
FileSystemManager.saveFileSync FileSystemManager.saveFile 的同步版本
FileSystemManager.stat 获取文件 Stats 对象
FileSystemManager.statSync FileSystemManager.stat 的同步版本
FileSystemManager.unlink 删除文件
FileSystemManager.unlinkSync FileSystemManager.unlink 的同步版本
FileSystemManager.unzip 解压文件
FileSystemManager.writeFile 写文件
FileSystemManager.writeFileSync FileSystemManager.writeFile 的同步版本

Stats

名称 功能说明
Stats.isFile 判断当前文件是否一个普通文件
Stats.isDirectory 判断当前文件是否一个目录

开放接口

小程序跳转

名称 功能说明
wx.navigateToMiniProgram 打开另一个小程序

用户信息

名称 功能说明
wx.getUserInfo 获取用户信息
wx.createUserInfoButton 创建用户信息按钮
UserInfo 用户信息

UserInfoButton

名称 功能说明
UserInfoButton.destroy 销毁用户信息按钮
UserInfoButton.hide 隐藏用户信息按钮
UserInfoButton.offTap 取消监听用户信息按钮的点击事件
UserInfoButton.onTap 监听用户信息按钮的点击事件
UserInfoButton.show 显示用户信息按钮

登录

名称 功能说明
wx.login 调用接口获取登录凭证(code)
wx.checkSession 检查登录态是否过期

授权

名称 功能说明
wx.authorize 提前向用户发起授权请求

开放数据

名称 功能说明
wx.shareMessageToFriend 给指定的好友分享游戏信息,该接口只可在开放数据域下使用
wx.setUserCloudStorage 对用户托管数据进行写数据操作
wx.removeUserCloudStorage 删除用户托管数据当中对应 key 的数据
wx.onInteractiveStorageModified 监听成功修改好友的互动型托管数据事件,该接口在游戏主域使用
wx.modifyFriendInteractiveStorage 修改好友的互动型托管数据,该接口只可在开放数据域下使用
wx.getUserInteractiveStorage 获取当前用户互动型托管数据对应 key 的数据
wx.getUserCloudStorage 获取当前用户托管数据当中对应 key 的数据
wx.getSharedCanvas 获取主域和开放数据域共享的 sharedCanvas
wx.getPotentialFriendList 获取可能对游戏感兴趣的未注册的好友名单
wx.getGroupInfo 获取群信息
wx.getGroupCloudStorage 获取群同玩成员的游戏数据
wx.getFriendCloudStorage 拉取当前用户所有同玩好友的托管数据
FriendInfo 用户信息
KVData 托管的 KV 数据
UserGameData 托管数据
OpenDataContext-wx.getUserInfo 在无须用户授权的情况下,批量获取用户信息,仅支持获取自己和好友的用户信息

开放数据域

名称 功能说明
wx.onMessage 监听主域发送的消息
wx.getOpenDataContext 获取开放数据域

OpenDataContext

名称 功能说明
OpenDataContext.postMessage 向开放数据域发送消息

防沉迷

名称 功能说明
wx.checkIsUserAdvisedToRest 根据用户当天游戏时间判断用户是否需要休息

意见反馈

名称 功能说明
wx.createFeedbackButton 创建打开意见反馈页面的按钮

FeedbackButton

名称 功能说明
FeedbackButton.destroy 销毁意见反馈按钮
FeedbackButton.hide 隐藏意见反馈按钮
FeedbackButton.offTap 取消监听意见反馈按钮的点击事件
FeedbackButton.onTap 监听意见反馈按钮的点击事件
FeedbackButton.show 显示意见反馈按钮

设置

名称 功能说明
wx.openSetting 调起客户端小程序设置界面,返回用户设置的操作结果
wx.getSetting 获取用户的当前设置
wx.createOpenSettingButton 创建打开设置页面的按钮
AuthSetting 用户授权设置信息,详情参考权限

OpenSettingButton

名称 功能说明
OpenSettingButton.destroy 销毁打开设置页面按钮
OpenSettingButton.hide 隐藏打开设置页面按钮
OpenSettingButton.offTap 取消监听设置页面按钮的点击事件
OpenSettingButton.onTap 监听设置页面按钮的点击事件
OpenSettingButton.show 显示打开设置页面按钮
SubscriptionsSetting 订阅消息设置

游戏圈

名称 功能说明
wx.createGameClubButton 创建游戏圈按钮

GameClubButton

名称 功能说明
GameClubButton.destroy 销毁游戏圈按钮
GameClubButton.hide 隐藏游戏圈按钮
GameClubButton.offTap 取消监听游戏圈按钮的点击事件
GameClubButton.onTap 监听游戏圈按钮的点击事件
GameClubButton.show 显示游戏圈按钮

客服消息

名称 功能说明
wx.openCustomerServiceConversation 进入客服会话

微信运动

名称 功能说明
wx.getWeRunData 获取用户过去三十天微信运动步数

卡券

名称 功能说明
wx.openCard 查看微信卡包中的卡券
wx.addCard 批量添加卡券

帐号信息

名称 功能说明
wx.getAccountInfoSync 获取当前帐号信息

数据上报

名称 功能说明
wx.reportMonitor 自定义业务数据监控上报接口

订阅消息

名称 功能说明
wx.requestSubscribeSystemMessage 调起小游戏系统订阅消息界面,返回用户订阅消息的操作结果
wx.requestSubscribeMessage 调起客户端小游戏订阅消息界面,返回用户订阅消息的操作结果

设备

iBeacon

名称 功能说明
wx.stopBeaconDiscovery 停止搜索附近的 iBeacon 设备
wx.startBeaconDiscovery 开始搜索附近的 iBeacon 设备
wx.onBeaconUpdate 监听 iBeacon 设备更新事件,仅能注册一个监听
wx.onBeaconServiceChange 监听 iBeacon 服务状态变化事件,仅能注册一个监听
wx.offBeaconUpdate 取消监听 iBeacon 设备更新事件
wx.offBeaconServiceChange 取消监听 iBeacon 服务状态变化事件
wx.getBeacons 获取所有已搜索到的 iBeacon 设备
IBeaconInfo

外围设备

名称 功能说明
wx.onBLEPeripheralConnectionStateChanged 监听当前外围设备被连接或断开连接事件
wx.offBLEPeripheralConnectionStateChanged 取消监听当前外围设备被连接或断开连接事件
wx.createBLEPeripheralServer 建立本地作为外围设备的服务端,可创建多个

BLEPeripheralServer

名称 功能说明
BLEPeripheralServer.addService 添加服务
BLEPeripheralServer.offCharacteristicReadRequest 取消监听已连接的设备请求读当前外围设备的特征值事件
BLEPeripheralServer.offCharacteristicWriteRequest 取消监听已连接的设备请求写当前外围设备的特征值事件
BLEPeripheralServer.onCharacteristicReadRequest 监听已连接的设备请求读当前外围设备的特征值事件
BLEPeripheralServer.onCharacteristicWriteRequest 监听已连接的设备请求写当前外围设备的特征值事件
BLEPeripheralServer.removeService 移除服务
BLEPeripheralServer.startAdvertising 开始广播本地创建的外围设备
BLEPeripheralServer.stopAdvertising 停止广播
BLEPeripheralServer.writeCharacteristicValue 往指定特征值写入数据,并通知已连接的主机,从机的特征值已发生变化,该接口会处理是走回包还是走订阅

低功耗蓝牙

名称 功能说明
wx.setBLEMTU 设置蓝牙最大传输单元
wx.readBLECharacteristicValue 读取低功耗蓝牙设备的特征值的二进制数据值
wx.onBLEConnectionStateChange 监听低功耗蓝牙连接状态的改变事件
wx.onBLECharacteristicValueChange 监听低功耗蓝牙设备的特征值变化事件
wx.notifyBLECharacteristicValueChange 启用低功耗蓝牙设备特征值变化时的 notify 功能,订阅特征值
wx.makeBluetoothPair 蓝牙配对接口,仅安卓使用
wx.getBLEDeviceServices 获取蓝牙设备所有服务(service)
wx.getBLEDeviceRSSI 获取蓝牙设备的信号强度
wx.getBLEDeviceCharacteristics 获取蓝牙设备某个服务中所有特征值(characteristic)
wx.createBLEConnection 连接低功耗蓝牙设备
wx.closeBLEConnection 断开与低功耗蓝牙设备的连接
wx.writeBLECharacteristicValue 向低功耗蓝牙设备特征值中写入二进制数据

蓝牙

名称 功能说明
wx.stopBluetoothDevicesDiscovery 停止搜寻附近的蓝牙外围设备
wx.startBluetoothDevicesDiscovery 开始搜寻附近的蓝牙外围设备
wx.openBluetoothAdapter 初始化蓝牙模块
wx.onBluetoothDeviceFound 监听寻找到新设备的事件
wx.onBluetoothAdapterStateChange 监听蓝牙适配器状态变化事件
wx.getConnectedBluetoothDevices 根据 uuid 获取处于已连接状态的设备
wx.getBluetoothDevices 获取在蓝牙模块生效期间所有已发现的蓝牙设备
wx.getBluetoothAdapterState 获取本机蓝牙适配器状态
wx.closeBluetoothAdapter 关闭蓝牙模块

电量

名称 功能说明
wx.getBatteryInfoSync wx.getBatteryInfo 的同步版本
wx.getBatteryInfo 获取设备电量

剪贴板

名称 功能说明
wx.setClipboardData 设置系统剪贴板的内容
wx.getClipboardData 获取系统剪贴板的内容

网络

名称 功能说明
wx.onNetworkStatusChange 监听网络状态变化事件
wx.offNetworkStatusChange 取消监听网络状态变化事件,参数为空,则取消所有的事件监听
wx.getNetworkType 获取网络类型

屏幕

名称 功能说明
wx.setScreenBrightness 设置屏幕亮度
wx.setKeepScreenOn 设置是否保持常亮状态
wx.onUserCaptureScreen 监听用户主动截屏事件
wx.getScreenBrightness 获取屏幕亮度

加速计

名称 功能说明
wx.stopAccelerometer 停止监听加速度数据
wx.startAccelerometer 开始监听加速度数据
wx.onAccelerometerChange 监听加速度数据事件
wx.offAccelerometerChange 取消监听加速度数据事件,参数为空,则取消所有的事件监听

罗盘

名称 功能说明
wx.stopCompass 停止监听罗盘数据
wx.startCompass 开始监听罗盘数据
wx.onCompassChange 监听罗盘数据变化事件
wx.offCompassChange 取消监听罗盘数据变化事件,参数为空,则取消所有的事件监听

设备方向

名称 功能说明
wx.stopDeviceMotionListening 停止监听设备方向的变化
wx.startDeviceMotionListening 开始监听设备方向的变化
wx.onDeviceMotionChange 监听设备方向变化事件
wx.offDeviceMotionChange 取消监听设备方向变化事件,参数为空,则取消所有的事件监听

转屏

名称 功能说明
wx.onDeviceOrientationChange 监听横竖屏切换事件
wx.offDeviceOrientationChange 取消监听横竖屏切换事件

陀螺仪

名称 功能说明
wx.stopGyroscope 停止监听陀螺仪数据
wx.startGyroscope 开始监听陀螺仪数据
wx.onGyroscopeChange 监听陀螺仪数据变化事件
wx.offGyroscopeChange 取消监听陀螺仪数据变化事件

性能

名称 功能说明
wx.onMemoryWarning 监听内存不足告警事件
wx.offMemoryWarning 取消监听内存不足告警事件

振动

名称 功能说明
wx.vibrateShort 使手机发生较短时间的振动(15 ms)
wx.vibrateLong 使手机发生较长时间的振动(400 ms)

Worker

名称 功能说明
wx.createWorker 创建一个 Worker 线程

Worker

名称 功能说明
Worker.onMessage 监听主线程/Worker 线程向当前线程发送的消息的事件
Worker.postMessage 向主线程/Worker 线程发送的消息
Worker.terminate 结束当前 Worker 线程

推荐组件

名称 功能说明
wx.createGamePortal 创建小游戏推荐弹窗组件
wx.createGameIcon 创建小游戏推荐icon组件
wx.createGameBanner 创建小游戏推荐banner组件

GameBanner

名称 功能说明
GameBanner.destroy 销毁小游戏推荐banner组件,组件销毁后所有方法和事件都将失效
GameBanner.hide 隐藏小游戏推荐banner组件
GameBanner.offError 取消监听小游戏推荐banner组件加载错误事件
GameBanner.offLoad 取消监听小游戏推荐banner组件加载成功事件
GameBanner.offResize 取消监听小游戏推荐banner组件位置或者尺寸改变事件
GameBanner.onError 监听小游戏推荐banner组件加载错误事件
GameBanner.onLoad 监听小游戏推荐banner组件加载成功事件
GameBanner.onResize 监听小游戏推荐banner组件位置或者尺寸改变事件
GameBanner.show 显示小游戏推荐banner组件

GameIcon

名称 功能说明
GameIcon.destroy 销毁小游戏推荐icon组件,组件销毁后所有方法和事件都将失效
GameIcon.hide 隐藏小游戏推荐icon组件
GameIcon.load 小游戏推荐icon组件加载数据接口
GameIcon.offError 取消监听小游戏推荐icon组件加载错误事件
GameIcon.offLoad 取消监听小游戏推荐icon组件加载成功事件
GameIcon.offResize 取消监听小游戏推荐icon组件位置或者尺寸改变事件
GameIcon.onError 监听小游戏推荐icon组件加载错误事件
GameIcon.onLoad 监听小游戏推荐icon组件加载成功事件
GameIcon.onResize 监听小游戏推荐icon组件位置或者尺寸改变事件
GameIcon.show 显示小游戏推荐icon组件

GamePortal

名称 功能说明
GamePortal.destroy 销毁小游戏推荐弹窗组件,组件销毁后,组件的方法和事件都将失效
GamePortal.load 小游戏推荐弹窗组件加载数据接口
GamePortal.offClose 取消监听小游戏推荐弹窗组件的关闭事件
GamePortal.offError 取消监听小游戏推荐弹窗组件加载错误事件
GamePortal.offLoad 取消监听小游戏推荐弹窗组件的数据加载成功事件
GamePortal.onClose 监听小游戏推荐弹窗组件的关闭事件
GamePortal.onError 监听小游戏推荐弹窗组件加载错误事件
GamePortal.onLoad 监听小游戏推荐弹窗组件的数据加载成功事件
GamePortal.show 显示小游戏推荐弹窗组件

游戏对局回放

名称 功能说明
wx.getGameRecorder 获取全局唯一的游戏画面录制对象
wx.createGameRecorderShareButton 创建游戏对局回放分享按钮,返回一个单例对象

GameRecorder

名称 功能说明
GameRecorder.abort 放弃录制游戏画面
GameRecorder.isAtempoSupported 获取是否支持调节录制视频的播放速率
GameRecorder.isFrameSupported 获取是否支持录制游戏画面
GameRecorder.isSoundSupported 获取是否在录制游戏画面的同时支持录制游戏音频的信息
GameRecorder.isVolumeSupported 获取是否支持调节录制视频的音量
GameRecorder.off 取消监听录制事件
GameRecorder.on 注册监听录制事件的回调函数
GameRecorder.pause 暂停录制游戏画面
GameRecorder.resume 恢复录制游戏画面
GameRecorder.start 开始录制游戏画面
GameRecorder.stop 结束录制游戏画面

GameRecorderShareButton

名称 功能说明
GameRecorderShareButton.hide 隐藏游戏对局回放分享按钮
GameRecorderShareButton.offTap 取消监听游戏对局回放分享按钮的点击事件
GameRecorderShareButton.onTap 监听游戏对局回放分享按钮的点击事件
GameRecorderShareButton.show 显示游戏对局回放分享按钮

游戏服务

名称 功能说明
wx.getGameServerManager 获取 全局唯一 的游戏服务管理器

GameServerManager

名称 功能说明
GameServerManager.broadcastInRoom 在房间内广播
GameServerManager.changeSeat 玩家换座位
GameServerManager.createRoom 创建游戏房间
GameServerManager.endGame 结束帧同步
GameServerManager.endStateService 结束游戏状态同步服务
GameServerManager.getFriendsStateData 获取所有好友的在线状态及信息(该接口需要在开放数据域使用)
GameServerManager.getLastRoomInfo 获取最近参与房间的 accessInfo
GameServerManager.getLostFrames 补帧,补帧区间为 [beginFrameId, endFrameId),即左闭右合
GameServerManager.getRoomInfo 获取房间详情
GameServerManager.inviteFriend 邀请好友,该好友的系统状态必须为在线(该接口需要在开放数据域使用)
GameServerManager.joinRoom 加入游戏房间
GameServerManager.kickoutMember 把一名玩家踢出房间(仅房主有权限)
GameServerManager.login 登录游戏服务
GameServerManager.logout 登出游戏服务
GameServerManager.memberLeaveRoom 普通成员退出房间
GameServerManager.offBeKickedOut 取消监听自己被踢出当前房间
GameServerManager.offBroadcast 取消监听收到同个房间内的广播消息
GameServerManager.offDisconnect 取消监听断开连接,收到此事件
GameServerManager.offGameEnd 取消监听帧同步游戏结束
GameServerManager.offGameStart 取消监听帧同步游戏开始
GameServerManager.offInvite 取消监听接收邀请,当用户确认邀请之后会收到此事件
GameServerManager.offLockStepError 取消监听帧同步出错
GameServerManager.offLogout 取消监听用户登出游戏服务事件
GameServerManager.offRoomInfoChange 取消监听房间信息更新
GameServerManager.offStateUpdate 取消监听好友在线状态变更(该接口需要在开放数据域使用)
GameServerManager.offSyncFrame 取消监听收到同个房间的帧同步消息
GameServerManager.onBeKickedOut 监听自己被踢出当前房间
GameServerManager.onBroadcast 监听收到同个房间内的广播消息
GameServerManager.onDisconnect 监听断开连接,收到此事件后,需要调用 GameServerManager.reconnect 进行重连
GameServerManager.onGameEnd 监听帧同步游戏结束
GameServerManager.onGameStart 监听帧同步游戏开始
GameServerManager.onInvite 监听接收邀请,当用户确认邀请之后会收到此事件
GameServerManager.onLockStepError 监听帧同步出错
GameServerManager.onLogout 监听用户登出游戏服务事件,可能是主动登出也可能是其他原因被动登出
GameServerManager.onRoomInfoChange 监听房间信息更新
GameServerManager.onStateUpdate 监听好友在线状态变更(该接口需要在开放数据域使用)
GameServerManager.onSyncFrame 监听收到同个房间的帧同步消息
GameServerManager.ownerLeaveRoom 房主退出房间,assign_owner_to_pos_num 参数被优先处理,其次是 assign_to_min_pos_num,如果二者都没有被设置,则房主退出且房间销毁
GameServerManager.reconnect 重连游戏服务
GameServerManager.restart 重启游戏并进入"组队中"的状态
GameServerManager.setInviteData 设置邀请好友附带的数据
GameServerManager.setState 更新玩家状态信息
GameServerManager.startGame 启动帧同步
GameServerManager.startStateService 开启状态管理服务,只有开启状态管理服务,才能获取在线好友列表以及接收好友邀请
GameServerManager.updateReadyStatus 更新玩家准备信息
GameServerManager.uploadFrame 上传游戏帧

第三方平台

名称 功能说明
wx.getExtConfigSync wx.getExtConfig 的同步版本
wx.getExtConfig 获取第三方平台自定义的数据字段