WakeLockService class
Keeps the screen from auto-locking while enabled — wraps wakelock_plus
with a persisted on/off preference (StorageKeys.wakeLockEnabled), the
same shape as AudioManager's muted flag, so a consuming app can expose
its own settings toggle instead of the kit unconditionally forcing the
screen to stay on.
Defaults to true on first install (opt-out, not opt-in) — the classic
casual-game expectation is that gameplay keeps the screen awake unless the
player turns it off, matching what most casual/idle games ship with out of
the box.
- Inheritance
-
- Object
- GetLifeCycle
- DisposableInterface
- GetxService
- WakeLockService
Constructors
Properties
- enabled → RxBool
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- initialized → bool
-
Checks whether the controller has already been initialized.
no setterinherited
- isClosed → bool
-
Checks whether the controller has already been closed.
no setterinherited
-
onDelete
→ InternalFinalCallback<
void> -
Internal callback that starts the cycle of this controller.
finalinherited
-
onStart
→ InternalFinalCallback<
void> -
Called at the exact moment the widget is allocated in memory.
It uses an internal "callable" type, to avoid any @overrides in subclases.
This method should be internal and is required to define the
lifetime cycle of the subclass.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
$configureLifeCycle(
) → void -
inherited
-
init(
) → Future< void> - Restores the saved preference and applies it to the real platform wakelock. Never throws — a platform with no wakelock support (e.g. some test environments) just leaves the screen's own timeout behavior alone.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onClose(
) → void -
Called before onDelete method. onClose might be used to
dispose resources used by the controller. Like closing events,
or streams before the controller is destroyed.
Or dispose objects that can potentially create some memory leaks,
like TextEditingControllers, AnimationControllers.
Might be useful as well to persist some data on disk.
override
-
onInit(
) → void -
Called immediately after the widget is allocated in memory.
You might use this to initialize something for the controller.
inherited
-
onReady(
) → void -
Called 1 frame after onInit(). It is the perfect place to enter
navigation events, like snackbar, dialogs, or a new route, or
async request.
inherited
-
setEnabled(
bool value) → Future< void> -
toggle(
) → Future< void> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- maybe → WakeLockService?
-
Null-safe accessor for call sites that may run before/without this
service registered (mirrors AudioManager.maybe).
no setter