akasha

Class WakeLockSentinel

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.WakeLockSentinel

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="WakeLockSentinel")
public class WakeLockSentinel
extends EventTarget

The WakeLockSentinel interface of the Screen Wake Lock API provides a handle to the underlying platform wake lock and can be manually released and reacquired. An Object representing the wake lock is returned via the navigator.wakelock.request() method.

See Also:

WakeLockSentinel - MDN, # the-wakelocksentinel-interface

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	onrelease

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WakeLockSentinel()

Method Summary

Modifier and Type	Method and Description
Promise<java.lang.Void>	release() The release() method of the WakeLockSentinel interface releases the WakeLockSentinel, returning a Promise that is resolved once the sentinel has been successfully released.
boolean	released() The read-only released property of the WakeLockSentinel interface returns a boolean that indicates whether a WakeLockSentinel has been released yet.
java.lang.String	type() The read-only type property of the WakeLockSentinel interface returns a String representation of the currently acquired WakeLockSentinel type.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

onrelease

@Nullable
public EventHandler onrelease

Constructor Detail

WakeLockSentinel

protected WakeLockSentinel()

Method Detail

released

@JsProperty(name="released")
public boolean released()

The read-only released property of the WakeLockSentinel interface returns a boolean that indicates whether a WakeLockSentinel has been released yet.

See Also:

WakeLockSentinel.released - MDN, released - Screen Wake Lock API

type

@JsProperty(name="type")
 @Nonnull
 @WakeLockType
public java.lang.String type()

The read-only type property of the WakeLockSentinel interface returns a String representation of the currently acquired WakeLockSentinel type.

See Also:

WakeLockSentinel.type - MDN, WakeLockType - Screen Wake Lock API

release

@Nonnull
public Promise<java.lang.Void> release()

The release() method of the WakeLockSentinel interface releases the WakeLockSentinel, returning a Promise that is resolved once the sentinel has been successfully released.

See Also:

WakeLockSentinel.release - MDN, release() - Screen Wake Lock API