https://github.com/jardenliu/cordova-plugin-osx-battery

Cordova Battery Plugin for OSX Platform
https://github.com/jardenliu/cordova-plugin-osx-battery

Last synced: 16 days ago
JSON representation

Cordova Battery Plugin for OSX Platform

• Host: GitHub
• URL: https://github.com/jardenliu/cordova-plugin-osx-battery
• Owner: jardenliu
• Created: 2019-04-15T12:28:00.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-04-16T02:15:31.000Z (over 5 years ago)
• Last Synced: 2024-12-11T23:36:54.872Z (20 days ago)
• Language: Objective-C
• Homepage:
• Size: 3.91 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# cordova-plugin-osx-battery

> The README.md && OSXBettery.js is forked from [apache/cordova-plugin-battery-status](https://github.com/apache/cordova-plugin-battery-status).

This plugin provides an implementation of an old version of the [Battery Status Events API][w3c_spec]. It adds the following three events to the `window` object:

* batterystatus

* batterycritical

* batterylow

Applications may use `window.addEventListener` to attach an event listener for any of the above events after the `deviceready` event fires.

## Installation

    cordova plugin add cordova-plugin-osx-battery

## Status object

All events in this plugin return an object with the following properties:

- __level__: The battery charge percentage (0-100). _(Number)_

- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_

## batterystatus event

Fires when the battery charge percentage changes by at least 1 percent, or when the device is plugged in or unplugged. Returns an [object][status_object] containing battery status.

### Example

    window.addEventListener("batterystatus", onBatteryStatus, false);

    function onBatteryStatus(status) {

        console.log("Level: " + status.level + " isPlugged: " + status.isPlugged);

    }

### Supported Platforms

- OSX

## batterylow event

Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.

### Example

    window.addEventListener("batterylow", onBatteryLow, false);

    function onBatteryLow(status) {

        alert("Battery Level Low " + status.level + "%");

    }

### Supported Platforms

- OSX

## batterycritical event

Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.

### Example

    window.addEventListener("batterycritical", onBatteryCritical, false);

    function onBatteryCritical(status) {

        alert("Battery Level Critical " + status.level + "%\nRecharge Soon!");

    }

### Supported Platforms

- OSX

[w3c_spec]: https://www.w3.org/TR/battery-status/

[status_object]: #status-object