GetLoginItemSettings (fable-electron-docs-api)

GetLoginItemSettings Type

Namespace: Fable.Electron
Assembly: Fable.Electron.dll
Parent Module: App
Base Type: obj

Constructors

Constructor Description

Constructor	Description
`GetLoginItemSettings(openAtLogin, openAsHidden, wasOpenedAtLogin, wasOpenedAsHidden, restoreState, status, executableWillLaunchAtLogin, launchItems)` Full Usage: `GetLoginItemSettings(openAtLogin, openAsHidden, wasOpenedAtLogin, wasOpenedAsHidden, restoreState, status, executableWillLaunchAtLogin, launchItems)` Parameters: openAtLogin : `bool` - `true` if the app is set to open at login. openAsHidden : `bool` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| `true` if the app is set to open as hidden at login. This does not work on macOS 13 and up. wasOpenedAtLogin : `bool` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| `true` if the app was opened at login automatically. wasOpenedAsHidden : `bool` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| `true` if the app was opened as a hidden login item. This indicates that the app should not open any windows at startup. This setting is not available on MAS builds or on macOS 13 and up. restoreState : `bool` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| `true` if the app was opened as a login item that 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 closed. This setting is not available on MAS builds or on macOS 13 and up. status : `string` - ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| can be one of `not-registered`, `enabled`, `requires-approval`, or `not-found`. executableWillLaunchAtLogin : `bool` - ⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ \|\| `true` if app is set to open at login and its run key is not deactivated. This differs from `openAtLogin` as it ignores the `args` option, this property will be true if the given executable would be launched at login with any arguments. launchItems : `LaunchItems[]` - ⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ Returns: `GetLoginItemSettings`	openAtLogin : `bool` `true` if the app is set to open at login. openAsHidden : `bool` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| `true` if the app is set to open as hidden at login. This does not work on macOS 13 and up. wasOpenedAtLogin : `bool` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| `true` if the app was opened at login automatically. wasOpenedAsHidden : `bool` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| `true` if the app was opened as a hidden login item. This indicates that the app should not open any windows at startup. This setting is not available on MAS builds or on macOS 13 and up. restoreState : `bool` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| `true` if the app was opened as a login item that 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 closed. This setting is not available on MAS builds or on macOS 13 and up. status : `string` ⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ \|\| can be one of `not-registered`, `enabled`, `requires-approval`, or `not-found`. executableWillLaunchAtLogin : `bool` ⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ \|\| `true` if app is set to open at login and its run key is not deactivated. This differs from `openAtLogin` as it ignores the `args` option, this property will be true if the given executable would be launched at login with any arguments. launchItems : `LaunchItems[]` ⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌ Returns: `GetLoginItemSettings`


                
                  
                    
                      GetLoginItemSettings(openAtLogin, openAsHidden, wasOpenedAtLogin, wasOpenedAsHidden, restoreState, status, executableWillLaunchAtLogin, launchItems)

Full Usage:

GetLoginItemSettings(openAtLogin, openAsHidden, wasOpenedAtLogin, wasOpenedAsHidden, restoreState, status, executableWillLaunchAtLogin, launchItems)

Parameters:

openAtLogin : bool - true if the app is set to open at login.

openAsHidden : bool - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || true if the app is set to open as hidden at login. This does not work on macOS 13 and up.

wasOpenedAtLogin : bool - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || true if the app was opened at login automatically.

wasOpenedAsHidden : bool - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || true if the app was opened as a hidden login item. This indicates that the app should not open any windows at startup. This setting is not available on MAS builds or on macOS 13 and up.

restoreState : bool - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || true if the app was opened as a login item that 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 closed. This setting is not available on MAS builds or on macOS 13 and up.

status : string - ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || can be one of not-registered, enabled, requires-approval, or not-found.

executableWillLaunchAtLogin : bool - ⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ || true if app is set to open at login and its run key is not deactivated. This differs from openAtLogin as it ignores the args option, this property will be true if the given executable would be launched at login with **any** arguments.

launchItems : LaunchItems[] - ⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌

Returns: GetLoginItemSettings

openAtLogin : bool: true if the app is set to open at login.
openAsHidden : bool: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || true if the app is set to open as hidden at login. This does not work on macOS 13 and up.
wasOpenedAtLogin : bool: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || true if the app was opened at login automatically.
wasOpenedAsHidden : bool: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || true if the app was opened as a hidden login item. This indicates that the app should not open any windows at startup. This setting is not available on MAS builds or on macOS 13 and up.
restoreState : bool: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || true if the app was opened as a login item that 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 closed. This setting is not available on MAS builds or on macOS 13 and up.
status : string: ⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || can be one of not-registered, enabled, requires-approval, or not-found.
executableWillLaunchAtLogin : bool: ⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ || true if app is set to open at login and its run key is not deactivated. This differs from openAtLogin as it ignores the args option, this property will be true if the given executable would be launched at login with **any** arguments.
launchItems : LaunchItems[]: ⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌

Returns: GetLoginItemSettings

Instance members

Instance member	Description
`this.executableWillLaunchAtLogin` Full Usage: `this.executableWillLaunchAtLogin`	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌true if app is set to open at login and its run key is not deactivated. This differs from openAtLogin as it ignores the args option, this property will be true if the given executable would be launched at login with any arguments.
`this.launchItems` Full Usage: `this.launchItems`	⚠ OS Compatibility: WIN ✔ \| MAC ❌ \| LIN ❌ \| MAS ❌
`this.openAtLogin` Full Usage: `this.openAtLogin`	true if the app is set to open at login.
`this.status` Full Usage: `this.status`	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌ can be one of not-registered, enabled, requires-approval, or not-found.
`this.wasOpenedAtLogin` Full Usage: `this.wasOpenedAtLogin`	⚠ OS Compatibility: WIN ❌ \| MAC ✔ \| LIN ❌ \| MAS ❌true if the app was opened at login automatically.