基础库 2.9.4 开始支持,低版本需做兼容处理。
微信小程序插件:支持,需要微信小程序基础库版本不低于 2.9.4
微信 Windows 版:支持
微信 Mac 版:支持
微信 鸿蒙 OS 版:支持
功能描述
获取本次微信小程序启动时的参数。如果当前是冷启动,则返回值与 App.onLaunch 的回调参数一致;如果当前是热启动,则返回值与 App.onShow 一致。
返回值
Object
启动参数
| 属性 | 类型 | 说明 | 最低版本 | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| path | string | 启动微信小程序的路径 (代码包路径) | ||||||||||||||||||||||
| scene | number | 启动微信小程序的场景值 | ||||||||||||||||||||||
| query | Record. | 启动微信小程序的 query 参数 | ||||||||||||||||||||||
| shareTicket | string | shareTicket,详见获取更多转发信息 | ||||||||||||||||||||||
| referrerInfo | Object | 来源信息。从另一个微信小程序、公众号或 App 进入微信小程序时返回。否则返回 {}。(参见后文注意) | ||||||||||||||||||||||
| ||||||||||||||||||||||||
| forwardMaterials | Array.<Object> | 打开的文件信息数组,只有从聊天素材场景打开(scene为1173)才会携带该参数 | ||||||||||||||||||||||
| ||||||||||||||||||||||||
| chatType | number | 从微信群聊/单聊打开微信小程序时,chatType 表示具体微信群聊/单聊类型 | ||||||||||||||||||||||
| ||||||||||||||||||||||||
| hostExtraData | Object | 宿主传递的数据,第三方 app 中运行微信小程序时返回 | ||||||||||||||||||||||
| ||||||||||||||||||||||||
| apiCategory | string | API 类别 | 2.20.0 | |||||||||||||||||||||
| ||||||||||||||||||||||||
返回有效 referrerInfo 的场景
| 场景值 | 场景 | appId含义 |
|---|---|---|
| 1020 | 公众号 profile 页相关微信小程序列表 | 来源公众号 |
| 1035 | 公众号自定义菜单 | 来源公众号 |
| 1036 | App 分享消息卡片 | 来源App |
| 1037 | 微信小程序打开微信小程序 | 来源微信小程序 |
| 1038 | 从另一个微信小程序返回 | 来源微信小程序 |
| 1043 | 公众号模板消息 | 来源公众号 |
不同 apiCategory 场景下的 API 限制
X 表示 API 被限制无法使用;不在表格中的 API 不限制。
| default | nativeFunctionalized | browseOnly | embedded | chatTool | |
|---|---|---|---|---|---|
| openSetting | X | ||||
<button open-type="share"> | X | X | X | X | |
<button open-type="feedback"> | X | ||||
<button open-type="open-setting"> | X | ||||
| navigateToMiniProgram | X | X | X | ||
| openEmbeddedMiniProgram | X | X | X | X | |
| openOfficialAccountArticle | X | ||||
| openChannelsUserProfile | X | ||||
| ad | X | ||||
| ad-custom | X | ||||
| 微信小程序菜单分享 | X |
注意
部分版本在无 referrerInfo 的时候会返回 undefined,建议使用 options.referrerInfo && options.referrerInfo.appId 进行判断。