@capacitor-community/keep-awake

Keep Awake

@capacitor-community/keep-awake

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

Maintainers

| Maintainer | GitHub | Social |
| ------------- | ----------------------------------------------- | ------------------------------------------------- |
| Kevin Boosten | kevinboosten | @kevinboosten |
| Robin Genz | robingenz | @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()
* allowSleep()
* isSupported()
* isKeptAwake()
* Interfaces

$3

`typescript
keepAwake() => Promise
`

Prevent the device from dimming the screen.

--------------------

$3

`typescript
allowSleep() => Promise
`

Allow the device to dim the screen.

--------------------

$3

`typescript
isSupported() => Promise
`

Whether keep awake is supported or not.

Returns: Promise<IsSupportedResult>

--------------------

$3

`typescript
isKeptAwake() => Promise
`

Check if the device is kept awake.

Returns: Promise<IsKeptAwakeResult>

--------------------

$3


#### IsSupportedResult

| Prop | Type |
| ----------------- | -------------------- |
| isSupported | boolean |


#### IsKeptAwakeResult

| Prop | Type |
| ----------------- | -------------------- |
| isKeptAwake` | boolean |

Changelog

See CHANGELOG.md.

License

See LICENSE.