# 生命周期

# qq.getLaunchOptionsSync

# Object qq.getLaunchOptionsSync()

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

# 返回值

# Object

启动参数

属性 类型 说明
path string 启动小程序的路径
scene number 启动小程序的场景值
query Object 启动小程序的 query 参数
referrerInfo Object 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 {}。(参见后文注意)
entryDataHash string 群入口信息,通过群应用商店打开、群分享卡片打开的小程序可获得
forwardMaterials Array. 打开的文件信息数组,只有从聊天素材场景打开(scene为1173)才会携带该参数

referrerInfo 的结构

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

forwardMaterials 的结构

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

# 返回有效 referrerInfo 的场景

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

# 注意

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

# qq.exitMiniProgram

# qq.exitMiniProgram(Object object)

退出当前小程序

# 参数

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

# 应用级事件

# qq.onPageNotFound

# qq.onPageNotFound(function callback)

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

# 参数

# function callback

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

# 参数

Object res

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

# 注意

  • 开发者可以在回调中进行页面重定向,但必须在回调中同步处理,异步处理(例如 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

属性 类型 说明
path string 小程序切前台的路径
scene number 小程序切前台的场景值
query Object 小程序切前台的 query 参数
referrerInfo Object 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 {}。(参见后文注意)
entryDataHash string 群入口信息,通过群应用商店打开、群分享卡片打开的小程序可获得
forwardMaterials Array. 打开的文件信息数组,只有从聊天素材场景打开(scene为1173)才会携带该参数

referrerInfo 的结构

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

forwardMaterials 的结构

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

# 返回有效 referrerInfo 的场景

场景值 场景 appId含义
1020 公众号 profile 页相关小程序列表 来源公众号
1035 公众号自定义菜单 来源公众号
1036 App 分享消息卡片 来源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

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