diff options
Diffstat (limited to 'files/ja/web/api/wakelocksentinel')
-rw-r--r-- | files/ja/web/api/wakelocksentinel/index.md | 89 | ||||
-rw-r--r-- | files/ja/web/api/wakelocksentinel/release/index.md | 58 | ||||
-rw-r--r-- | files/ja/web/api/wakelocksentinel/release_event/index.md | 53 | ||||
-rw-r--r-- | files/ja/web/api/wakelocksentinel/released/index.md | 47 |
4 files changed, 247 insertions, 0 deletions
diff --git a/files/ja/web/api/wakelocksentinel/index.md b/files/ja/web/api/wakelocksentinel/index.md new file mode 100644 index 0000000000..84641484eb --- /dev/null +++ b/files/ja/web/api/wakelocksentinel/index.md @@ -0,0 +1,89 @@ +--- +title: WakeLockSentinel +slug: Web/API/WakeLockSentinel +tags: + - API + - インターフェイス + - リファレンス + - 画面起動ロック API + - 起動ロック + - 画面 +browser-compat: api.WakeLockSentinel +translation_of: Web/API/WakeLockSentinel +--- +{{securecontext_header}}{{DefaultAPISidebar("Screen Wake Lock API")}} + +**`WakeLockSentinel`** は[画面起動ロック API](/ja/docs/Web/API/Screen_Wake_Lock_API) のインターフェイスで、基礎となるプラットフォームの起動ロックへのハンドルを提供し、手動で解放および再取得することができます。起動ロックを表す {{jsxref('Object')}} は {{domxref('WakeLock.request()','navigator.wakelock.request()')}} メソッドを介して返されます。 + +取得した `WakeLockSentinel` は {{domxref('WakeLockSentinel.release','release()')}} メソッドによって手動で解放するか、プラットフォームの起動ロックによって自動的に解放することが可能です。これは、文書が非アクティブになったり、見えなくなったりした場合、端末の電力が低下した場合、ユーザーが省電力モードをオンにした場合に発生する可能性があります。与えられた起動ロック種別のすべての `WakeLockSentinel` インスタンスを解放すると、基盤となるプラットフォームの起動ロックが解放されます。 + +{{InheritanceDiagram}} + +## プロパティ + +_このインターフェイスは以下のプロパティを提供しています。_ + +- {{domxref("WakeLockSentinel.released", "released")}} {{ReadOnlyInline}} + - : 論理値で、 `WakeLockSentinel` が解放されたかどうかを示します。 +- {{domxref("WakeLockSentinel.type", "type")}} {{ReadOnlyInline}} + + - : 文字列で、取得した現在の `WakeLockSentinel` の種別を示します。 + 返値は次の通りです。 + + - `'screen'`: 画面の起動ロックです。端末の画面が暗くなったりロックされたりすることを防ぎます。 + +## イベント + +- {{domxref("WakeLockSentinel.release_event", "release")}} + - : {{domxref('WakeLockSentinel.release','release()')}} メソッドが呼び出されるか、起動ロックがユーザーエージェントによって解放されると発行されます。 + +## メソッド + +- {{domxref('WakeLockSentinel.release()', 'release()')}} + - : `WakeLockSentinel` の解放を行い、解放に成功したら解決する {{jsxref("Promise")}} を返します。 + +## 例 + +この例では、 `WakeLockSentinel` を要求する非同期関数を作成します。取得した後は、適切な UI への反映を行うために使用することができる `release` イベントを待ちます。見張り (sentinel) は適切な操作で取得したり解放したりすることができます。 + +```js +// 起動ロックの参照を作成 +let wakeLock = null; + +// 起動ロックを要求するための非同期関数を作成 +const requestWakeLock = async () => { + try { + wakeLock = await navigator.wakeLock.request('screen'); + + // release イベントを待ち受け + wakeLock.addEventListener('release', () => { + // 起動ロックが解放されたら、それに合わせて UI を変更する + }); + + } catch (err) { + // 起動ロックに失敗した場合 - ふつうはバッテリーなどシステム関連 + + } +} + +wakeLockOnButton.addEventListener('click', () => { + requestWakeLock(); +}) + +wakeLockOffButton.addEventListener('click', () => { + if (wakeLock !== null) { + wakeLock.release() + .then(() => { + wakeLock = null; + }) + } +}) +``` + +## 仕様書 + +{{Specifications}} + +## ブラウザーの互換性 + +{{Compat}} diff --git a/files/ja/web/api/wakelocksentinel/release/index.md b/files/ja/web/api/wakelocksentinel/release/index.md new file mode 100644 index 0000000000..4f7024cd5f --- /dev/null +++ b/files/ja/web/api/wakelocksentinel/release/index.md @@ -0,0 +1,58 @@ +--- +title: WakeLockSentinel.release() +slug: Web/API/WakeLockSentinel/release +tags: + - API + - Method + - リファレンス + - 画面起動ロック API + - 起動ロック + - WakeLockSentinel + - 画面 +browser-compat: api.WakeLockSentinel.release +translation_of: Web/API/WakeLockSentinel/release +--- +{{securecontext_header}}{{DefaultAPISidebar("Screen Wake Lock API")}} + +**`release()`** は {{domxref("WakeLockSentinel")}} インターフェイスのメソッドで、 {{domxref("WakeLockSentinel")}} を返し、この見張り (sentinel) の解放に成功したら解決する {{jsxref("Promise")}} を返します。 + +## 構文 + +```js +WakeLockSentinel.release().then(...); +``` + +### 引数 + +なし。 + +### 返値 + +`undefined` で解決する {{jsxref("Promise")}} を返します。 + +### 例外 + +例外は発生しません。起動ロックが解放されたかどうかを確認するには {{domxref("WakeLockSentinel/release_event", "release")}} イベントを待ち受けしてください。 + +## 例 + +この例では、ユーザーがボタンをクリックすると {{domxref("WakeLockSentinel")}} が解放されます。 + +```js +wakeLockOffButton.addEventListener('click', () => { + WakeLockSentinel.release(); +}) +``` + +## 仕様書 + +{{Specifications}} + +## ブラウザーの互換性 + +{{Compat}} + +## 関連情報 + +- {{DOMxRef("WakeLockSentinel")}} +- {{DOMxRef("WakeLock.request", "navigator.wakeLock.request()")}} diff --git a/files/ja/web/api/wakelocksentinel/release_event/index.md b/files/ja/web/api/wakelocksentinel/release_event/index.md new file mode 100644 index 0000000000..7d6be9eccb --- /dev/null +++ b/files/ja/web/api/wakelocksentinel/release_event/index.md @@ -0,0 +1,53 @@ +--- +title: 'WakeLockSentinel: release イベント' +slug: Web/API/WakeLockSentinel/release_event +tags: + - Event Handler + - プロパティ + - 画面 Wake Lock API + - 起動ロック + - WakeLockSentinel + - 画面 + - 画面 wake lock +browser-compat: api.WakeLockSentinel.release_event +translation_of: Web/API/WakeLockSentinel/release_event +--- +{{securecontext_header}}{{DefaultAPISidebar("Screen Wake Lock API")}} + +**`release`** は {{domxref("WakeLockSentinel")}} インターフェイスのイベントで、この見張りオブジェクトのハンドルが解放されたときに発行されます。 + +{{domxref("WakeLockSentinel")}} は `release()` メソッドにより手動で解放したり、プラットフォームの起動ロックにより自動的に解放されたりします。これは、文書がアクティブでなくなった場合や、見えなくなった場合、端末の電力が低下した場合、ユーザーが省電力モードをオンにした場合に発生する可能性があります。 + +## 構文 + +このイベント名を {{domxref("EventTarget.addEventListener", "addEventListener()")}} などで用いるか、イベントハンドラープロパティを設定するかしてください。 + +```js +addEventListener('release', event => { }) + +onrelease = event => { } +``` + +## イベント型 + +一般的な {{domxref("Event")}} です。 + +## 例 + +この例では、起動ロックが解放されたときに UI を更新します。 + +```js +wakeLock.addEventListener('release', () => { + + // if wake lock is released alter the UI accordingly + statusElement.textContent = 'Wake Lock has been released'; +}); +``` + +## Specifications + +{{Specifications}} + +## Browser compatibility + +{{Compat}} diff --git a/files/ja/web/api/wakelocksentinel/released/index.md b/files/ja/web/api/wakelocksentinel/released/index.md new file mode 100644 index 0000000000..82542fc9f1 --- /dev/null +++ b/files/ja/web/api/wakelocksentinel/released/index.md @@ -0,0 +1,47 @@ +--- +title: WakeLockSentinel.released +slug: Web/API/WakeLockSentinel/released +tags: + - プロパティ + - 読み取り専用 + - 画面起動ロック API + - WakeLockSentinel +browser-compat: api.WakeLockSentinel.released +translation_of: Web/API/WakeLockSentinel/released +--- +{{DefaultAPISidebar("Screen Wake Lock API")}} + +**`released`** は {{domxref("WakeLockSentinel")}} インターフェイスのプロパティで、 {{domxref("WakeLockSentinel")}} がまだ解放されていないかどうかを示す論理値を返します。 + +## 構文 + +```js +var released = sentinel.released; +``` + +### 値 + +論理値で、最初は `false` であり、 {{domxref("WakeLockSentinel")}} が解放され({{domxref("WakeLockSentinel.release()")}} が呼び出されるか、または自動的にロックが解除され) {{domxref("WakeLockSentinel/release_event", "release")}} イベントが発行された後は `true` となって変化しない値です。 + +## 例 + +この例は、 **`released`** の値が {{domxref("WakeLockSentinel")}} のライフライクルの中でどのように変化するかを示します。 + +```js +const sentinel = await navigator.wakeLock.request('screen'); +console.log(sentinel.released); // "false" と出力 + +sentinel.onrelease = () => { + console.log(sentinel.released); // "true" と出力 +}; + +await sentinel.release(); +``` + +## 仕様書 + +{{Specifications}} + +## ブラウザーの互換性 + +{{Compat}} |