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

## openGuideScene

> [VERSION] Base Library >= 2.15.3

> 💡 Currently unavailable in the IDE simulator and on-device debugging environment.
> Supports both callback and Promise usage: if success/fail/complete is provided, callbacks are used; otherwise a Promise is returned.

### Description

Navigate to the scene guide page

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `option` | `OpenGuideSceneOption` | No | Configuration parameters |

### Return Value

Type: `Promise<void>`

Returns a Promise when no callback is provided; if success/fail/complete is passed, uses callbacks and returns undefined

### Referenced Types

##### `interface` OpenGuideSceneOption

| Property | Type | Description |
| --- | --- | --- |
| `action` | `string` | Operation, `add` `edit` (supported on Android in App 5.10.0 and later) |
| `success` | `() => void` | Success callback |
| `fail` | `(err: Object) => void` | Callback on failure |
| `complete` | `() => void` | Callback on complete (success or failure) |

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

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` |  |
| `errorCode` | `string` |  |


### Examples

#### Open the scene guide page

```ts
ty.device.openGuideScene({
  action: 'add',
}).then(() => {
  console.log('Successfully opened the scene guide page');
});
```