Merge pull request #6932 from electron/fix-power-save-blocker-doc-bug
Fix some invalid docs
This commit is contained in:
commit
e84d0ebb7e
6 changed files with 8 additions and 11 deletions
|
@ -1058,7 +1058,7 @@ The `flags` is an array that can include following `String`s:
|
||||||
|
|
||||||
#### `win.setThumbnailClip(region)` _Windows_
|
#### `win.setThumbnailClip(region)` _Windows_
|
||||||
|
|
||||||
* `region` - Object
|
* `region` Object - Region of the window
|
||||||
* `x` Integer - x-position of region
|
* `x` Integer - x-position of region
|
||||||
* `y` Integer - y-position of region
|
* `y` Integer - y-position of region
|
||||||
* `width` Integer - width of region
|
* `width` Integer - width of region
|
||||||
|
|
|
@ -8,7 +8,7 @@ See [`Menu`](menu.md) for examples.
|
||||||
|
|
||||||
Create a new `MenuItem` with the following method:
|
Create a new `MenuItem` with the following method:
|
||||||
|
|
||||||
### new MenuItem(options)
|
### `new MenuItem(options)`
|
||||||
|
|
||||||
* `options` Object
|
* `options` Object
|
||||||
* `click` Function - Will be called with
|
* `click` Function - Will be called with
|
||||||
|
|
|
@ -23,7 +23,7 @@ The `powerSaveBlocker` module has the following methods:
|
||||||
* `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 or playing audio.
|
downloading a file or playing audio.
|
||||||
* `prevent-display-sleep`- Prevent the display from going to sleep. Keeps
|
* `prevent-display-sleep` - Prevent the display from going to sleep. Keeps
|
||||||
system and screen active. Example use case: playing video.
|
system and screen active. Example use case: playing video.
|
||||||
|
|
||||||
Starts preventing the system from entering lower-power mode. Returns an integer
|
Starts preventing the system from entering lower-power mode. Returns an integer
|
||||||
|
|
|
@ -21,7 +21,7 @@ console.log(ses.getUserAgent())
|
||||||
|
|
||||||
The `session` module has the following methods:
|
The `session` module has the following methods:
|
||||||
|
|
||||||
### session.fromPartition(partition[, options])
|
### `session.fromPartition(partition[, options])`
|
||||||
|
|
||||||
* `partition` String
|
* `partition` String
|
||||||
* `options` Object
|
* `options` Object
|
||||||
|
@ -44,7 +44,7 @@ of an existing `Session` object.
|
||||||
|
|
||||||
The `session` module has the following properties:
|
The `session` module has the following properties:
|
||||||
|
|
||||||
### session.defaultSession
|
### `session.defaultSession`
|
||||||
|
|
||||||
Returns the default session object of the app.
|
Returns the default session object of the app.
|
||||||
|
|
||||||
|
|
|
@ -63,9 +63,7 @@ Removes the subscriber with `id`.
|
||||||
### `systemPreferences.subscribeLocalNotification(event, callback)` _macOS_
|
### `systemPreferences.subscribeLocalNotification(event, callback)` _macOS_
|
||||||
|
|
||||||
Same as `subscribeNotification`, but uses `NSNotificationCenter` for local defaults.
|
Same as `subscribeNotification`, but uses `NSNotificationCenter` for local defaults.
|
||||||
This is necessary for events such as:
|
This is necessary for events such as `NSUserDefaultsDidChangeNotification`
|
||||||
|
|
||||||
* `NSUserDefaultsDidChangeNotification`
|
|
||||||
|
|
||||||
### `systemPreferences.unsubscribeLocalNotification(id)` _macOS_
|
### `systemPreferences.unsubscribeLocalNotification(id)` _macOS_
|
||||||
|
|
||||||
|
|
|
@ -933,7 +933,6 @@ Opens the developer tools for the service worker context.
|
||||||
#### `contents.send(channel[, arg1][, arg2][, ...])`
|
#### `contents.send(channel[, arg1][, arg2][, ...])`
|
||||||
|
|
||||||
* `channel` String
|
* `channel` String
|
||||||
* `arg` (optional)
|
|
||||||
|
|
||||||
Send an asynchronous message to renderer process via `channel`, you can also
|
Send an asynchronous message to renderer process via `channel`, you can also
|
||||||
send arbitrary arguments. Arguments will be serialized in JSON internally and
|
send arbitrary arguments. Arguments will be serialized in JSON internally and
|
||||||
|
@ -977,8 +976,8 @@ app.on('ready', () => {
|
||||||
|
|
||||||
* `screenPosition` String - Specify the screen type to emulate
|
* `screenPosition` String - Specify the screen type to emulate
|
||||||
(default: `desktop`)
|
(default: `desktop`)
|
||||||
* `desktop`
|
* `desktop` - Desktop screen type
|
||||||
* `mobile`
|
* `mobile` - Mobile screen type
|
||||||
* `screenSize` Object - Set the emulated screen size (screenPosition == mobile)
|
* `screenSize` Object - Set the emulated screen size (screenPosition == mobile)
|
||||||
* `width` Integer - Set the emulated screen width
|
* `width` Integer - Set the emulated screen width
|
||||||
* `height` Integer - Set the emulated screen height
|
* `height` Integer - Set the emulated screen height
|
||||||
|
|
Loading…
Reference in a new issue