# getLaunchOptionsSync

获取小程序冷启动时的参数,与 App.onLaunch 的回调参数一致。这是一个同步方法。

注意事项:

  • 通过 Applink 打开小程序 时可以自定义启动页面路径 path 和启动参数 query
  • 这种方式只能获取小程序冷启动时的参数。热启动的参数无法通过这种方式获取,可通过读取App.onShow 方法中传入的参数获取。

# 支持说明

应用能力 Android iOS PC 预览效果
小程序 3.6.0 3.6.0 待开发
扫码预览
用BoosHi扫码或PC端点击
网页应用 X X X /

# 输入

# 输出

返回值:

名称 数据类型 描述
data object
  ∟ path string 小程序启动页面路径
  ∟ query object 小程序启动参数
  ∟ scene string 场景值
  ∟ subScene string 子场景值(定义待补充)
  ∟ mode string 小程序打开模式(仅在PC小程序中返回)

示例代码

try {
    let result = bz.getLaunchOptionsSync();
    console.log(`getLaunchOptionsSync success: ${JSON.stringify(result)}`);
} catch (error) {
    console.log(`getLaunchOptionsSync fail: ${JSON.stringify(error)}`);
}
1
2
3
4
5
6

返回值示例:

{
    "path": "src/page/api/index",
    "subScene": "",
    "scene": "1011",
    "query": {
      "foo": "bar"
    }
}
1
2
3
4
5
6
7
8
最后更新于 : 1/4/2023, 2:39:31 PM