---
name: "openGuideScene"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.4.32" }
title: "openGuideScene"
---

## openGuideScene

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

### Description

Navigate to the scene onboarding page

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | `OpenGuideScene` | No | Onboarding page parameters |

### Return Value

Type: `Promise<void>`

Promise for the navigation result; resolves on success, rejects on failure

### Referenced Types

##### `type` OpenGuideScene

| Property | Type | Description |
| --- | --- | --- |
| `action` | `"add" \| "edit"` | Operation type: 'add' for create, 'edit' for edit |

##### `type` ICommon

| Property | Type | Description |
| --- | --- | --- |
| `success` | `() => void` | Callback on successful API call |
| `fail` | `(err: ErrorMsg) => void` | Failure callback |
| `complete` | `() => void` | Completion callback (executed on both success and failure) |

##### `type` ErrorMsg

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### `type` ErrorMsg.innerError

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Error extension code |
| `errorMsg` | `string` | Error extension message |


### Examples

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

const guideScene = async () => {
  try {
    await openGuideScene({ action: 'add' });
    console.log('Navigated to the scene guide page');
  } catch (err) {
    console.error('Navigation failed:', err);
  }
};
```