---
name: "getEnterOptions"
mode: "kit"
versionRequirements:
  - { name: "MiniKit", version: "1.0.0" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "getEnterOptions - 获取本次小程序启动时的参数"
---

## getEnterOptions

> [VERSION] MiniKit >= 1.0.0 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

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

### 参数

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `complete` | `() => void` | 否 | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `path` | `string` | `3.2.0` | 启动小程序的路径 (代码包路径) |
| `scene` | `1000 \| 1001 \| 1002` | `3.15.0` | 启动小程序的场景值 |
| `query` | `Record<string, any>` | `3.2.0` | 启动小程序的 query 参数 |
| `referrerInfo` | `ReferrerInfo` | `3.2.0` | 分享转发 |
| `apiCategory` | `string` | `3.2.0` | API 类别: default	默认类别; embedded 内嵌，通过打开半屏小程序能力打开的小程序 |
| `extraQuery` | `Record<string, any>` | `3.21.0` | 启动小程序的额外参数，一般指容器附加的参数，非业务参数 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 引用对象

##### `interface` ReferrerInfo

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `appId` | `string` | `3.2.0` | 来源小程序的 appId |
| `extraData` | `Record<string, any>` | `3.2.0` | 来源小程序传过来的数据，特定scene支持 |


### 合法值

##### `success.scene` 合法值

| 值 | 说明 |
| --- | --- |
| `1000` | 默认值 |
| `1001` | 通过最近使用小程序列表进入 |
| `1002` | 通过URL映射进入 |


### 示例代码

#### Demo

```tsx
import { getEnterOptions } from '@ray-js/ray'

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