https://github.com/vstirbu/cordova-keyguard-plugin

Cordova keyguard plugin
https://github.com/vstirbu/cordova-keyguard-plugin

Last synced: 7 months ago
JSON representation

Cordova keyguard plugin

• Host: GitHub
• URL: https://github.com/vstirbu/cordova-keyguard-plugin
• Owner: vstirbu
• License: mit
• Created: 2015-11-20T15:12:44.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-11-22T10:06:18.000Z (almost 10 years ago)
• Last Synced: 2025-02-13T20:40:19.861Z (8 months ago)
• Language: Java
• Size: 4.88 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# KeyGuardPlugin

Cordova keyguard plugin

# Installation

If using `cordova-cli` 5.0 or newer:

```bash

cordova plugin add cordova-keyguard-plugin

```

for older versions:

```bash

cordova plugin add https://github.com/vstirbu/cordova-keyguard-plugin.git

```

# JavaScript API

The plugin exposes the keyguard state for the application as `navigator.keyguard` object.

## Reading the keyguard state

```javascript

navigator.keyguard;

```

## Changing the keyguard state

To activate the keyguard use the following:

```javascript

navigator.keyguard = true;

```

To deactivate the keyguard use the following:

```javascript

navigator.keyguard = false;

```

## `keyguard` event

The plugin emits `keyguard` events whenever the state change has completed. You can reister for this events:

```javascript

window.addEventListener('keyguard', function (state) {

  // state can be true or false;

});

```

## Suported platforms

* Android

## License

The plugin is available under MIT license.