API 概览
最后更新时间：2025-12-08 15:13:18
基础
系统能力
系统
名称 | 功能说明 | 最低版本 |
异步调用获取系统信息 | 2.0.9 | |
同步调用获取系统信息 | 2.0.9 | |
异步获取系统信息 | 2.0.9 | |
获取窗口信息 | 2.0.9 | |
获取设备设置 | 2.0.9 | |
获取设备基础信息 | 2.0.9 | |
获取宿主客户端基础信息 | 2.0.9 | |
获取宿主客户端授权设置 | 2.0.9 |
更新
名称 | 功能说明 | 最低版本 |
获取全局唯一的版本更新管理器，用于管理小游戏更新 | 2.0.9 | |
强制小游戏重启并使用新版本 | 2.0.9 | |
监听向后台请求检查更新结果事件 | 2.0.9 | |
监听小游戏更新失败事件 | 2.0.9 | |
监听小游戏有版本更新事件 | 2.0.9 |
小程序
名称 | 功能说明 | 最低版本 |
获取小游戏启动时的参数 | 2.0.9 | |
获取本次小游戏启动时的参数 | 2.0.9 | |
监听小程序错误事件 | 2.0.9 | |
移除小程序错误事件的监听函数 | 2.0.9 | |
监听小游戏回到前台的事件 | 2.0.9 | |
监听小游戏隐藏到后台事件 | 2.0.9 | |
移除小游戏回到前台的事件的监听函数 | 2.0.9 | |
移除小游戏隐藏到后台事件的监听函数 | 2.0.9 |
调试
名称 | 功能说明 | 最低版本 |
设置是否打开调试开关 | 2.0.9 | |
获取日志管理器对象 | 2.0.9 | |
向调试面板中打印 debug 日志 | 2.0.9 | |
向调试面板中打印 error 日志 | 2.0.9 | |
在调试面板中创建一个新的分组 | 2.0.9 | |
结束由 console.group 创建的分组 | 2.0.9 | |
向调试面板中打印 info 日志 | 2.0.9 | |
向调试面板中打印 log 日志 | 2.0.9 | |
向调试面板中打印 warn 日志 | 2.0.9 | |
写 debug 日志 | 2.0.9 | |
写 info 日志 | 2.0.9 | |
写 log 日志 | 2.0.9 | |
写 warn 日志 | 2.0.9 | |
添加过滤关键字 | 2.0.9 | |
写 error 日志 | 2.0.9 | |
可以获取当前缓存剩余空间 | 2.0.9 | |
设置实时日志page参数所在的页面 | 2.0.9 | |
写 info 日志 | 2.0.9 | |
设置过滤关键字 | 2.0.9 | |
写 warn 日志 | 2.0.9 |
性能
名称 | 功能说明 | 最低版本 |
加快触发 JavaScriptCore 垃圾回收（Garbage Collection） | 2.0.9 | |
获取性能管理器 | 2.0.9 | |
性能管理器 | 2.0.9 |
分包
名称 | 功能说明 | 最低版本 |
触发分包预下载 | 2.0.9 | |
2.0.9 | ||
加载分包任务实例，用于获取分包加载状态 | 2.0.9 | |
预下载分包任务实例，用于获取分包预下载状态 | 2.0.9 |
跳转
名称 | 功能说明 | 最低版本 |
退出当前小程序 | 2.0.9 | |
打开另一个小程序 | 2.0.9 | |
返回到上一个小程序。只有在当前小程序是被其他小程序打开时可以调用成功 | 2.0.9 |
转发
名称 | 功能说明 | 最低版本 |
隐藏当前页面的转发按钮 | 2.0.9 | |
显示当前页面的转发按钮 | 2.0.9 | |
打开分享图片弹窗 | 2.0.9 | |
监听用户点击右上角菜单的「分享」按钮时触发的事件 | 2.0.9 | |
监听用户点击右上角菜单的「复制链接」按钮时触发的事件 | 2.0.9 | |
移除用户点击右上角菜单的「复制链接」按钮时触发的事件的全部监听函数 | 2.0.9 |
界面
交互
名称 | 功能说明 | 最低版本 |
隐藏 loading 提示框 | 2.0.9 | |
隐藏消息提示框 | 2.0.9 | |
显示操作菜单 | 2.0.9 | |
显示 loading 提示框 | 2.0.9 | |
显示模态对话框 | 2.0.9 | |
显示消息提示框 | 2.0.9 |
菜单
名称 | 功能说明 | 最低版本 |
获取菜单按钮（右上角胶囊按钮）的布局位置信息 | 2.0.9 |
网络
发起请求
名称 | 功能说明 | 最低版本 |
发起 HTTPS 网络请求 | 2.0.9 | |
中断请求任务 | 2.0.9 | |
监听 Transfer-Encoding Chunk Received 事件 | 2.0.9 | |
移除 Transfer-Encoding Chunk Received 事件的监听函数 | 2.0.9 | |
监听 HTTP Response Header 事件 | 2.0.9 | |
移除 HTTP Response Header 事件的监听函数 | 2.0.9 |
上传
名称 | 功能说明 | 最低版本 |
将本地资源上传到服务器 | 2.0.9 | |
中断上传任务 | 2.0.9 | |
监听上传进度变化事件 | 2.0.9 | |
取消监听上传进度变化事件 | 2.0.9 | |
监听 HTTP Response Header 事件 | 2.0.9 | |
移除 HTTP Response Header 事件的监听函数 | 2.0.9 |
下载
名称 | 功能说明 | 最低版本 |
下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求，返回文件的本地临时路径 (本地路径)，单次下载允许的最大文件为200MB | 2.0.9 | |
中断下载任务 | 2.0.9 | |
监听下载进度变化事件 | 2.0.9 | |
移除下载进度变化事件的监听函数 | 2.0.9 | |
监听 HTTP Response Header 事件 | 2.0.9 | |
移除 HTTP Response Header 事件的监听函数 | 2.0.9 |
WebSocket
名称 | 功能说明 | 最低版本 |
通过 WebSocket 连接发送数据。需要先调用 wx.connectSocket，并在 wx.onSocketOpen 回调之后才能发送数据 | 2.0.9 | |
监听 WebSocket 连接打开事件 | 2.0.9 | |
监听 WebSocket 接收到服务器的消息事件 | 2.0.9 | |
监听 WebSocket 错误事件 | 2.0.9 | |
监听 WebSocket 连接关闭事件 | 2.0.9 | |
创建一个 WebSocket 连接 | 2.0.9 | |
关闭最后一次通过 wx.connectSocket 创建的 WebSocket 连接（单例模式） | 2.0.9 | |
关闭当前 SocketTask 实例对应的 WebSocket 连接 | 2.0.9 | |
监听 WebSocket 连接关闭事件 | 2.0.9 | |
监听 WebSocket 错误事件 | 2.0.9 | |
监听 WebSocket 接收到服务器的消息事件 | 2.0.9 | |
监听 WebSocket 连接打开事件 | 2.0.9 | |
通过 WebSocket 连接发送数据 | 2.0.9 |
虚拟支付
名称 | 功能说明 | 最低版本 |
发起道具直购支付请求 | 2.2.4 |
数据缓存
名称 | 功能说明 | 最低版本 |
将数据存储在本地缓存中指定的 key 中 | 2.0.9 | |
将数据存储在本地缓存中指定的 key 中 | 2.0.9 | |
根据 URL 销毁存在内存中的数据 | 2.0.9 | |
从本地缓存中移除指定 key | 2.0.9 | |
removeStorage的同步版本 | 2.0.9 | |
从本地缓存中异步获取指定 key 的内容 | 2.0.9 | |
根据传入的 buffer 创建一个唯一的 URL 存在内存中 | 2.0.9 | |
从本地缓存中同步获取指定 key 的内容 | 2.0.9 | |
异步获取当前 storage 的相关信息 | 2.0.9 | |
getStorageInfo的同步版本 | 2.0.9 | |
清理本地数据缓存 | 2.0.9 | |
clearStorage的同步版本 | 2.0.9 |
渲染
画布
名称 | 功能说明 | 最低版本 |
创建一个画布对象 | 2.0.9 | |
画布对象 | 2.0.9 | |
获取画布对象的绘图上下文 | 2.0.9 | |
把画布上的绘制内容以一个 data URI 的格式返回 | 2.0.9 | |
画布对象的绘图上下文 | 2.0.9 |
帧率
名称 | 功能说明 | 最低版本 |
可以修改渲染帧率 | 2.0.9 | |
取消由 requestAnimationFrame 添加到计划中的动画帧请求 | 2.0.9 | |
在下次进行重绘时执行 | 2.0.9 |
字体
名称 | 功能说明 | 最低版本 |
加载自定义字体文件 | 2.0.9 | |
获取一行文本的行高 | 2.0.9 |
图片
名称 | 功能说明 | 最低版本 |
创建一个图片对象 | 2.0.9 | |
图片对象 | 2.0.9 |
媒体
音频
名称 | 功能说明 | 最低版本 |
设置 InnerAudioContext 的播放选项 | 2.0.9 | |
获取当前支持的音频输入源 | 2.0.9 | |
创建内部 'audio'组件 上下文 InnerAudioContext 对象 | 2.0.9 | |
销毁当前实例 | 2.0.9 | |
移除音频进入可以播放状态的事件的监听函数 | 2.0.9 | |
移除音频自然播放至结束的事件的监听函数 | 2.0.9 | |
移除音频播放错误事件的监听函数 | 2.0.9 | |
移除音频暂停事件的监听函数 | 2.0.9 | |
移除音频播放事件的监听函数 | 2.0.9 | |
移除音频完成跳转操作的事件的监听函数 | 2.0.9 | |
移除音频进行跳转操作的事件的监听函数 | 2.0.9 | |
移除音频停止事件的监听函数 | 2.0.9 | |
移除音频播放进度更新事件的监听函数 | 2.0.9 | |
移除音频加载中事件的监听函数 | 2.0.9 | |
监听音频进入可以播放状态的事件 | 2.0.9 | |
监听音频自然播放至结束的事件 | 2.0.9 | |
监听音频播放错误事件 | 2.0.9 | |
监听音频暂停事件 | 2.0.9 | |
监听音频播放事件 | 2.0.9 | |
监听音频完成跳转操作的事件 | 2.0.9 | |
监听音频进行跳转操作的事件 | 2.0.9 | |
监听音频停止事件 | 2.0.9 | |
监听音频播放进度更新事件 | 2.0.9 | |
监听音频加载中事件 | 2.0.9 | |
暂停 | 2.0.9 | |
播放 | 2.0.9 | |
跳转到指定位置 | 2.0.9 | |
停止 | 2.0.9 |
图片
名称 | 功能说明 | 最低版本 |
从本地相册选择图片或使用相机拍照 | 2.0.9 | |
压缩图片接口，可选压缩质量 | 2.0.9 | |
在新页面中全屏预览图片 | 2.0.9 | |
保存图片到系统相册 | 2.0.9 |
位置
名称 | 功能说明 | 最低版本 |
获取当前的地理位置 速度 | 2.0.9 | |
获取当前的模糊地理位置 | 2.0.9 |
文件
文件概要
名称 | 说明 | 最低版本 |
获取全局唯一的文件管理器 | 2.0.9 | |
文件读取结果 | 2.0.9 | |
文件写入结果 | 2.0.9 |
FileSystemManager
API | 说明 | 最低版本 |
判断文件/目录是否存在 | 2.0.9 | |
FileSystemManager.access 的同步版本 | 2.0.9 | |
在文件结尾追加内容 | 2.0.9 | |
FileSystemManager.appendFile 的同步版本 | 2.0.9 | |
关闭文件 | 2.0.9 | |
同步关闭文件 | 2.0.9 | |
复制文件 | 2.0.9 | |
FileSystemManager.copyFile 的同步版本 | 2.0.9 | |
获取文件的状态信息 | 2.0.9 | |
同步获取文件的状态信息 | 2.0.9 | |
对文件内容进行截断操作 | 2.0.9 | |
同步对文件内容进行截断操作 | 2.0.9 | |
获取该小程序下的 本地临时文件 或 本地缓存文件 信息 | 2.0.9 | |
获取该小程序下已保存的本地缓存文件列表 | 2.0.9 | |
创建目录 | 2.0.9 | |
FileSystemManager.mkdir 的同步版本 | 2.0.9 | |
打开文件，返回文件描述符 | 2.0.9 | |
同步打开文件，返回文件描述符 | 2.0.9 | |
读文件 | 2.0.9 | |
同步读文件 | 2.0.9 | |
读取指定压缩类型的本地文件内容 | 2.0.9 | |
同步读取指定压缩类型的本地文件内容 | 2.0.9 | |
读取目录内文件列表 | 2.0.9 | |
FileSystemManager.readdir 的同步版本 | 2.0.9 | |
读取本地文件内容 | 2.0.9 | |
FileSystemManager.readFile 的同步版本 | 2.0.9 | |
读取压缩包内的文件 | 2.0.9 | |
删除该小程序下已保存的本地缓存文件 | 2.0.9 | |
重命名文件 | 2.0.9 | |
FileSystemManager.rename 的同步版本 | 2.0.9 | |
删除目录 | 2.0.9 | |
FileSystemManager.rmdir 的同步版本 | 2.0.9 | |
保存临时文件到本地 | 2.0.9 | |
FileSystemManager.saveFile 的同步版本 | 2.0.9 | |
获取文件 Stats 对象 | 2.0.9 | |
FileSystemManager.stat 的同步版本 | 2.0.9 | |
对文件内容进行截断操作 | 2.0.9 | |
对文件内容进行截断操作 (truncate 的同步版本) | 2.0.9 | |
删除文件 | 2.0.9 | |
FileSystemManager.unlink 的同步版本 | 2.0.9 | |
解压文件 | 2.0.9 | |
写入文件 | 2.0.9 | |
同步写入文件 | 2.0.9 | |
写文件 | 2.0.9 | |
FileSystemManager.writeFile 的同步版本 | 2.0.9 |
Stats
API | 说明 | 最低版本 |
判断当前文件是否一个目录 | 2.0.9 | |
判断当前文件是否一个普通文件 | 2.0.9 |
开放接口
登录
名称 | 功能说明 | 最低版本 |
调用接口获取登录凭证（code） | 2.0.9 | |
检查登录态是否过期 | 2.0.9 |
账号信息
名称 | 功能说明 | 最低版本 |
获取当前账号信息 | 2.0.9 |
用户信息
名称 | 功能说明 | 最低版本 |
获取用户信息，在使用过程中需要用户授权 scope.userInfo | 2.0.9 | |
用户信息 | 2.0.9 |
设置
名称 | 功能说明 | 最低版本 |
用户授权设置信息 | 2.0.9 | |
获取用户的当前设置 | 2.0.9 | |
调起客户端小程序设置界面，返回用户设置的操作结果 | 2.0.9 |
授权
名称 | 功能说明 | 最低版本 |
提前向用户发起授权请求 | 2.0.9 |
隐私信息授权
名称 | 功能说明 | 最低版本 |
模拟隐私接口调用，并触发隐私弹窗逻辑 | 2.0.9 | |
监听隐私接口需要用户授权事件 | 2.0.9 |
订阅消息
名称 | 功能说明 | 最低版本 |
调起客户端小游戏订阅消息界面，返回用户订阅消息的操作结果 | 2.2.5 |
设备
键盘
名称 | 功能说明 | 最低版本 |
更新键盘输入框内容 | 2.0.9 | |
显示键盘 | 2.0.9 | |
监听键盘输入事件 | 2.0.9 | |
监听键盘高度变化事件 | 2.0.9 | |
监听用户点击键盘 Confirm 按钮时的事件 | 2.0.9 | |
监听键盘收起的事件 | 2.0.9 | |
移除键盘输入事件的监听函数 | 2.0.9 | |
移除键盘高度变化事件的监听函数 | 2.0.9 | |
移除用户点击键盘 Confirm 按钮时的事件的监听函数 | 2.0.9 | |
移除键盘收起的事件的监听函数 | 2.0.9 | |
隐藏键盘 | 2.0.9 |
触摸
名称 | 功能说明 | 最低版本 |
监听开始触摸事件 | 2.0.9 | |
监听触点移动事件 | 2.0.9 | |
监听触摸结束事件 | 2.0.9 | |
监听触点失效事件 | 2.0.9 | |
移除开始触摸事件的监听函数 | 2.0.9 | |
移除触点移动事件的监听函数 | 2.0.9 | |
移除触摸结束事件的监听函数 | 2.0.9 | |
移除触点失效事件的监听函数 | 2.0.9 | |
在触控设备上的触摸点 | 2.0.9 |
电量
名称 | 功能说明 | 最低版本 |
wx.getBatteryInfo 的同步版本 | 2.0.9 | |
获取设备电池信息 | 2.0.9 |
剪切板
名称 | 功能说明 | 最低版本 |
设置系统剪贴板的内容 | 2.0.9 | |
获取系统剪贴板的内容 | 2.0.9 |
网络
名称 | 功能说明 | 最低版本 |
监听网络状态变化事件 | 2.0.9 | |
获取网络类型 | 2.0.9 | |
移除网络状态变化事件的监听函数 | 2.0.9 |
屏幕
名称 | 功能说明 | 最低版本 |
设置截屏/录屏时屏幕表现 | 2.0.9 | |
设置屏幕亮度 | 2.0.9 | |
设置是否保持常亮状态 | 2.0.9 | |
监听用户主动截屏事件 | 2.0.9 | |
监听用户录屏事件 | 2.0.9 | |
用户主动截屏事件 | 2.0.9 | |
移除用户录屏事件的监听函数 | 2.0.9 | |
查询用户是否在录屏 | 2.0.9 | |
获取屏幕亮度 | 2.0.9 |
加速计
名称 | 功能说明 | 最低版本 |
开始监听加速度数据 | 2.0.9 | |
停止监听加速度数据 | 2.0.9 | |
监听加速度数据事件 | 2.0.9 | |
移除加速度数据事件的监听函数 | 2.0.9 |
罗盘
名称 | 功能说明 | 最低版本 |
开始监听罗盘数据 | 2.0.9 | |
停止监听罗盘数据 | 2.0.9 | |
监听罗盘数据变化事件 | 2.0.9 | |
移除罗盘数据变化事件的监听函数 | 2.0.9 |
设备方向
名称 | 功能说明 | 最低版本 |
停止监听设备方向的变化 | 2.0.9 | |
开始监听设备方向的变化 | 2.0.9 | |
监听设备方向变化事件 | 2.0.9 | |
移除设备方向变化事件的监听函数 | 2.0.9 |
转屏
名称 | 功能说明 | 最低版本 |
监听屏幕转向切换事件 | 2.0.9 | |
移除屏幕转向切换事件的监听函数 | 2.0.9 |
陀螺仪
名称 | 功能说明 | 最低版本 |
开始监听陀螺仪数据 | 2.0.9 | |
停止监听陀螺仪数据 | 2.0.9 | |
监听陀螺仪数据变化事件 | 2.0.9 | |
移除陀螺仪数据变化事件的监听函数 | 2.0.9 |
内存
名称 | 功能说明 | 最低版本 |
监听内存不足告警事件 | 2.0.9 | |
移除内存不足告警事件的监听函数 | 2.0.9 |
振动
名称 | 功能说明 | 最低版本 |
使手机发生较短时间的振动（15 ms） | 2.0.9 | |
使手机发生较长时间的振动（400 ms) | 2.0.9 |
Worker
名称 | 功能说明 | 最低版本 |
创建一个 Worker 线程 | 2.0.9 | |
2.0.9 | ||
监听主线程/Worker 线程向当前线程发送的消息的事件 | 2.0.9 | |
向主线程/Worker 线程发送的消息 | 2.0.9 | |
结束当前 Worker 线程 | 2.0.9 |
广告
名称 | 功能说明 | 最低版本 |
创建激励视频广告组件 | 2.2.3 | |
创建 banner 广告组件 | 2.2.3 | |
激励视频广告组件 | 2.2.3 | |
销毁激励视频广告实例 | 2.2.3 | |
加载激励视频广告 | 2.2.3 | |
移除用户点击 关闭广告按钮的事件的监听函数 | 2.2.3 | |
移除激励视频错误事件的监听函数 | 2.2.3 | |
移除激励视频广告加载事件的监听函数 | 2.2.3 | |
监听用户点击 关闭广告按钮的事件 | 2.2.3 | |
监听激励视频错误事件 | 2.2.3 | |
监听激励视频广告加载事件 | 2.2.3 | |
显示激励视频广告 | 2.2.3 | |
banner 广告组件 | 2.2.3 | |
销毁 banner 广告 | 2.2.3 | |
隐藏 banner 广告 | 2.2.3 | |
移除 banner 广告错误事件的监听函数 | 2.2.3 | |
移除 banner 广告加载事件的监听函数 | 2.2.3 | |
移除 banner 广告尺寸变化事件的监听函数 | 2.2.3 | |
监听 banner 广告错误事件 | 2.2.3 | |
监听 banner 广告加载事件 | 2.2.3 | |
监听 banner 广告尺寸变化事件 | 2.2.3 | |
显示 banner 广告 | 2.2.3 |
文档反馈