概要
このドキュメントは、ウェブアプリケーションがスクリーンウェイクロックを要求できるAPIを定義します。適切な条件下で許可された場合、スクリーンウェイクロックはシステムがデバイスのスクリーンをオフにするのを防ぎます。
この仕様では、以下のウェイクロックの種類を定義しています：
- スクリーンウェイクロックは、画面がオフになるのを防ぎます。スクリーンウェイクロックは、可視状態のドキュメントのみが取得できます。
APIでは、ウェイクロックの種類は
WakeLockType列挙型の値で表されます。
注
他の仕様で異なるウェイクロックの種類が定義される場合があります。
スクリーンウェイクロックAPIは、ポリシー制御機能を定義しており、識別子は"screen-wake-lock"です。デフォルト許可リストは'self'です。
注
[PERMISSIONS]
APIは、ウェブサイトがユーザーから権限をリクエストしたり、持っている権限を確認したりするための統一した方法を提供します。
ユーザーエージェントは、特定のウェイクロックの種類やDocumentに対し、プラットフォーム設定やユーザーの好みなどの実装依存の理由でウェイクロックを拒否することができます。
ユーザーエージェントは、ウェイクロックが有効な際に、ユーザーへ通知を表示し、継続中の操作をブロックする手段や、通知を閉じる手段を提供することが推奨されます。
"screen-wake-lock" 強力な機能は、本仕様で定義された機能を有効化します。
この仕様で言及されたタスクソースは、スクリーンウェイクロックタスクソースです。
プラットフォームウェイクロックとは、ユーザーエージェントが状態を照会したりウェイクロックの取得／解除を行うためにやりとりするプラットフォームインターフェースを指します。
プラットフォームウェイクロックは、基盤となるプラットフォーム（例：ネイティブのウェイクロックフレームワーク）や、ユーザーエージェントが直接ハードウェア制御できる場合はユーザーエージェント自体によって定義されます。
特定のウェイクロックの種類が明示的に言及されていない限り、このセクションは各ウェイクロックの種類に等しくかつ独立に適用されます。
ユーザーエージェントは、基盤となるオペレーティングシステムにロックの適用を要求することで、ウェイクロックを取得します。基盤OSへの要求の返り値は確認されません。言い換えると、ユーザーエージェントはウェイクロックの取得を助言的なものとして取り扱うMUSTです。
逆に、ユーザーエージェントは、基盤となるオペレーティングシステムにウェイクロックの適用をやめるよう要求することでウェイクロックを解除します。ロックは、オペレーティングシステムへの要求が成功した場合にのみ解除されたものと見なされます。
オペレーティングシステムの状態がロックの適用を許可する場合（例：十分なバッテリー残量がある）、ウェイクロックは適用可能です。
スクリーンウェイクロックは、ユーザーが手動で画面をオフにした後、再びオンにするまで適用可能であってはMUST NOTです。
注
ユーザーエージェントはいつでもウェイクロックを解除してもかまいません。例えば次の場合です：
- 異常動作を検出したとき（無限ループや、課された時間制限（存在する場合）を超えるタスクなど）。
- バッテリー残量が低く、放電中と判断されたとき。
- ユーザーが何らかの省電力モードを有効にしたとき。
- オペレーティングシステムがユーザーの在席状態に基づいて、画面の減光またはオフを行うよう構成されているとき。
指定された type のウェイクロックを取得するには、次の手順を実行します：
- type のウェイクロックが適用可能でない場合、これらの手順を中断する。
- 基盤となるオペレーティングシステムに、type のウェイクロックを取得するよう求める。
指定された document、
lock、および type のウェイクロックを解除するには、次の手順を実行します：
- もし document.
[[ActiveLocks]][type] が lock
を含まないなら、これらの手順を中断する。
- lock を
document.
[[ActiveLocks]][type] から取り除く。
- もし document.
[[ActiveLocks]][type] が空なら、以下を並列で実行する：
- 基盤となるオペレーティングシステムに、type のウェイクロックを解除するよう求め、操作が成功したら success を
true、それ以外は false とする。
- もし success が
true で、かつ type が "screen" なら、次を実行する：
- 画面が実際にオフになるまでの、プラットフォーム固有の非操作タイマーをリセットする。
注
- lock の
[[Released]] を true に設定する。
-
イベントを発火し、名前は "
release
スクリーンウェイクロックは、特にディスプレイなどの各種デバイスコンポーネントを、通常より高い電力レベルで動作させる可能性があります。これは、デバイスの自動ロックを妨げたり、バッテリーの減りを早めたりするなど、望ましくない影響をもたらすことがあります。バッテリーの減りが早まることは、定常的な電源がすぐに得られないことが多いモバイルデバイスにとって、特に懸念事項です。予期せぬ時点でバッテリーが完全に消耗すると、ユーザーが通話やネットワークサービス（緊急通話サービスを含む）を利用できなくなる可能性があります。
例えば、バッテリー容量が低い場合や、ユーザーがデバイスを省電力モードにした場合など、実装はスクリーンウェイクロックの要求を無視してもMAYです。
ユーザーエージェントは、スクリーンウェイクロックが有効であることをユーザーが認識できる UI やインジケーターを提供することがRECOMMENDEDです。そうした
UI を提供することで、特定のウェブアプリケーションがデバイスに悪影響（エネルギー面）を与えているかどうかをエンドユーザーが特定し、必要に応じて対処できるようになります。
-
[DOM] は次を定義します：
-
Document インターフェース
-
EventTarget インターフェース
-
イベントを発火（Fire an
event）
-
[ECMASCRIPT]
は次を定義します：
-
[HTML] は次を定義します：
-
利用可能（allowed to
use）
-
関連付けられた
Document（associated
Document）
-
現在のグローバルオブジェクト（current global
object）
-
イベントハンドラー（event
handler）
-
イベントハンドラーイベントタイプ（event
handler event type）
-
イベントハンドラー IDL 属性（event
handler IDL attribute）
-
EventHandler
-
完全にアクティブ（
Document に対して）
-
並列で（in parallel）
-
Navigator インターフェース
-
ページ可視性変更の手順（page
visibility change steps）
-
グローバルタスクをキューする（Queue a global
task）
-
関連グローバルオブジェクト（relevant
global object）
-
タスクソース（task
source）
-
タスク（tasks）
-
可視性状態（
Document に対する visibility state）
-
Window
インターフェース
-
[INFRA] は次を定義します：
-
追加（Append、
list に対して）
-
各要素（For
each、
list に対して）
-
if aborted
-
空である（is
empty、
list に対して）
-
リスト（lists）
-
順序付きマップ（ordered
map）
-
[PERMISSIONS]
は次を定義します：
-
denied（PermissionState に対して）
-
権限取り消しアルゴリズム（強力な機能に対して）
-
強力な機能（powerful
feature）
-
使用権限要求（requesting permission to use）
-
[PERMISSIONS-POLICY] は次を定義します：
-
デフォルト許可リスト（ポリシー制御機能に対して）
-
ポリシー制御機能（policy-controlled feature）
-
[WEBIDL] は次を定義します：
-
新しい promise（a new
promise）
-
拒否された
promise（a promise
rejected with）
-
解決された
promise（a promise
resolved with）
-
boolean
型
-
DOMException インターフェース
-
[Exposed] 拡張属性
-
NotAllowedError 例外
-
Promise インターフェース
-
[SameObject] 拡張属性
-
[SecureContext] 拡張属性
-
this
-
undefined 型
↑
Referenced in:
- Not referenced in this document.