7.0.0 • Published 5 months ago

capacitor-screen-state v7.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

capacitor-screen-state

The ScreenState plugin for CapacitorJS allows developers to detect whether a device's screen is locked or unlocked.

Install

npm install capacitor-screen-state
npx cap sync

API

isScreenLocked()

isScreenLocked() => Promise<ScreenLockResult>

Checks if the device's screen is locked.

Available only on Android.

Returns: Promise<ScreenLockResult>

Since: 1.0.0

Interfaces

ScreenLockResult

PropTypeDescriptionSince
isLockedbooleanIndicates whether the screen is locked.1.0.0
capacitorpluginnativeunlocklockscreenandroid
7.0.0

5 months ago