IdleDetector: requestPermission() static method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Secure context: This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The requestPermission() static method of the IdleDetector interface returns a Promise that resolves with a string when the user has chosen whether to grant the origin access to their idle state. Resolves with "granted" on acceptance and "denied" on refusal.

Syntax

js
IdleDetector.requestPermission()

Parameters

None.

Return value

A Promise that resolves with "granted" or "denied".

Security

Transient user activation is required. The user has to interact with the page or a UI element in order for this feature to work.

Examples

The following example uses a click event on a button to trigger requesting the user for permission to detect when user is idle.

js
startButton.addEventListener("click", async () => {
  if ((await IdleDetector.requestPermission()) !== "granted") {
    console.error("Idle detection permission denied.");
    return;
  }
});

Specifications

Specification
Idle Detection API
# api-idledetector-requestpermission

Browser compatibility

BCD tables only load in the browser