WakeLock.request()

構文

var wakeLock = navigator.wakeLock.request(type);

引数

type

オプションは次の通りです。

• 'screen': 画面の起動ロックを要求します。端末の画面が暗くなったりロックされたりすることを防ぎます。

返値

WakeLockSentinel オブジェクトで解決する Promise を返します。

例外

NotAllowedError

起動ロックが利用できないときに発生します。原因は以下のようなものです。

• 文書が screen-wake-lock ポリシーにより、画面起動ロックを使用することができない。
• 文書が完全にアクティブではない。
• 文書が非表示になっている。
• ユーザーエージェントがプラットフォームの起動ロックを取得できない。

例

以下の非同期関数は、 WakeLockSentinel オブジェクトを要求します。 request() メソッドはブラウザーが何らかの理由でリクエストを拒否した場合を想定して、 try...catch 文で囲まれています。

const requestWakeLock = async () => {
  try {
    const wakeLock = await navigator.wakeLock.request("screen");
  } catch (err) {
    // 起動ロックの要求に失敗 - 通常は、バッテリー低下などシステムに起因する。

    console.log(`${err.name}, ${err.message}`);
  }
};

requestWakeLock();

仕様書

ブラウザーの互換性

関連情報

• WakeLock
• Navigator.wakeLock