DeviceMotionEvent: requestPermission() static method

Limited availability

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

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

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

The requestPermission() static method of the DeviceMotionEvent interface requests the user's permission to access device motion data from the accelerometer and gyroscope sensors. This method requires transient activation, meaning that it must be triggered by a UI event such as a button click.

Syntax

js
DeviceMotionEvent.requestPermission()

Parameters

None.

Return value

A Promise that resolves with a string which is either "granted" or "denied".

Exceptions

The returned promise rejects with the following exceptions:

NotAllowedError DOMException

The permission state is "prompt" and the calling function does not have transient activation.

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

Requesting device motion permission on click

js
document.querySelector("button").addEventListener("click", async () => {
  if (typeof DeviceMotionEvent.requestPermission !== "function") {
    // The feature is not available, or does not need permission.
    return;
  }

  const permission = await DeviceMotionEvent.requestPermission();
  if (permission === "granted") {
    window.addEventListener("devicemotion", (event) => {
      console.log(`Acceleration X: ${event.acceleration.x}`);
      console.log(`Acceleration Y: ${event.acceleration.y}`);
      console.log(`Acceleration Z: ${event.acceleration.z}`);
    });
  }
});

Specifications

Specification
Device Orientation and Motion
# dom-devicemotionevent-requestpermission

Browser compatibility

See also