API

基础

系统

系统信息

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

更新

名称	功能说明
qq.getUpdateManager	获取全局唯一的版本更新管理器，用于管理小程序更新

UpdateManager

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

小游戏

生命周期

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

应用级事件

名称	功能说明
qq.onError	监听全局错误事件
qq.onAudioInterruptionEnd	监听音频中断结束事件
qq.onAudioInterruptionBegin	监听音频因为受到系统占用而被中断开始事件
qq.offError	取消监听全局错误事件
qq.offAudioInterruptionEnd	取消监听音频中断结束事件
qq.offAudioInterruptionBegin	取消监听音频因为受到系统占用而被中断开始事件

触摸事件

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

性能

名称	功能说明
qq.triggerGC	加快触发 JavaScriptCore 垃圾回收（Garbage Collection）
qq.getPerformance	获取性能管理器

Performance

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

分包加载

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

LoadSubpackageTask

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

定时器

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

调试

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

console

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

LogManager

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

渲染

画布

名称	功能说明
qq.createCanvas	创建一个画布对象
RenderingContext	画布对象的绘图上下文

Canvas

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

帧率

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

字体

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

图片

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

名称	功能说明
qq.createRewardedVideoAd	创建激励视频广告组件
qq.createBannerAd	创建 banner 广告组件

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

RewardedVideoAd

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

界面

交互

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

键盘

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

菜单

名称	功能说明
qq.getMenuButtonBoundingClientRect	获取菜单按钮（右上角胶囊按钮）的布局位置信息

状态栏

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

窗口

名称	功能说明
qq.onWindowResize	监听窗口尺寸变化事件
qq.offWindowResize	取消监听窗口尺寸变化事件

网络

发起请求

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

RequestTask

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

下载

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

DownloadTask

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

上传

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

UploadTask

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

UDP 通信

名称	功能说明
qq.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 发送消息

WebSocket

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

SocketTask

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

名称	功能说明
qq.updateShareMenu	更新转发属性
qq.showShareMenu	显示当前页面的转发按钮
qq.shareAppMessage	主动拉起转发，进入选择通讯录界面
qq.onShareAppMessage	监听用户点击右上角菜单的「转发」按钮时触发的事件
qq.offShareAppMessage	取消监听用户点击右上角菜单的「转发」按钮时触发的事件
qq.hideShareMenu	隐藏转发按钮
qq.getShareInfo	获取转发详细信息

虚拟支付

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

数据缓存

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

媒体

音频

名称	功能说明
qq.setInnerAudioOption	设置 InnerAudioContext 的播放选项
qq.getAvailableAudioSources	获取当前支持的音频输入源
qq.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	停止

图片

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

录音

名称	功能说明
qq.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	停止录音

视频

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

Video

名称	功能说明
Video.onPlay	监听视频播放事件
Video.destroy	销毁视频
Video.exitFullScreen	视频退出全屏
Video.offEnded	取消监听视频播放到末尾事件
Video.offError	取消监听视频错误事件
Video.offPause	取消监听视频暂停事件
Video.offPlay	取消监听视频播放事件
Video.offTimeUpdate	取消监听视频播放进度更新事件
Video.offWaiting	取消监听视频缓冲事件
Video.onEnded	监听视频播放到末尾事件
Video.onError	监听视频错误事件
Video.onPause	监听视频暂停事件
Video.onTimeUpdate	监听视频播放进度更新事件
Video.onWaiting	监听视频缓冲事件
Video.pause	暂停视频
Video.play	播放视频
Video.requestFullScreen	视频全屏
Video.seek	视频跳转
Video.stop	停止视频

实时语音

名称	功能说明
qq.joinVoIPChat	加入/创建实时通话
qq.exitVoIPChat	退出/销毁实时通话
qq.updateVoIPChatMuteConfig	更新实时语音静音设置
qq.onVoIPChatMembersChanged	实时通话房间成员变更通知
qq.onVoIPChatSpeakersChanged	实时通话成员通话状态变更通知
qq.onVoIPChatInterrupted	实时通话被动断开通知

位置

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

文件

名称	功能说明
qq.getFileSystemManager	获取全局唯一的文件管理器

Stats

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

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 的同步版本

开放接口

用户信息

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

UserInfoButton

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

UserInfo

授权

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

开放数据

名称	功能说明
qq.setUserCloudStorage	对用户托管数据进行写数据操作
qq.removeUserCloudStorage	删除用户托管数据当中对应 key 的数据
qq.getUserCloudStorage	获取当前用户托管数据当中对应 key 的数据
qq.getSharedCanvas	获取主域和开放数据域共享的 sharedCanvas
qq.getGroupCloudStorage	获取群同玩成员的游戏数据
qq.getFriendCloudStorage	拉取当前用户所有同玩好友的托管数据
UserGameData	托管数据
KVData	托管的 KV 数据
OpenDataContext-qq.getUserInfo	在无须用户授权的情况下，批量获取用户信息

开放数据域

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

OpenDataContext

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

数据分析

名称	说明
qq.reportAnalytics	自定义分析数据上报接口

防沉迷

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

意见反馈

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

FeedbackButton

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

设置

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

OpenSettingButton

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

游戏圈

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

GameClubButton

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

设备

电量

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

剪贴板

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

网络

名称	功能说明
qq.onNetworkStatusChange	监听网络状态变化事件
qq.getNetworkType	获取网络类型

屏幕

名称	功能说明
qq.setScreenBrightness	设置屏幕亮度
qq.setKeepScreenOn	设置是否保持常亮状态
qq.getScreenBrightness	获取屏幕亮度

转屏

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

加速计

名称	功能说明
qq.stopAccelerometer	停止监听加速度数据
qq.startAccelerometer	开始监听加速度数据
qq.onAccelerometerChange	监听加速度数据事件

罗盘

名称	功能说明
qq.stopCompass	停止监听罗盘数据
qq.startCompass	开始监听罗盘数据
qq.onCompassChange	监听罗盘数据变化事件

设备方向

名称	功能说明
qq.stopDeviceMotionListening	停止监听设备方向的变化
qq.startDeviceMotionListening	开始监听设备方向的变化
qq.onDeviceMotionChange	监听设备方向变化事件

陀螺仪

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

性能

名称	功能说明
qq.onMemoryWarning	监听内存不足告警事件

振动

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

Worker

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

Worker

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

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

概览

API

基础

系统

系统信息

更新

UpdateManager

小游戏

生命周期

应用级事件

触摸事件

性能

Performance

分包加载

LoadSubpackageTask

定时器

调试

console

LogManager

渲染

画布

Canvas

帧率

字体

图片

广告

BannerAd

RewardedVideoAd

界面

交互

键盘

菜单

状态栏

窗口

网络

发起请求

RequestTask

下载

DownloadTask

上传

UploadTask

UDP 通信

UDPSocket

WebSocket

SocketTask

转发

虚拟支付

数据缓存

媒体

音频

InnerAudioContext

图片

录音

RecorderManager

视频

Video

实时语音

位置

文件

Stats

FileSystemManager

开放接口

用户信息

UserInfoButton

UserInfo

登录

授权

开放数据

开放数据域

OpenDataContext

数据分析

防沉迷

意见反馈

FeedbackButton

设置

OpenSettingButton

游戏圈

GameClubButton

设备

电量