Draft This page is not complete.
Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The onrelease
property of the WakeLockSentinel
is fired when the sentinel object's handle has been released.
A WakeLockSentinel
can be released manually via the release() method, or automatically via the platform wake lock. This can happen if the document becomes inactive or looses visibility, if the device is low on power or the user turns on a power save mode.
This interface inherits from the Event
interface.
<div id="interfaceDiagram" style="display: inline-block; position: relative; width: 100%; padding-bottom: 8.571428571428571%; vertical-align: middle; overflow: hidden;"><svg style="display: inline-block; position: absolute; top: 0; left: 0;" viewbox="-20 0 700 60" preserveAspectRatio="xMinYMin meet"><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/WakeLockSentinel" target="_top"><rect x="1" y="1" width="160" height="50" fill="#F4F7F8" stroke="#D4DDE4" stroke-width="2px" /><text x="81" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">WakeLockSentinel</text></a></svg></div>
a:hover text { fill: #0095DD; pointer-events: all;}
Syntax
wakeLockSentinel.onrelease = function(event) {...}
Examples
This example updates the UI should the wake lock be released.
wakeLock.addEventListener('release', () => {
// if wake lock is released alter the UI accordingly
statusElement.textContent = 'Wake Lock has been released';
});
Specifications
Specification | Status | Comment |
Screen Wake Lock APIThe definition of 'onrelease' in that specification. | Editor's Draft | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Chrome
Full support 84 |
Edge
Full support 84 |
Firefox
No support No |
IE
No support No |
Opera
Full support Yes |
Safari
No support No |
WebView Android
Full support 84 |
Chrome Android
Full support 84 |
Firefox Android
No support No |
Opera Android
Full support Yes |
Safari iOS
No support No |
Samsung Internet Android
No support No |
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
WakeLockSentinel.onrelease by Mozilla Contributors is licensed under CC-BY-SA 2.5.