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

Standardize power-save-blocker

Browse source
This commit is contained in:
Jessica Lord 2015-08-28 21:44:13 -07:00
parent 83aa9df1ee
commit 91150839be
1 changed files with 25 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
docs/api/power-save-blocker.md
View file

@ -1,9 +1,10 @@
# power-save-blocker # powerSaveBlocker
The `power-save-blocker` module is used to block the system from entering The `power-save-blocker` module is used to block the system from entering
low-power(sleep) mode, allowing app to keep system and screen active. low-power (sleep) mode thus allowing the app to keep the system and screen
active.
An example is: For example:
```javascript ```javascript
var powerSaveBlocker = require('power-save-blocker'); var powerSaveBlocker = require('power-save-blocker');
@ -14,35 +15,40 @@ console.log(powerSaveBlocker.isStarted(id));
powerSaveBlocker.stop(id); powerSaveBlocker.stop(id);
``` ```
## powerSaveBlocker.start(type) ## Methods
* `type` String - Power save blocker type The `powerSaveBlocker` module has the following methods:
### `powerSaveBlocker.start(type)`
* `type` String - Power save blocker type.
* `prevent-app-suspension` - Prevent the application from being suspended. * `prevent-app-suspension` - Prevent the application from being suspended.
Keeps system active, but allows screen to be turned off. Example use cases: Keeps system active but allows screen to be turned off. Example use cases:
downloading a file, playing audio. downloading a file or playing audio.
* `prevent-display-sleep`- Prevent the display from going to sleep. Keeps system * `prevent-display-sleep`- Prevent the display from going to sleep. Keeps
and screen active. Example use case: playing video. system and screen active. Example use case: playing video.
Starts the power save blocker preventing the system entering lower-power mode. Starts the power save blocker preventing the system from entering lower-power
Returns an integer identified the power save blocker. mode. Returns an integer identifying the power save blocker.
**Note:** **Note:** `prevent-display-sleep` has higher has precedence over
`prevent-display-sleep` has higher precedence level than `prevent-app-suspension`. `prevent-app-suspension`. Only the highest precedence type takes effect. In
Only the highest precedence type takes effect. In other words, `prevent-display-sleep` other words, `prevent-display-sleep` always take precedence over
always take precedence over `prevent-app-suspension`. `prevent-app-suspension`.
For example, an API calling A requests for `prevent-app-suspension`, and For example, an API calling A requests for `prevent-app-suspension`, and
another calling B requests for `prevent-display-sleep`. `prevent-display-sleep` another calling B requests for `prevent-display-sleep`. `prevent-display-sleep`
will be used until B stops its request. After that, `prevent-app-suspension` is used. will be used until B stops its request. After that, `prevent-app-suspension`
is used.
## powerSaveBlocker.stop(id) ### `powerSaveBlocker.stop(id)`
* `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`. * `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`.
Stops the specified power save blocker. Stops the specified power save blocker.
## powerSaveBlocker.isStarted(id) ### `powerSaveBlocker.isStarted(id)`
* `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`. * `id` Integer - The power save blocker id returned by `powerSaveBlocker.start`.
Returns whether the corresponding `powerSaveBlocker` starts. Returns a boolean whether the corresponding `powerSaveBlocker` has started.