Keep Awake

@capacitor-community/keep-awake

⚡️ Capacitor plugin to prevent devices from dimming or locking the screen.


## Maintainers | Maintainer | GitHub | Social | | ------------- | ----------------------------------------------- | ------------------------------------------------- | | Kevin Boosten | [kevinboosten](https://github.com/kevinboosten) | [@kevinboosten](https://twitter.com/kevinboosten) | | Robin Genz | [robingenz](https://github.com/robingenz) | [@robin_genz](https://twitter.com/robin_genz) | ## Installation ```shell npm install @capacitor-community/keep-awake npx cap sync ``` ## Configuration No configuration required for this plugin. ## Demo A working example can be found in example-app folder. ## Usage ```typescript import { KeepAwake } from '@capacitor-community/keep-awake'; const keepAwake = async () => { await KeepAwake.keepAwake(); }; const allowSleep = async () => { await KeepAwake.allowSleep(); }; const isSupported = async () => { const result = await KeepAwake.isSupported(); return result.isSupported; }; const isKeptAwake = async () => { const result = await KeepAwake.isKeptAwake(); return result.isKeptAwake; }; ``` ## API * [`keepAwake()`](#keepawake) * [`allowSleep()`](#allowsleep) * [`isSupported()`](#issupported) * [`isKeptAwake()`](#iskeptawake) * [Interfaces](#interfaces) ### keepAwake() ```typescript keepAwake() => Promise ``` Prevent the device from dimming the screen. -------------------- ### allowSleep() ```typescript allowSleep() => Promise ``` Allow the device to dim the screen. -------------------- ### isSupported() ```typescript isSupported() => Promise ``` Whether keep awake is supported or not. **Returns:** Promise<IsSupportedResult> -------------------- ### isKeptAwake() ```typescript isKeptAwake() => Promise ``` Check if the device is kept awake. **Returns:** Promise<IsKeptAwakeResult> -------------------- ### Interfaces #### IsSupportedResult | Prop | Type | | ----------------- | -------------------- | | **`isSupported`** | boolean | #### IsKeptAwakeResult | Prop | Type | | ----------------- | -------------------- | | **`isKeptAwake`** | boolean | ## Changelog See [CHANGELOG.md](https://github.com/capacitor-community/keep-awake/blob/master/CHANGELOG.md). ## License See [LICENSE](https://github.com/capacitor-community/keep-awake/blob/master/LICENSE).