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

getLaunchOptions(params: Object)

版本要求:

MiniKit≥1.0.0@ray-js/ray≥0.3.23

支持平台:

iOSAndroid

import { getLaunchOptions } from '@ray-js/ray';

// Promise 调用
try {
  const res = await getLaunchOptions();
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

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

参数

属性	类型	必填	说明
`complete`	() => void	否	接口调用结束的回调函数（调用成功、失败都会执行）
`success`	(params: Object) => void	否	接口调用成功的回调函数
`fail`	(params: Object) => void	否	接口调用失败的回调函数

success 回调参数

属性	类型	说明	MiniKit 最低版本
`path`	string	启动小程序的路径 (代码包路径)	v3.2.0
`scene`	1000 \| 1001 \| 1002	启动小程序的场景值	v3.15.0
		启动小程序的 query 参数	v3.2.0
		分享转发	v3.2.0
`apiCategory`	string	API 类别: default 默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序	v3.2.0
		启动小程序的额外参数，一般指容器附加的参数，非业务参数	v3.21.0
`renderer`	string	渲染类型：native 表示 Lynx 自渲染；空/其它表示 Web	v3.37.0

fail 回调参数

属性	类型	说明
`errorMsg`	string	错误信息
`errorCode`	string \| number	错误码
		错误扩展

返回值

无

合法值

`success.params.scene`

值	说明	MiniKit 最低版本
`1000`	默认值	v3.15.0
`1001`	通过最近使用小程序列表进入	v3.15.0
`1002`	通过URL映射进入	v3.15.0

示例代码

import { getLaunchOptions } from '@ray-js/ray'

getLaunchOptions({
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});