---
name: "openGuideScene"
mode: "api"
versionRequirements:
  - { name: "基础库", version: "2.15.3" }
title: "ty.device.openGuideScene - 跳转场景引导页面"
---

## openGuideScene

> [VERSION] 基础库 >= 2.15.3

> 💡 IDE 模拟器与真机调试环境当前无法使用。
> 支持 callback 和 Promise 两种调用方式：传入 success/fail/complete 时走回调，否则返回 Promise。

### 描述

跳转场景引导页面

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `option` | `OpenGuideSceneOption` | 否 | 配置参数 |

### 返回值

类型: `Promise<void>`

不传回调时返回 Promise；传入 success/fail/complete 时走回调，返回 undefined

### 引用对象

##### `interface` OpenGuideSceneOption

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `action` | `string` | 操作，`add` `edit`（Android 端在 App 5.10.0 及以上版本支持） |
| `success` | `() => void` | 接口调用成功的回调函数 |
| `fail` | `(err: Object) => void` | 接口调用失败的回调函数 |
| `complete` | `() => void` | 接口调用结束的回调函数（调用成功、失败都会执行） |

##### `type` OpenGuideSceneOption.fail.err

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` |  |
| `errorCode` | `string` |  |


### 示例代码

#### 打开场景引导页面

```ts
ty.device.openGuideScene({
  action: 'add',
}).then(() => {
  console.log('调用成功打开场景引导页面');
});
```