---
name: "openGuideScene"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.4.32" }
title: "openGuideScene - 跳转场景引导页面"
---

## openGuideScene

> [VERSION] @ray-js/ray >= 1.4.32

### 描述

跳转场景引导页面

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `params` | `OpenGuideScene` | 否 | 引导页参数 |

### 返回值

类型: `Promise<void>`

跳转结果的 Promise，成功时 resolve，失败时 reject

### 引用对象

##### `type` OpenGuideScene

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `action` | `"add" \| "edit"` | 操作类型，'add' 为新增，'edit' 为编辑 |

##### `type` ICommon

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `success` | `() => void` | 接口调用成功的回调函数 |
| `fail` | `(err: ErrorMsg) => void` | 接口调用失败的回调函数 |
| `complete` | `() => void` | 接口调用结束的回调函数（调用成功、失败都会执行） |

##### `type` ErrorMsg

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

##### `type` ErrorMsg.innerError

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


### 示例代码

```typescript
import { openGuideScene } from '@ray-js/ray';

const guideScene = async () => {
  try {
    await openGuideScene({ action: 'add' });
    console.log('已跳转场景引导页面');
  } catch (err) {
    console.error('跳转失败:', err);
  }
};
```