mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

feat(powerMonitor): expose interface to query system idle state (#11807)

Browse source 
* feat(BrowserWindow): expose interface to query system idle state

* test(BrowserWindow): update test cases for querySystemIdle interface

* docs(BrowserWindow): add querySystemIdle interface documentation

* refactor(powerMonitor): move querySystemIdle into powerMonitor

* test(powerMonitor): split test cases for all platform
This commit is contained in:
OJ Kwon 2018-03-13 22:42:08 -07:00 • committed by Charles Kerr
parent 90dc897f71
commit e7181eb89c
5 changed files with 143 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

22
docs/api/power-monitor.md
View file

@ -46,3 +46,25 @@ Emitted when the system is about to reboot or shut down. If the event handler
invokes `e.preventDefault()`, Electron will attempt to delay system shutdown in
order for the app to exit cleanly. If `e.preventDefault()` is called, the app
should exit as soon as possible by calling something like `app.quit()`.
## Methods
The `powerMonitor` module has the following methods:
#### `powerMonitor.querySystemIdleState(idleThreshold, callback)`
* `idleThreshold` Integer
* `callback` Function
* `idleState` String - Can be `active`, `idle`, `locked` or `unknown`
Calculate the system idle state. `idleThreshold` is the amount of time (in seconds)
before considered idle. `callback` will be called synchronously on some systems
and with an `idleState` argument that describes the system's state. `locked` is
available on supported systems only.
#### `powerMonitor.querySystemIdleTime(callback)`
* `callback` Function
* `idleTime` Integer - Idle time in seconds
Calculate system idle time in seconds.