Skip to content

Commit 66d16b2

Browse files
committed
Add Windows label to login items settings API
1 parent 64513f8 commit 66d16b2

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/api/app.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -611,30 +611,33 @@ Returns the current value displayed in the counter badge.
611611

612612
Returns whether current desktop environment is Unity launcher.
613613

614-
### `app.getLoginItemSettings()` _macOS_
614+
### `app.getLoginItemSettings()` _macOS_ _Windows_
615615

616616
Return an Object with the login item settings of the app.
617617

618618
* `openAtLogin` Boolean - `true` if the app is set to open at login.
619619
* `openAsHidden` Boolean - `true` if the app is set to open as hidden at login.
620+
This setting is only supported on macOS.
620621
* `wasOpenedAtLogin` Boolean - `true` if the app was opened at login
621-
automatically.
622+
automatically. This setting is only supported on macOS.
622623
* `wasOpenedAsHidden` Boolean - `true` if the app was opened as a hidden login
623624
item. This indicates that the app should not open any windows at startup.
625+
This setting is only supported on macOS.
624626
* `restoreState` Boolean - `true` if the app was opened as a login item that
625627
should restore the state from the previous session. This indicates that the
626628
app should restore the windows that were open the last time the app was
627-
closed.
629+
closed. This setting is only supported on macOS.
628630

629-
### `app.setLoginItemSettings(settings)` _macOS_
631+
### `app.setLoginItemSettings(settings)` _macOS_ _Windows_
630632

631633
* `settings` Object
632634
* `openAtLogin` Boolean - `true` to open the app at login, `false` to remove
633635
the app as a login item. Defaults to `false`.
634636
* `openAsHidden` Boolean - `true` to open the app as hidden. Defaults to
635637
`false`. The user can edit this setting from the System Preferences so
636638
`app.getLoginItemStatus().wasOpenedAsHidden` should be checked when the app
637-
is opened to know the current value.
639+
is opened to know the current value. This setting is only supported on
640+
macOS.
638641

639642
Set the app's login item settings.
640643

0 commit comments

Comments
 (0)