@capgo/capacitor-keep-awake
Capacitor Keep Awake Plugin for preventing the device screen from dimming/sleeping.
Overview
Section titled “Overview”Capacitor Keep Awake Plugin for preventing the device screen from dimming/sleeping.
Core Capabilities
Section titled “Core Capabilities”keepAwake- Prevent the device from dimming the screen.allowSleep- Allow the device to dim the screen (disable keep awake).isSupported- Check if the keep awake feature is supported on the current platform.isKeptAwake- Check if the device is currently being kept awake.
Public API
Section titled “Public API”| Method | Description |
|---|---|
keepAwake | Prevent the device from dimming the screen. |
allowSleep | Allow the device to dim the screen (disable keep awake). |
isSupported | Check if the keep awake feature is supported on the current platform. |
isKeptAwake | Check if the device is currently being kept awake. |
getPluginVersion | Get the native Capacitor plugin version. |
Source Of Truth
Section titled “Source Of Truth”This reference is synced from src/definitions.ts in capacitor-keep-awake.