setKeepScreenOn – Tuya MiniApp

setKeepScreenOn(params: Object)

Requires:

BaseKit≥2.3.2@ray-js/ray≥0.3.23

Platforms:

iOSAndroid

import { setKeepScreenOn } from '@ray-js/ray';

// Promise usage
try {
  const res = await setKeepScreenOn({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Set whether to keep the screen on

Parameters

Property	Type	Required	Description
`keepScreenOn`	boolean	Yes	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	No	Failure callback

fail callback parameters

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

Return Value

None

Examples

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);
    },
  });
})();