---
name: "setKeepScreenOn"
mode: "kit"
versionRequirements:
  - { name: "BaseKit", version: "2.3.2" }
  - { name: "@ray-js/ray", version: "0.3.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "setKeepScreenOn - 设置是否保持常亮状态"
---

## setKeepScreenOn

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

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

设置是否保持常亮状态

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `keepScreenOn` | `boolean` | 是 | - | `2.3.2` | 是否保持屏幕常亮 |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `() => void` | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### fail 回调参数

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

##### fail(params).innerError 的属性

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


### 示例代码

#### Demo

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

// 屏幕常亮对照测试：先开启常亮，静置观察一段时间，再关闭恢复自动息屏。

(async () => {
  // 1) 开启常亮
  setKeepScreenOn({
    keepScreenOn: true,
    success: data => {
      console.log("keepScreenOn=true ->", data);
    },
    fail: error => {
      console.error("keepScreenOn=true failed:", error);
    },
  });

  // 2) 静置观察：此期间屏幕应保持点亮，超过系统息屏时间也不自动熄灭
  await new Promise(resolve => setTimeout(resolve, 15000));

  // 3) 关闭常亮，恢复自动息屏
  setKeepScreenOn({
    keepScreenOn: false,
    success: data => {
      console.log("keepScreenOn=false ->", data);
    },
    fail: error => {
      console.error("keepScreenOn=false failed:", error);
    },
  });
})();
```