# wx.onAppShow(function listener)

基础库 2.1.2 开始支持,低版本需做兼容处理

小程序插件:不支持

微信 HarmonyOS 版:支持

# 功能描述

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

# 参数

# function listener

小程序切前台事件的监听函数

# 参数

# Object options

启动参数

属性 类型 说明 最低版本
path string 启动小程序的路径 (代码包路径)
scene number 启动小程序的场景值
query Record.<string, string> 启动小程序的 query 参数
shareTicket string shareTicket,详见获取更多转发信息
referrerInfo Object 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 {}。(参见后文注意)
结构属性 类型 说明
appId string 来源小程序、公众号或 App 的 appId
extraData Object 来源小程序传过来的数据,scene=1037或1038时支持
forwardMaterials Array.<Object> 打开的文件信息数组,只有从聊天素材场景打开(scene为1173)才会携带该参数
结构属性 类型 说明
type string 文件的mimetype类型
name string 文件名
path string 文件路径(如果是webview则是url)
size number 文件大小
chatType number 从微信群聊/单聊打开小程序时,chatType 表示具体微信群聊/单聊类型
合法值 说明
1 微信联系人单聊
2 企业微信联系人单聊
3 普通微信群聊
4 企业微信互通群聊
apiCategory string API 类别 2.20.0
合法值 说明
default 默认类别
nativeFunctionalized 原生功能化,视频号直播商品、商品橱窗等场景打开的小程序
browseOnly 仅浏览,朋友圈快照页等场景打开的小程序
embedded 内嵌,通过打开半屏小程序能力打开的小程序

# 返回有效 referrerInfo 的场景

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

# 不同 apiCategory 场景下的 API 限制

X 表示 API 被限制无法使用;不在表格中的 API 不限制。

default nativeFunctionalized browseOnly embedded
navigateToMiniProgram X X
openSetting X
<button open-type="share"> X X X
<button open-type="feedback"> X
<button open-type="open-setting"> X
openEmbeddedMiniProgram X X X

# 注意

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