From 49b32b8380a9aae4f98a4d40baa09295ea69a151 Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Wed, 6 Jul 2016 14:17:19 -0700 Subject: [PATCH] Mention open as hidden is manually configurable --- docs/api/app.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/api/app.md b/docs/api/app.md index 71e47c8a7a16..7816f7fe986f 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -600,7 +600,7 @@ Returns whether current desktop environment is Unity launcher. ### `app.getLoginItemStatus()` _macOS_ -Return an Object with the login item status the app. +Return an Object with the login item status of the app. * `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. @@ -615,15 +615,17 @@ Return an Object with the login item status the app. ### `app.setAsLoginItem([openAsHidden])` _macOS_ Set the app as a login item. This will cause the app to be opened automatically -on login. +at login. -* `openAsHidden` Boolean - `true` to hide the app when opened. Defaults to - `false`. +* `openAsHidden` Boolean - `true` to open the app as hidden. Defaults to + `false`. The user can edit this setting from the System Preferences so + `app.getLoginItemStatus().openedAsHidden` should be checked when the app + is opened to know the current value. ### `app.removeAsLoginItem()` _macOS_ Removes the app as a login item. The app will no longer be opened automatically -on login. +at login. ### `app.commandLine.appendSwitch(switch[, value])`