title: Taro.getEnterOptionsSync()

sidebar_label: getEnterOptionsSync

获取本次小程序启动时的参数。如果当前是冷启动,则返回值与 App.onLaunch 的回调参数一致;如果当前是热启动,则返回值与 App.onShow 一致。

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

支持情况:getEnterOptionsSync - 图1 getEnterOptionsSync - 图2 getEnterOptionsSync - 图3

参考文档

类型

  1. () => EnterOptions

参数

EnterOptions

启动参数

参数 类型 必填 说明
path string 启动小程序的路径
scene number 启动小程序的场景值
query TaroGeneral.IAnyObject 启动小程序的 query 参数
shareTicket string shareTicket,详见获取更多转发信息
referrerInfo ReferrerInfo 来源信息。从另一个小程序、公众号或 App 进入小程序时返回。否则返回 {}。(参见后文注意)
forwardMaterials ForwardMaterial[] 打开的文件信息数组,只有从聊天素材场景打开(scene为1173)才会携带该参数
chatType keyof ChatType 从微信群聊/单聊打开小程序时,chatType 表示具体微信群聊/单聊类型
apiCategory keyof ApiCategory API 类别

ReferrerInfo

来源信息

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

ForwardMaterial

ChatType 类型合法值

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

ChatType

ChatType 类型合法值

参数 说明
1 微信联系人单聊
2 企业微信联系人单聊
3 普通微信群聊
4 企业微信互通群聊

ApiCategory

API 类别合法值

参数 说明
default 默认类别
nativeFunctionalized 原生功能化,视频号直播商品、商品橱窗等场景打开的小程序
browseOnly 仅浏览,朋友圈快照页等场景打开的小程序
embedded 内嵌,通过打开半屏小程序能力打开的小程序