IdleDetector: start() 方法

可用性有限

此特性不是基线特性,因为它在一些最广泛使用的浏览器中不起作用。

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

实验性: 这是一项实验性技术
在生产中使用此技术之前,请仔细检查浏览器兼容性表格

注意:此功能在 专用 Web Workers 中可用。

start() 方法是 IdleDetector 接口的一个方法,它返回一个 Promise,当检测器开始监听用户空闲状态的变化时,该 Promise 会被解析。此方法接受一个可选的 options 对象,其中包含一个 threshold(以毫秒为单位,表示多久不活动后应报告)和一个用于中止空闲检测的 AbortSignalsignal

语法

js
start()
start(options)

参数

options 可选

具有以下属性的对象:

threshold

开始报告应开始之前的最短空闲毫秒数。

signal

指向 AbortSignal 实例的引用,允许您中止空闲检测。

返回值

Promise

异常

NotAllowedError DOMException

此功能的使用被 Permissions Policy 阻止了。

示例

以下示例展示了如何使用 options 参数启动空闲检测。它从 AbortController 实例中检索 AbortSignal 实例。

js
const controller = new AbortController();
const signal = controller.signal;

await idleDetector.start({
  threshold: 60_000,
  signal,
});
console.log("IdleDetector is active.");

规范

规范
空闲检测 API
# api-idledetector-start

浏览器兼容性