aboutsummaryrefslogtreecommitdiff
path: root/files
diff options
context:
space:
mode:
authorMasahiro FUJIMOTO <mfujimot@gmail.com>2022-03-06 17:04:25 +0900
committerMasahiro FUJIMOTO <mfujimot@gmail.com>2022-03-14 23:42:58 +0900
commited2e20fa98e77f266c62841ac0a23e0fe83e9257 (patch)
treea06bd9ca41ea6efba6b3e37ebd609bbc8884b5e2 /files
parent98dce175ed86c3bfca844fc649a89cedee1e2c97 (diff)
downloadtranslated-content-ed2e20fa98e77f266c62841ac0a23e0fe83e9257.tar.gz
translated-content-ed2e20fa98e77f266c62841ac0a23e0fe83e9257.tar.bz2
translated-content-ed2e20fa98e77f266c62841ac0a23e0fe83e9257.zip
2021/09/15 時点の英語版に基づき新規翻訳
Diffstat (limited to 'files')
-rw-r--r--files/ja/web/api/wakelock/request/index.md78
1 files changed, 78 insertions, 0 deletions
diff --git a/files/ja/web/api/wakelock/request/index.md b/files/ja/web/api/wakelock/request/index.md
new file mode 100644
index 0000000000..c5fb43d0a2
--- /dev/null
+++ b/files/ja/web/api/wakelock/request/index.md
@@ -0,0 +1,78 @@
+---
+title: WakeLock.request()
+slug: Web/API/WakeLock/request
+tags:
+ - API
+ - Method
+ - リファレンス
+ - 画面起動ロック API
+ - WakeLock
+browser-compat: api.WakeLock.request
+translation_of: Web/API/WakeLock/request
+---
+{{securecontext_header}}{{DefaultAPISidebar("Screen Wake Lock API")}}
+
+**`request()`** は {{domxref("WakeLock")}} インターフェイスのメソッドで、画面を暗くしたりロックしたりすることを制御することができる {{domxref("WakeLockSentinel")}} で解決するプロミス ({{jsxref("Promise")}}) を返します。
+
+## 構文
+
+```js
+var wakeLock = navigator.wakeLock.request(type);
+```
+
+### 引数
+
+- _type_
+
+ - : オプションは次の通りです。
+
+ - `'screen'`: 画面の起動ロックを要求します。端末の画面が暗くなったりロックされたりすることを防ぎます。
+
+### 返値
+
+{{domxref("WakeLockSentinel")}} オブジェクトで解決する {{jsxref("Promise")}} を返します。
+
+### 例外
+
+- `NotAllowedError`
+
+ - : 起動ロックが利用できないときに発生します。原因は以下のようなものです。
+
+ - 文書が screen-wake-lock ポリシーにより、画面起動ロックを使用することができない。
+ - 文書が完全にアクティブではない。
+ - 文書が非表示になっている。
+ - {{Glossary("User Agent", "ユーザーエージェント")}}がプラットフォームの起動ロックを取得できない。
+
+## 例
+
+以下の非同期関数は、 {{domxref("WakeLockSentinel")}} オブジェクトを要求します。
+`request()` メソッドはブラウザーが何らかの理由でリクエストを拒否した場合を想定して、 `try...catch` 文で囲まれています。
+
+```js
+const requestWakeLock = async () => {
+ try {
+
+ const wakeLock = await navigator.wakeLock.request('screen');
+
+ } catch (err) {
+ // 起動ロックの要求に失敗 - 通常は、バッテリー低下などシステムに起因する。
+
+ console.log(`${err.name}, ${err.message}`);
+ }
+}
+
+requestWakeLock();
+```
+
+## 仕様書
+
+{{Specifications}}
+
+## ブラウザーの互換性
+
+{{Compat}}
+
+## 関連情報
+
+- {{DOMxRef("WakeLock")}}
+- {{DOMxRef("Navigator.wakeLock")}}