# 生命周期

# qq.onShow

# qq.onShow(function callback)

监听小游戏回到前台的事件

# 参数

# function callback

小游戏回到前台的事件的回调函数

# 参数

Object res

属性 类型 说明
scene string 场景值
query Object 查询参数
shareTicket string shareTicket
referrerInfo Object 当场景为由从另一个小程序或公众号或 App 打开时,返回此字段
entryDataHash string 群入口信息,通过群应用商店打开、群分享卡片打开的小程序可获得
forwardMaterials Array.<Object> 打开的文件信息数组,只有从聊天素材场景打开(scene 为 1173)才会携带该参数

referrerInfo 的结构

属性 类型 说明
appId string 来源小程序或公众号或 App 的 appId
extraData string 来源小程序传过来的数据,scene=1037 或 1038 时支持

forwardMaterials 的结构

属性 类型 说明
type string 文件的 mimetype 类型
name Object 文件名
path string 文件路径(如果是 webview 则是 url)
size number 文件大小

# qq.onHide

# qq.onHide(function callback)

监听小游戏隐藏到后台事件。锁屏、按 HOME 键退到桌面、显示在聊天顶部等操作会触发此事件。

# 参数

# function callback

小游戏隐藏到后台事件的回调函数

# qq.offShow

# qq.offShow(function callback)

取消监听小游戏回到前台的事件

# 参数

# function callback

小游戏回到前台的事件的回调函数

# .offHide

# qq.offHide(function callback)

取消监听小游戏隐藏到后台事件

# 参数

# function callback

小游戏隐藏到后台事件的回调函数

# qq.getLaunchOptionsSync

# Object qq.getLaunchOptionsSync()

获取小游戏冷启动时的参数,热启动参数通过 qq.onShow 接口获取

# 返回值

# Object

启动参数

属性 类型 说明
scene number 启动小游戏的场景值
query Object 启动小游戏的 query 参数
shareTicket string shareTicket,详见获取更多转发信息
referrerInfo Object 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 {}。(参见后文注意)
entryDataHash string 群入口信息,通过群应用商店打开、群分享卡片打开的小游戏可获得
extendData string 启动小游戏时的来源信息

referrerInfo 的结构

属性 类型 说明
appId string 来源小程序、公众号或 App 的 appId
extraData string 来源小程序传过来的数据,scene=1037 或 1038 时支持

# 返回有效 referrerInfo 的场景

场景值 场景 appId 含义
1020 公众号 profile 页相关小程序列表 来源公众号
1035 公众号自定义菜单 来源公众号
1036 App 分享消息卡片 来源 App
1037 小程序打开小程序 来源小程序
1038 从另一个小程序返回 来源小程序
1043 公众号模板消息(已停用) 来源公众号

注意

  • 部分版本在无referrerInfo的时候会返回 undefined,建议使用 options.referrerInfo && options.referrerInfo.appId 进行判断。
  • 从广告投放买量时(senceId=2054),query 中将会增加 qz_gdt 透传投放信息,使用 query.qz_gdt 即可获取;

# qq.exitMiniProgram

# qq.exitMiniProgram(Object object)

退出当前小游戏

# 参数

# Object object
属性 类型 默认值 必填 说明
success function 接口调用成功的回调函数
fail function 接口调用失败的回调函数
complete function 接口调用结束的回调函数(调用成功、失败都会执行)

# 应用级事件

# qq.onError

# qq.onError(function callback)

监听全局错误事件

# 参数

# function callback

全局错误事件的回调函数

# 参数

Object res

属性 类型 说明
message string 错误
stack string 错误调用堆栈

# qq.onAudioInterruptionEnd

# qq.onAudioInterruptionEnd(function callback)

监听音频中断结束事件。在收到 onAudioInterruptionBegin 事件之后,小程序内所有音频会暂停,收到此事件之后才可再次播放成功

# 参数

# function callback

音频中断结束事件的回调函数

# qq.onAudioInterruptionBegin

# qq.onAudioInterruptionBegin(function callback)

监听音频因为受到系统占用而被中断开始事件。以下场景会触发此事件:闹钟、电话、FaceTime 通话、QQ 语音聊天、QQ 视频聊天。此事件触发后,小程序内所有音频会暂停。

# 参数

# function callback

音频因为受到系统占用而被中断开始事件的回调函数

# qq.offError

# qq.offError(function callback)

取消监听全局错误事件

# 参数

# function callback

全局错误事件的回调函数

# qq.offAudioInterruptionEnd

# qq.offAudioInterruptionEnd(function callback)

取消监听音频中断结束事件

# 参数

# function callback

音频中断结束事件的回调函数

# qq.offAudioInterruptionBegin

# qq.offAudioInterruptionBegin(function callback)

取消监听音频因为受到系统占用而被中断开始事件

# 参数

# function callback

音频因为受到系统占用而被中断开始事件的回调函数

# 触摸事件

# qq.onTouchStart

# qq.onTouchStart(function callback)

监听开始触摸事件

# 参数

# function callback

开始触摸事件的回调函数

# 参数

Object res

属性 类型 说明
touches Array.<Touch> 当前所有触摸点的列表
changedTouches Array.<Touch> 触发此次事件的触摸点列表
timeStamp number 事件触发时的时间戳

# qq.onTouchMove

# qq.onTouchMove(function callback)

监听触点移动事件

# 参数

# function callback

触点移动事件的回调函数

# 参数

Object res

属性 类型 说明
touches Array.<Touch> 当前所有触摸点的列表
changedTouches Array.<Touch> 触发此次事件的触摸点列表
timeStamp number 事件触发时的时间戳

# qq.onTouchEnd

# qq.onTouchEnd(function callback)

监听触摸结束事件

# 参数

# function callback

触摸结束事件的回调函数

# 参数

Object res

属性 类型 说明
touches Array.<Touch> 当前所有触摸点的列表
changedTouches Array.<Touch> 触发此次事件的触摸点列表
timeStamp number 事件触发时的时间戳

# qq.onTouchCancel

# qq.onTouchCancel(function callback)

监听触点失效事件

# 参数

# function callback

触点失效事件的回调函数

# 参数

Object res

属性 类型 说明
touches Array.<Touch> 当前所有触摸点的列表
changedTouches Array.<Touch> 触发此次事件的触摸点列表
timeStamp number 事件触发时的时间戳

# qq.offTouchStart

# qq.offTouchStart(function callback)

取消监听开始触摸事件

# 参数

# function callback

开始触摸事件的回调函数

# qq.offTouchMove

# qq.offTouchMove(function callback)

取消监听触点移动事件

# 参数

# function callback

触点移动事件的回调函数

# qq.offTouchEnd

# qq.offTouchEnd(function callback)

取消监听触摸结束事件

# 参数

# function callback

触摸结束事件的回调函数

# qq.offTouchCancel

# qq.offTouchCancel(function callback)

取消监听触点失效事件

# 参数

# function callback

触点失效事件的回调函数

# Touch

在触控设备上的触摸点。通常是指手指或者触控笔在触屏设备或者触摸板上的操作。

# 属性

# number identifier

Touch 对象的唯一标识符,只读属性。一次触摸动作(我们值的是手指的触摸)在平面上移动的整个过程中, 该标识符不变。可以根据它来判断跟踪的是否是同一次触摸过程。

# number screenX

触点相对于屏幕左边沿的 X 坐标。

# number screenY

触点相对于屏幕上边沿的 Y 坐标。