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

Add Windows label to login items settings API

Browse source
This commit is contained in:
Kevin Sawicki 2016-07-11 12:36:06 -07:00
parent 64513f8c69
commit 66d16b2871
1 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/api/app.md
View file

@ -611,22 +611,24 @@ Returns the current value displayed in the counter badge.
Returns whether current desktop environment is Unity launcher. Returns whether current desktop environment is Unity launcher.
### `app.getLoginItemSettings()` _macOS_ ### `app.getLoginItemSettings()` _macOS_ _Windows_
Return an Object with the login item settings of the app. Return an Object with the login item settings of the app.
* `openAtLogin` Boolean - `true` if the app is set to open at login. * `openAtLogin` Boolean - `true` if the app is set to open at login.
* `openAsHidden` Boolean - `true` if the app is set to open as hidden at login. * `openAsHidden` Boolean - `true` if the app is set to open as hidden at login.
This setting is only supported on macOS.
* `wasOpenedAtLogin` Boolean - `true` if the app was opened at login * `wasOpenedAtLogin` Boolean - `true` if the app was opened at login
automatically. automatically. This setting is only supported on macOS.
* `wasOpenedAsHidden` Boolean - `true` if the app was opened as a hidden login * `wasOpenedAsHidden` Boolean - `true` if the app was opened as a hidden login
item. This indicates that the app should not open any windows at startup. item. This indicates that the app should not open any windows at startup.
This setting is only supported on macOS.
* `restoreState` Boolean - `true` if the app was opened as a login item that * `restoreState` Boolean - `true` if the app was opened as a login item that
should restore the state from the previous session. This indicates that the should restore the state from the previous session. This indicates that the
app should restore the windows that were open the last time the app was app should restore the windows that were open the last time the app was
closed. closed. This setting is only supported on macOS.
### `app.setLoginItemSettings(settings)` _macOS_ ### `app.setLoginItemSettings(settings)` _macOS_ _Windows_
* `settings` Object * `settings` Object
* `openAtLogin` Boolean - `true` to open the app at login, `false` to remove * `openAtLogin` Boolean - `true` to open the app at login, `false` to remove
@ -634,7 +636,8 @@ Return an Object with the login item settings of the app.
* `openAsHidden` Boolean - `true` to open the app as hidden. Defaults to * `openAsHidden` Boolean - `true` to open the app as hidden. Defaults to
`false`. The user can edit this setting from the System Preferences so `false`. The user can edit this setting from the System Preferences so
`app.getLoginItemStatus().wasOpenedAsHidden` should be checked when the app `app.getLoginItemStatus().wasOpenedAsHidden` should be checked when the app
is opened to know the current value. is opened to know the current value. This setting is only supported on
macOS.
Set the app's login item settings. Set the app's login item settings.