生命周期

qq.getLaunchOptionsSync

Object qq.getLaunchOptionsSync()

获取小程序启动时的参数。与 App.onLaunch 的回调参数一致。

返回值

Object

启动参数

属性类型说明
pathstring启动小程序的路径
scenenumber启动小程序的场景值
queryObject启动小程序的 query 参数
referrerInfoObject来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 {}。(参见后文注意)

referrerInfo 的结构

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

返回有效 referrerInfo 的场景

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

注意

部分版本在无referrerInfo的时候会返回 undefined,建议使用 options.referrerInfo && options.referrerInfo.appId 进行判断。

qq.exitMiniProgram

qq.exitMiniProgram(Object object)

退出当前小程序

参数

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

应用级事件

qq.onPageNotFound

qq.onPageNotFound(function callback)

监听小程序要打开的页面不存在事件。该事件与 App.onPageNotFound 的回调时机一致。

参数

function callback

小程序要打开的页面不存在事件的回调函数

参数

Object res

属性类型说明
pathstring不存在页面的路径
queryObject打开不存在页面的 query 参数
isEntryPageboolean是否本次启动的首个页面(例如从分享等入口进来,首个页面是开发者配置的分享页面)

注意

  • 开发者可以在回调中进行页面重定向,但必须在回调中同步处理,异步处理(例如 setTimeout 异步执行)无效。
  • 若开发者没有调用 qq.onPageNotFound 绑定监听,也没有声明 App.onPageNotFound,当跳转页面不存在时,将推入QQ客户端原生的页面不存在提示页面。
  • 如果回调中又重定向到另一个不存在的页面,将推入QQ客户端原生的页面不存在提示页面,并且不再第二次回调。

qq.onError

qq.onError(function callback)

监听小程序错误事件。如脚本错误或 API 调用报错等。该事件与 App.onError 的回调时机与参数一致。

参数

function callback

小程序错误事件的回调函数

参数

string error

错误信息,包含堆栈

qq.onAppShow

qq.onAppShow(function callback)

监听小程序切前台事件。该事件与 App.onShow 的回调参数一致。

参数

function callback

小程序切前台事件的回调函数

参数

Object res

属性类型说明
pathstring小程序切前台的路径
scenenumber小程序切前台的场景值
queryObject小程序切前台的 query 参数
referrerInfoObject来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 {}。(参见后文注意)

referrerInfo 的结构

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

返回有效 referrerInfo 的场景

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

注意

部分版本在无referrerInfo的时候会返回 undefined,建议使用 options.referrerInfo && options.referrerInfo.appId 进行判断。

qq.onAppHide

qq.onAppHide(function callback)

监听小程序切后台事件。该事件与 App.onHide 的回调时机一致。

参数

function callback

小程序切后台事件的回调函数

qq.offPageNotFound

qq.offPageNotFound(function callback)

取消监听小程序要打开的页面不存在事件

参数

function callback

小程序要打开的页面不存在事件的回调函数

qq.offError

qq.offError(function callback)

取消监听小程序错误事件。

参数

function callback

小程序错误事件的回调函数

qq.offAppShow

qq.offAppShow(function callback)

取消监听小程序切前台事件

参数

function callback

小程序切前台事件的回调函数

qq.offAppHide

qq.offAppHide(function callback)

取消监听小程序切后台事件

参数

function callback

小程序切后台事件的回调函数