基础信息说明

功能概述：提供小游戏启动/切换前后台/退出等生命周期的事件监听能力。

项目	说明
版本要求	无
前提条件	无
使用限制	无
相关教程	无

方法说明

方法名	签名	同步/异步	说明
onShow	qg.onShow(Function callback) : void	同步注册，回调异步触发	监听游戏切入前台事件
offShow	qg.offShow(Function callback) : void	同步注册，回调异步触发	取消 onShow 绑定的回调
onHide	qg.onHide(Function callback) : void	同步解绑	监听游戏切入后台事件
offHide	qg.offHide(Function callback) : void	同步解绑	取消 onHide 绑定的回调
getLaunchOptionsSync	qg.getLaunchOptionsSync() : (Object or undefined)	同步	获取小游戏启动时的参数
exitApplication	qg.exitApplication(Object object) : void	同步	退出当前小游戏（将杀掉进程）

参数说明

qg.onShow(Function callback)

属性名	类型	默认值（如有）	必填	说明
callback	Function(Object options)	-	否	接收前台事件回调

callback回调函数的参数 Object res

字段	类型	说明
query	Object	小游戏启动时的 query
referrerInfo	Object	启动来源信息（可能为 {}），见下表

referrerInfo 结构

字段	类型	说明
package	String	来源快应用/小游戏/App 的包名
extraData	Object	来源快应用/小游戏/App 的数据

qg.offShow(Function callback)

属性名	类型	必填	说明
callback	Function	否	需传入与 onShow 绑定时相同的函数引用，才能移除对应监听；空参不会清除全部

qg.onHide(Function callback)

属性名	类型	必填	说明
callback	Function()	是	后台事件回调；无入参，未传函数则不会注册监听

qg.offHide(Function callback)

属性名	类型	必填	说明
callback	Function	否	需传入与 onHide 绑定时相同的函数引用，才能移除对应监听；空参不会清除全部

qg.getLaunchOptionsSync()

返回值可能是Object 或 undefined，当存在时，常见结构包含：

字段	类型	说明
query	Object	小游戏启动时的 query
referrerInfo	Object	启动来源信息（可能为 {}）

referrerInfo 结构：

字段	类型	说明
package	String	来源快应用/小游戏/App 的包名
extraData	Object	来源快应用/小游戏/App 的数据

qg.exitApplication(Object option)

属性名	类型	必填	说明
success	Function	否	调用完成后立即触发，参数为空
fail	Function	否	当前封装未主动触发
complete	Function	否	调用结束后立即触发，参数为空

返回值说明

onShow / offShow / onHide / offHide / exitApplication：无返回值
getLaunchOptionsSync：返回启动参数对象或 undefined

回调结果说明

exitApplication 回调

回调	触发时机	回调参数	说明
success	执行退出逻辑后立即触发	无	当前封装直接调用，不表示真实退出结果
fail	当前封装未主动触发	无	预留，底层未返回错误码
complete	执行退出逻辑后立即触发	无	与 success 同步触发，参数为空

示例代码

const handleShow = res => {
  console.log('App switched to frontground!', res.referrerInfo)
}
qg.onShow(handleShow);

const handleHide = () => {
  console.log('App switched to background!')
}
qg.onHide(handleHide);

qg.offShow(handleShow);

qg.offHide(handleHide);

const launchOption = qg.getLaunchOptionsSync();
console.log('Launch option：', launchOption);

qg.exitApplication({
  success: function () {
    console.info('The application has exited.')
  },
  fail: function () {
    console.info('The application failed to exit!')
  },
  complete: function () {
    console.info('End to exit the application.')
  },
});

注意事项

调用exitApplication后，会先触发onHide，再杀掉进程

上一篇:性能

下一篇:系统

文档内容是否有帮助？

有帮助

无帮助