Skip to content

ElectronLoginItemSettings

Unofficial

The app’s login item settings.

Import:

import type { ElectronLoginItemSettings } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface ElectronLoginItemSettings

Properties

PropertyTypeDescription
executableWillLaunchAtLoginbooleantrue if app is set to open at login and its run key is not deactivated. Differs from openAtLogin as it ignores the args option. Windows only.
launchItemsElectronLaunchItems[]The list of registry-backed launch items. Windows only.
openAsHiddenbooleantrue if the app is set to open as hidden at login. Not available on MAS builds. macOS only.
openAtLoginbooleantrue if the app is set to open at login.
restoreStatebooleantrue if the app was opened as a login item that should restore the state from the previous session. Not available on MAS builds. macOS only.
wasOpenedAsHiddenbooleantrue if the app was opened as a hidden login item. Not available on MAS builds. macOS only.
wasOpenedAtLoginbooleantrue if the app was opened at login automatically. Not available on MAS builds. macOS only.

Links to this page: