---
name: "setKeepScreenOn"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.3.2" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
---

## setKeepScreenOn

> [VERSION] BaseKit >= 2.3.2 | @ray-js/ray >= 0.3.23

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Set whether to keep the screen on

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `keepScreenOn` | `boolean` | Yes | - | `2.3.2` | Whether to keep the screen on |
| `complete` | `() => void` | No | - | - | Completion callback (executed on both success and failure) |
| `success` | `() => void` | No | - | - | Callback on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### fail callback parameters

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

##### fail(params).innerError properties

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


### Examples

#### Demo

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

// Keep screen on comparison test: enable keep-on first, observe idle for a while, then disable to restore auto screen-off.

(async () => {
  // 1) Enable keep-on
  setKeepScreenOn({
    keepScreenOn: true,
    success: data => {
      console.log("keepScreenOn=true ->", data);
    },
    fail: error => {
      console.error("keepScreenOn=true failed:", error);
    },
  });

  // 2) Observe idle: during this period the screen should stay on and not turn off even beyond the system timeout
  await new Promise(resolve => setTimeout(resolve, 15000));

  // 3) Disable keep-on and restore auto screen-off
  setKeepScreenOn({
    keepScreenOn: false,
    success: data => {
      console.log("keepScreenOn=false ->", data);
    },
    fail: error => {
      console.error("keepScreenOn=false failed:", error);
    },
  });
})();
```