getLaunchOptionsSync.md 3.4 KB
Newer Older
1 2
### uni.getLaunchOptionsSync()

3
获取启动时的参数。返回值与App.onLaunch的回调参数一致
4

5
|App|web|微信小程序|支付宝小程序|字节跳动小程序|QQ小程序|快手小程序|钉钉小程序|飞书小程序|百度小程序|京东小程序|
6
|:-|:-|:-|:-|:-|:-|:-|:-|:-|:-|:-|
7
|√ `(3.4.10+)`|√ `(见下)`|√|√|√|√|√|√|√|x|x|
8

9 10 11
web平台不同Vue版本支持情况有差异:
- `vue2`项目:uni-app 3.5.1+ 支持
- `vue3`项目:uni-app 3.2.13+ 支持
hbcui1984's avatar
hbcui1984 已提交
12

13 14 15 16
**返回参数说明**

|参数名|类型|说明|平台差异说明|
|:-|:-|:-|:-|
17 18 19 20
|path|String|启动的路径(代码包路径)|其他平台均支持,`字节小程序(1.12.0+)`|
|scene|Number|启动时的场景值,具体值含义请查看各平台文档说明。App、web端恒为 1001。钉钉小程序在 IDE 恒为0000,真机不支持。|其他平台均支持,`字节小程序(1.12.0+)`|
|query|Object|启动时的 query 参数|其他平台均支持,`字节小程序(1.12.0+)`|
|referrerInfo|Object|来源信息。如果没有则返回 `{}`|其他平台均支持,`字节小程序(1.15.0+)``飞书小程序不支持``钉钉小程序不支持`|
雪洛's avatar
雪洛 已提交
21 22
|channel|String|如果应用没有设置渠道标识,则返回空字符串。取值如下|`仅 App 支持`|
|launcher|String|应用启动来源。取值如下|`仅 App 支持`|
23
|forwardMaterials|Array\<Object\>|打开的文件信息数组,只有从聊天素材场景打开(scene为1173)才会携带该参数|`微信小程序``QQ小程序`|
24 25
|entryDataHash|string|群入口信息,通过群应用商店打开、群分享卡片打开的小程序可获得|`仅QQ小程序`|
|chatType|number|打开的文件信息数组,只有从聊天素材场景打开(scene为1173)才会携带该参数|`仅微信小程序`|
26 27
|apiCategory|string|API 类别|`仅微信小程序(2.20.0+)`|
|showFrom|number|唤起小程序的方式,目前取值固定为 10,表示通过 schema 唤起|`仅字节小程序(1.90.0+)`|
雪洛's avatar
雪洛 已提交
28
|mode|'default' \| 'halfPage'|启动小程序的模式|`仅快手小程序`|
29 30 31 32 33 34
|subScene|string|子场景值(定义待补充)|`仅飞书小程序`|

**Object referrerInfo**

|属性|类型|说明|平台差异说明|
|:-|:-|:-|:-|
35 36
|appId|String|来源小程序 appId |其他平台均支持,`字节小程序(1.15.0+)`|
|extraData|Object|来源小程序传过来的数据|其他平台均支持,`字节小程序(1.15.0+)`|
雪洛's avatar
雪洛 已提交
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

**channel 取值**
> 默认提供 `7`  个渠道(`Google`、`360`、`小米`、`华为`、`应用宝`、`vivo`、`oppo`),更多可以在`manifest.json`文件中【源码视图】进行配置,[详情](https://ask.dcloud.net.cn/article/35974)

| 默认渠道     | 渠道标识ID |
| ------------ | -------- |
| GooglePlay   | google   |
| 应用宝       | yyb      |
| 360应用市场  | 360      |
| 华为应用商店 | huawei   |
| 小米应用商店 | xiaomi   |
| vivo应用商店 | vivo|
| oppo应用商店 |  oppo  |

**launcher 取值**

| 值     | 说明 |
| ------------ | -------- |
| default   | 默认启动方式,通常表示应用列表启动(360手助中搜索启动)   |
| scheme       | 通过urlscheme方式触发启动      |
| push  | 通过点击系统通知方式触发启动      |
| uniLink |  通过通用链接(universal link)启动应用  |
| miniProgram |  通过微信小程序启动应用  |
| shortcut | 通过快捷方式启动,iOS平台表示通过3D Touch快捷方式,Android平台表示通过桌面快捷方式启动   |
| barcode | 通过二维码扫描启动|