空闲检测器:start() 方法

可用性有限

此功能不是基线,因为它在一些使用最广泛的浏览器中无法正常工作。

安全上下文:此功能仅在安全上下文(HTTPS)中可用,在一些或所有支持的浏览器中。

实验性:这是一个实验性技术
在生产环境中使用此功能之前,请仔细查看浏览器兼容性表

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

语法

js
start()
start(options)

参数

options 可选

具有以下属性的对象

threshold

在开始报告之前,空闲的最小毫秒数。

signal

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

返回值

一个Promise

异常

NotAllowedError DOMException

使用此功能被权限策略阻止。

示例

以下示例展示了如何使用 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

浏览器兼容性

BCD 表仅在启用 JavaScript 的浏览器中加载。