fable-electron-docs-api
app Type
⚠ Process Availability: Main ✔ | Renderer ❌ | Utility ❌ | Exported ✔
Control your application's event lifecycle.Process: MainThe following example shows how to quit the application when the last window is closed:
Static members
| Static member |
Description
|
Full Usage:
app.accessibilitySupportEnabled
|
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ A boolean property that's true if Chrome's accessibility support is enabled, false otherwise. This property will be true if the use of assistive technologies, such as screen readers, has been detected. Setting this property to true manually enables Chrome's accessibility support, allowing developers to expose accessibility switch to users in application settings.See Chromium's accessibility docs for more details. Disabled by default.This API must be called after the ready event is emitted.> [!NOTE] Rendering accessibility tree can significantly affect the performance of your app. It should not be enabled by default. |
Full Usage:
app.addRecentDocument path
Parameters:
string
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Adds path to the recent documents list.This list is managed by the OS. On Windows, you can visit the list from the task bar, and on macOS, you can visit it from dock menu.
|
Full Usage:
app.applicationMenu
|
A Menu | null property that returns Menu if one has been set and null otherwise. Users can pass a Menu to set this property. |
Full Usage:
app.badgeCount
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ✔ | MAS ❌ An Integer property that returns the badge count for current app. Setting the count to 0 will hide the badge.On macOS, setting this with any nonzero integer shows on the dock icon. On Linux, this property only works for Unity launcher.> [!NOTE] Unity launcher requires a .desktop file to work. For more information, please read the Unity integration documentation.> [!NOTE] On macOS, you need to ensure that your application has the permission to display notifications for this property to take effect. |
Full Usage:
app.clearRecentDocuments ()
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Clears the recent documents list. |
|
A CommandLine object that allows you to read and manipulate the command line arguments that Chromium uses.
|
Full Usage:
app.configureHostResolver (?enableBuiltInResolver, ?enableHappyEyeballs, ?secureDnsMode, ?secureDnsServers, ?enableAdditionalDnsQueryTypes)
Parameters:
bool
?enableHappyEyeballs : bool
?secureDnsMode : SecureDnsMode
?secureDnsServers : string[]
?enableAdditionalDnsQueryTypes : bool
Modifiers: inline |
Configures host resolution (DNS and DNS-over-HTTPS). By default, the following resolvers will be used, in order:* DNS-over-HTTPS, if the DNS provider supports it, then* the built-in resolver (enabled on macOS only by default), then* the system's resolver (e.g. getaddrinfo).This can be configured to either restrict usage of non-encrypted DNS (secureDnsMode: "secure"), or disable DNS-over-HTTPS (secureDnsMode: "off"). It is also possible to enable or disable the built-in resolver.To disable insecure DNS, you can specify a secureDnsMode of "secure". If you do so, you should make sure to provide a list of DNS-over-HTTPS servers to use, in case the user's DNS configuration does not include a provider that supports DoH.This API must be called after the ready event is emitted.
|
Full Usage:
app.disableDomainBlockingFor3DAPIs ()
Modifiers: inline |
By default, Chromium disables 3D APIs (e.g. WebGL) until restart on a per domain basis if the GPU processes crashes too frequently. This function disables that behavior.This method can only be called before app is ready. |
Full Usage:
app.disableHardwareAcceleration ()
Modifiers: inline |
Disables hardware acceleration for current app.This method can only be called before app is ready. |
Full Usage:
app.enableSandbox ()
Modifiers: inline |
Enables full sandbox mode on the app. This means that all renderers will be launched sandboxed, regardless of the value of the sandbox flag in WebPreferences.This method can only be called before app is ready. |
Full Usage:
app.exit ?exitCode
Parameters:
int
Modifiers: inline |
Exits immediately with exitCode. exitCode defaults to 0.All windows will be closed immediately without asking the user, and the before-quit and will-quit events will not be emitted.
|
Full Usage:
app.focus steal
Parameters:
bool
Modifiers: inline |
On macOS, makes the application the active app. On Windows, focuses on the application's first window. On Linux, either focuses on the first visible window (X11) or requests focus but may instead show a notification or flash the app icon (Wayland).You should seek to use the steal option as sparingly as possible.
|
Full Usage:
app.getAccessibilitySupportFeatures ()
Returns: string[]
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Array of strings naming currently enabled accessibility support components. Possible values:* nativeAPIs - Native OS accessibility APIs integration enabled.* webContents - Web contents accessibility tree exposure enabled.* inlineTextBoxes - Inline text boxes (character bounding boxes) enabled.* extendedProperties - Extended accessibility properties enabled.* screenReader - Screen reader specific mode enabled.* html - HTML accessibility tree construction enabled.* labelImages - Accessibility support for automatic image annotations.* pdfPrinting - Accessibility support for PDF printing enabled.Notes:* The array may be empty if no accessibility modes are active.* Use app.isAccessibilitySupportEnabled() for the legacy boolean check; prefer this method for granular diagnostics or telemetry.Example:
|
|
Array of ProcessMetric objects that correspond to memory and CPU usage statistics of all the processes associated with the app.
|
Full Usage:
app.getAppPath ()
Returns: string
Modifiers: inline |
The current application directory.
|
Full Usage:
app.getApplicationInfoForProtocol url
Parameters:
string
Returns: Promise<GetApplicationInfoForProtocol>
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Resolve with an object containing the following:* icon NativeImage - the display icon of the app handling the protocol.* path string - installation path of the app handling the protocol.* name string - display name of the app handling the protocol.This method returns a promise that contains the application name, icon and path of the default handler for the protocol (aka URI scheme) of a URL.
|
Full Usage:
app.getApplicationNameForProtocol url
Parameters:
string
Returns: string
Modifiers: inline |
Name of the application handling the protocol, or an empty string if there is no handler. For instance, if Electron is the default handler of the URL, this could be Electron on Windows and Mac. However, don't rely on the precise format which is not guaranteed to remain unchanged. Expect a different format on Linux, possibly with a .desktop suffix.This method returns the application name of the default handler for the protocol (aka URI scheme) of a URL.
|
Full Usage:
app.getBadgeCount ()
Returns: int
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ✔ | MAS ❌ The current value displayed in the counter badge.
|
Full Usage:
app.getCurrentActivityType ()
Returns: string
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ The type of the currently running activity.
|
Full Usage:
app.getFileIcon (path, ?options)
Parameters:
string
?options : Options
Returns: Promise<NativeImage>
Modifiers: inline |
fulfilled with the app's icon, which is a NativeImage.Fetches a path's associated icon.On Windows, there a 2 kinds of icons:* Icons associated with certain file extensions, like .mp3, .png, etc.* Icons inside the file itself, like .exe, .dll, .ico.On Linux and macOS, icons depend on the application associated with file mime type.
|
|
The Graphics Feature Status from chrome://gpu/.> [!NOTE] This information is only usable after the gpu-info-update event is emitted.
|
|
For infoType equal to complete: Promise is fulfilled with Object containing all the GPU Information as in chromium's GPUInfo object. This includes the version and driver information that's shown on chrome://gpu page.For infoType equal to basic: Promise is fulfilled with Object containing fewer attributes than when requested with complete. Here's an example of basic response:Using basic should be preferred if only basic information like vendorId or deviceId is needed.
|
|
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌
|
Full Usage:
app.getLocale ()
Returns: string
Modifiers: inline |
The current application locale, fetched using Chromium's l10n_util library. Possible return values are documented here.To set the locale, you'll want to use a command line switch at app startup, which may be found here.> [!NOTE] When distributing your packaged app, you have to also ship the locales folder.> [!NOTE] This API must be called after the ready event is emitted.> [!NOTE] To see example return values of this API compared to other locale and language APIs, see app.getPreferredSystemLanguages().
|
Full Usage:
app.getLocaleCountryCode ()
Returns: string
Modifiers: inline |
User operating system's locale two-letter ISO 3166 country code. The value is taken from native OS APIs.> [!NOTE] When unable to detect locale country code, it returns empty string.
|
Full Usage:
app.getLoginItemSettings (?type, ?serviceName, ?path, ?args)
Parameters:
string
?serviceName : string
?path : string
?args : string[]
Returns: GetLoginItemSettings
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ If you provided path and args options to app.setLoginItemSettings, then you need to pass the same arguments here for openAtLogin to be set correctly.* openAtLogin boolean - true if the app is set to open at login.* openAsHidden boolean macOS Deprecated - true if the app is set to open as hidden at login. This does not work on macOS 13 and up.* wasOpenedAtLogin boolean macOS - true if the app was opened at login automatically.* wasOpenedAsHidden boolean macOS Deprecated - 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 boolean macOS Deprecated - 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 macOS - can be one of not-registered, enabled, requires-approval, or not-found.* executableWillLaunchAtLogin boolean Windows - 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 Object[] Windows * name string Windows - name value of a registry entry. * path string Windows - The executable to an app that corresponds to a registry entry. * args string[] Windows - the command-line arguments to pass to the executable. * scope string Windows - one of user or machine. Indicates whether the registry entry is under HKEY_CURRENT USER or HKEY_LOCAL_MACHINE. * enabled boolean Windows - true if the app registry key is startup approved and therefore shows as enabled in Task Manager and Windows settings.
|
Full Usage:
app.getName ()
Returns: string
Modifiers: inline |
The current application's name, which is the name in the application's package.json file.Usually the name field of package.json is a short lowercase name, according to the npm modules spec. You should usually also specify a productName field, which is your application's full capitalized name, and which will be preferred over name by Electron.
|
|
A path to a special directory or file associated with name. On failure, an Error is thrown.If app.getPath('logs') is called without called app.setAppLogsPath() being called first, a default log directory will be created equivalent to calling app.setAppLogsPath() without a path parameter.
|
Full Usage:
app.getPreferredSystemLanguages ()
Returns: string[]
Modifiers: inline |
The user's preferred system languages from most preferred to least preferred, including the country codes if applicable. A user can modify and add to this list on Windows or macOS through the Language and Region settings.The API uses GlobalizationPreferences (with a fallback to GetSystemPreferredUILanguages) on Windows, [NSLocale preferredLanguages] on macOS, and g_get_language_names on Linux.This API can be used for purposes such as deciding what language to present the application in.Here are some examples of return values of the various language and locale APIs with different configurations:On Windows, given application locale is German, the regional format is Finnish (Finland), and the preferred system languages from most to least preferred are French (Canada), English (US), Simplified Chinese (China), Finnish, and Spanish (Latin America):On macOS, given the application locale is German, the region is Finland, and the preferred system languages from most to least preferred are French (Canada), English (US), Simplified Chinese, and Spanish (Latin America):Both the available languages and regions and the possible return values differ between the two operating systems.As can be seen with the example above, on Windows, it is possible that a preferred system language has no country code, and that one of the preferred system languages corresponds with the language used for the regional format. On macOS, the region serves more as a default country code: the user doesn't need to have Finnish as a preferred language to use Finland as the region,and the country code FI is used as the country code for preferred system languages that do not have associated countries in the language name.
|
Full Usage:
app.getRecentDocuments ()
Returns: string[]
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ An array containing documents in the most recent documents list.
|
Full Usage:
app.getSystemLocale ()
Returns: string
Modifiers: inline |
The current system locale. On Windows and Linux, it is fetched using Chromium's i18n library. On macOS, [NSLocale currentLocale] is used instead. To get the user's current system language, which is not always the same as the locale, it is better to use app.getPreferredSystemLanguages().Different operating systems also use the regional data differently:* Windows 11 uses the regional format for numbers, dates, and times.* macOS Monterey uses the region for formatting numbers, dates, times, and for selecting the currency symbol to use.Therefore, this API can be used for purposes such as choosing a format for rendering dates and times in a calendar app, especially when the developer wants the format to be consistent with the OS.> [!NOTE] This API must be called after the ready event is emitted.> [!NOTE] To see example return values of this API compared to other locale and language APIs, see app.getPreferredSystemLanguages().
|
Full Usage:
app.getVersion ()
Returns: string
Modifiers: inline |
The version of the loaded application. If no version is found in the application's package.json file, the version of the current bundle or executable is returned.
|
Full Usage:
app.hasSingleInstanceLock ()
Returns: bool
Modifiers: inline |
This method returns whether or not this instance of your app is currently holding the single instance lock. You can request the lock with app.requestSingleInstanceLock() and release with app.releaseSingleInstanceLock()
|
Full Usage:
app.hide ()
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Hides all application windows without minimizing them. |
Full Usage:
app.importCertificate (options, callback)
Parameters:
Options
callback : int -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ✔ | MAS ❌ Imports the certificate in pkcs12 format into the platform certificate store. callback is called with the result of import operation, a value of 0 indicates success while any other value indicates failure according to Chromium net_error_list.
|
Full Usage:
app.invalidateCurrentActivity ()
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Invalidates the current Handoff user activity. |
Full Usage:
app.isAccessibilitySupportEnabled ()
Returns: bool
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ true if Chrome's accessibility support is enabled, false otherwise. This API will return true if the use of assistive technologies, such as screen readers, has been detected. See https://www.chromium.org/developers/design-documents/accessibility for more details.
|
Full Usage:
app.isDefaultProtocolClient (protocol, ?path, ?args)
Parameters:
string
?path : string
?args : string[]
Returns: bool
Modifiers: inline |
Whether the current executable is the default handler for a protocol (aka URI scheme).> [!NOTE] On macOS, you can use this method to check if the app has been registered as the default protocol handler for a protocol. You can also verify this by checking ~/Library/Preferences/com.apple.LaunchServices.plist on the macOS machine. Please refer to Apple's documentation for details.The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme internally.
|
Full Usage:
app.isEmojiPanelSupported ()
Returns: bool
Modifiers: inline |
whether or not the current OS version allows for native emoji pickers.
|
Full Usage:
app.isHidden ()
Returns: bool
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ true if the application—including all of its windows—is hidden (e.g. with Command-H), false otherwise.
|
Full Usage:
app.isInApplicationsFolder ()
Returns: bool
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Whether the application is currently running from the systems Application folder. Use in combination with app.moveToApplicationsFolder()
|
Full Usage:
app.isPackaged
Returns: bool
|
A boolean property that returns true if the app is packaged, false otherwise. For many apps, this property can be used to distinguish development and production environments.
|
Full Usage:
app.isReady ()
Returns: bool
Modifiers: inline |
true if Electron has finished initializing, false otherwise. See also app.whenReady().
|
Full Usage:
app.isSecureKeyboardEntryEnabled ()
Returns: bool
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ whether Secure Keyboard Entry is enabled.By default this API will return false.
|
Full Usage:
app.isUnityRunning ()
Returns: bool
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ✔ | MAS ❌ Whether the current desktop environment is Unity launcher.
|
Full Usage:
app.moveToApplicationsFolder ?conflictHandler
Parameters:
ConflictType -> bool
Returns: bool
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Whether the move was successful. Please note that if the move is successful, your application will quit and relaunch.No confirmation dialog will be presented by default. If you wish to allow the user to confirm the operation, you may do so using the dialog API.NOTE: This method throws errors if anything other than the user causes the move to fail. For instance if the user cancels the authorization dialog, this method returns false. If we fail to perform the copy, then this method will throw an error. The message in the error should be informative and tell you exactly what went wrong.By default, if an app of the same name as the one being moved exists in the Applications directory and is not running, the existing app will be trashed and the active app moved into its place. If it is running, the preexisting running app will assume focus and the previously active app will quit itself. This behavior can be changed by providing the optional conflict handler, where the boolean returned by the handler determines whether or not the move conflict is resolved with default behavior. i.e. returning false will ensure no further action is taken, returning true will result in the default behavior and the method continuing.For example:Would mean that if an app already exists in the user directory, if the user chooses to 'Continue Move' then the function would continue with its default behavior and the existing app will be trashed and the active app moved into its place.
|
Full Usage:
app.name
|
A string property that indicates the current application's name, which is the name in the application's package.json file.Usually the name field of package.json is a short lowercase name, according to the npm modules spec. You should usually also specify a productName field, which is your application's full capitalized name, and which will be preferred over name by Electron. |
Full Usage:
app.offAccessibilitySupportChanged handler
Parameters:
IOnAccessibilitySupportChanged -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Chrome's accessibility support changes. This event fires when assistive technologies, such as screen readers, are enabled or disabled. See https://www.chromium.org/developers/design-documents/accessibility for more details.
|
Full Usage:
app.offAccessibilitySupportChanged handler
Parameters:
Event -> bool -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Chrome's accessibility support changes. This event fires when assistive technologies, such as screen readers, are enabled or disabled. See https://www.chromium.org/developers/design-documents/accessibility for more details.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the application is activated. Various actions can trigger this event, such as launching the application for the first time, attempting to re-launch the application when it's already running, or clicking on the application's dock or taskbar icon.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the application is activated. Various actions can trigger this event, such as launching the application for the first time, attempting to re-launch the application when it's already running, or clicking on the application's dock or taskbar icon.
|
Full Usage:
app.offActivityWasContinued handler
Parameters:
IOnActivityWasContinued -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff after an activity from this device was successfully resumed on another one.
|
Full Usage:
app.offActivityWasContinued handler
Parameters:
Event -> string -> obj -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff after an activity from this device was successfully resumed on another one.
|
|
Emitted before the application starts closing its windows. Calling event.preventDefault() will prevent the default behavior, which is terminating the application.> [!NOTE] If application quit was initiated by autoUpdater.quitAndInstall(), then before-quit is emitted after emitting close event on all windows and closing them.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
Full Usage:
app.offBrowserWindowBlur handler
Parameters:
IOnBrowserWindowBlur -> unit
Modifiers: inline |
Emitted when a browserWindow gets blurred.
|
Full Usage:
app.offBrowserWindowBlur handler
Parameters:
Event -> BrowserWindow -> unit
Modifiers: inline |
Emitted when a browserWindow gets blurred.
|
Full Usage:
app.offBrowserWindowCreated handler
Parameters:
IOnBrowserWindowCreated -> unit
Modifiers: inline |
Emitted when a new browserWindow is created.
|
Full Usage:
app.offBrowserWindowCreated handler
Parameters:
Event -> BrowserWindow -> unit
Modifiers: inline |
Emitted when a new browserWindow is created.
|
Full Usage:
app.offBrowserWindowFocus handler
Parameters:
IOnBrowserWindowFocus -> unit
Modifiers: inline |
Emitted when a browserWindow gets focused.
|
Full Usage:
app.offBrowserWindowFocus handler
Parameters:
Event -> BrowserWindow -> unit
Modifiers: inline |
Emitted when a browserWindow gets focused.
|
Full Usage:
app.offCertificateError handler
Parameters:
IOnCertificateError -> unit
Modifiers: inline |
Emitted when failed to verify the certificate for url, to trust the certificate you should prevent the default behavior with event.preventDefault() and call callback(true).
|
Full Usage:
app.offCertificateError handler
Parameters:
Event -> WebContents -> string -> string -> Certificate -> bool -> unit -> bool -> unit
Modifiers: inline |
Emitted when failed to verify the certificate for url, to trust the certificate you should prevent the default behavior with event.preventDefault() and call callback(true).
|
Full Usage:
app.offChildProcessGone handler
Parameters:
IOnChildProcessGone -> unit
Modifiers: inline |
Emitted when the child process unexpectedly disappears. This is normally because it was crashed or killed. It does not include renderer processes.
|
|
|
Full Usage:
app.offContinueActivity handler
Parameters:
IOnContinueActivity -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.A user activity can be continued only in an app that has the same developer Team ID as the activity's source app and that supports the activity's type. Supported activity types are specified in the app's Info.plist under the NSUserActivityTypes key.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.A user activity can be continued only in an app that has the same developer Team ID as the activity's source app and that supports the activity's type. Supported activity types are specified in the app's Info.plist under the NSUserActivityTypes key. |
Full Usage:
app.offContinueActivityError handler
Parameters:
IOnContinueActivityError -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device fails to be resumed.
|
Full Usage:
app.offContinueActivityError handler
Parameters:
Event -> string -> string -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device fails to be resumed.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the application becomes active. This differs from the activate event in that did-become-active is emitted every time the app becomes active, not only when Dock icon is clicked or application is re-launched. It is also emitted when a user switches to the app via the macOS App Switcher.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the app is no longer active and doesn’t have focus. This can be triggered, for example, by clicking on another application or by using the macOS App Switcher to switch to another application.
|
Full Usage:
app.offGpuInfoUpdate handler
Parameters:
unit -> unit
Modifiers: inline |
Emitted whenever there is a GPU info update.
|
|
Emitted when webContents or Utility process wants to do basic auth.The default behavior is to cancel all authentications. To override this you should prevent the default behavior with event.preventDefault() and call callback(username, password) with the credentials.If callback is called without a username or password, the authentication request will be cancelled and the authentication error will be returned to the page.
|
Full Usage:
app.offLogin handler
Parameters:
Event -> WebContents -> AuthenticationResponseDetails -> AuthInfo -> Option<string> * Option<string> -> unit -> unit
Modifiers: inline |
Emitted when webContents or Utility process wants to do basic auth.The default behavior is to cancel all authentications. To override this you should prevent the default behavior with event.preventDefault() and call callback(username, password) with the credentials.If callback is called without a username or password, the authentication request will be cancelled and the authentication error will be returned to the page.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user clicks the native macOS new tab button. The new tab button is only visible if the current BrowserWindow has a tabbingIdentifier
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a file with the application. The open-file event is usually emitted when the application is already open and the OS wants to reuse the application to open the file. open-file is also emitted when a file is dropped onto the dock and the application is not yet running. Make sure to listen for the open-file event very early in your application startup to handle this case (even before the ready event is emitted).You should call event.preventDefault() if you want to handle this event.On Windows, you have to parse process.argv (in the main process) to get the filepath.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a file with the application. The open-file event is usually emitted when the application is already open and the OS wants to reuse the application to open the file. open-file is also emitted when a file is dropped onto the dock and the application is not yet running. Make sure to listen for the open-file event very early in your application startup to handle this case (even before the ready event is emitted).You should call event.preventDefault() if you want to handle this event.On Windows, you have to parse process.argv (in the main process) to get the filepath.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a URL with the application. Your application's Info.plist file must define the URL scheme within the CFBundleURLTypes key, and set NSPrincipalClass to AtomApplication.As with the open-file event, be sure to register a listener for the open-url event early in your application startup to detect if the application is being opened to handle a URL. If you register the listener in response to a ready event, you'll miss URLs that trigger the launch of your application.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a URL with the application. Your application's Info.plist file must define the URL scheme within the CFBundleURLTypes key, and set NSPrincipalClass to AtomApplication.As with the open-file event, be sure to register a listener for the open-url event early in your application startup to detect if the application is being opened to handle a URL. If you register the listener in response to a ready event, you'll miss URLs that trigger the launch of your application.
|
|
Emitted when the application is quitting.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
|
Emitted when the application is quitting.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
|
Emitted once, when Electron has finished initializing. On macOS, launchInfo holds the userInfo of the NSUserNotification or information from UNNotificationResponse that was used to open the application, if it was launched from Notification Center. You can also call app.isReady() to check if this event has already fired and app.whenReady() to get a Promise that is fulfilled when Electron is initialized.> [!NOTE] The ready event is only fired after the main process has finished running the first tick of the event loop. If an Electron API needs to be called before the ready event, ensure that it is called synchronously in the top-level context of the main process.
|
Full Usage:
app.offReady handler
Parameters:
Event -> U2<Record<string, obj>, NotificationResponse> -> unit
Modifiers: inline |
Emitted once, when Electron has finished initializing. On macOS, launchInfo holds the userInfo of the NSUserNotification or information from UNNotificationResponse that was used to open the application, if it was launched from Notification Center. You can also call app.isReady() to check if this event has already fired and app.whenReady() to get a Promise that is fulfilled when Electron is initialized.> [!NOTE] The ready event is only fired after the main process has finished running the first tick of the event loop. If an Electron API needs to be called before the ready event, ensure that it is called synchronously in the top-level context of the main process.
|
Full Usage:
app.offRenderProcessGone handler
Parameters:
IOnRenderProcessGone -> unit
Modifiers: inline |
Emitted when the renderer process unexpectedly disappears. This is normally because it was crashed or killed.
|
Full Usage:
app.offRenderProcessGone handler
Parameters:
Event -> WebContents -> RenderProcessGoneDetails -> unit
Modifiers: inline |
Emitted when the renderer process unexpectedly disappears. This is normally because it was crashed or killed.
|
Full Usage:
app.offSecondInstance handler
Parameters:
IOnSecondInstance -> unit
Modifiers: inline |
This event will be emitted inside the primary instance of your application when a second instance has been executed and calls app.requestSingleInstanceLock().argv is an Array of the second instance's command line arguments, and workingDirectory is its current working directory. Usually applications respond to this by making their primary window focused and non-minimized.> [!NOTE] argv will not be exactly the same list of arguments as those passed to the second instance. The order might change and additional arguments might be appended. If you need to maintain the exact same arguments, it's advised to use additionalData instead.> [!NOTE] If the second instance is started by a different user than the first, the argv array will not include the arguments.This event is guaranteed to be emitted after the ready event of app gets emitted.> [!NOTE] Extra command line arguments might be added by Chromium, such as --original-process-start-time.
|
Full Usage:
app.offSecondInstance handler
Parameters:
Event -> string[] -> string -> obj -> unit
Modifiers: inline |
This event will be emitted inside the primary instance of your application when a second instance has been executed and calls app.requestSingleInstanceLock().argv is an Array of the second instance's command line arguments, and workingDirectory is its current working directory. Usually applications respond to this by making their primary window focused and non-minimized.> [!NOTE] argv will not be exactly the same list of arguments as those passed to the second instance. The order might change and additional arguments might be appended. If you need to maintain the exact same arguments, it's advised to use additionalData instead.> [!NOTE] If the second instance is started by a different user than the first, the argv array will not include the arguments.This event is guaranteed to be emitted after the ready event of app gets emitted.> [!NOTE] Extra command line arguments might be added by Chromium, such as --original-process-start-time.
|
Full Usage:
app.offSelectClientCertificate handler
Parameters:
IOnSelectClientCertificate -> unit
Modifiers: inline |
Emitted when a client certificate is requested.The url corresponds to the navigation entry requesting the client certificate and callback can be called with an entry filtered from the list. Using event.preventDefault() prevents the application from using the first certificate from the store.
|
Full Usage:
app.offSelectClientCertificate handler
Parameters:
Event -> WebContents -> URL -> Certificate[] -> Option<Certificate> -> unit -> unit
Modifiers: inline |
Emitted when a client certificate is requested.The url corresponds to the navigation entry requesting the client certificate and callback can be called with an entry filtered from the list. Using event.preventDefault() prevents the application from using the first certificate from the store.
|
|
Emitted when Electron has created a new session.
|
Full Usage:
app.offUpdateActivityState handler
Parameters:
IOnUpdateActivityState -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Handoff is about to be resumed on another device. If you need to update the state to be transferred, you should call event.preventDefault() immediately, construct a new userInfo dictionary and call app.updateCurrentActivity() in a timely manner. Otherwise, the operation will fail and continue-activity-error will be called.
|
Full Usage:
app.offUpdateActivityState handler
Parameters:
Event -> string -> obj -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Handoff is about to be resumed on another device. If you need to update the state to be transferred, you should call event.preventDefault() immediately, construct a new userInfo dictionary and call app.updateCurrentActivity() in a timely manner. Otherwise, the operation will fail and continue-activity-error will be called.
|
Full Usage:
app.offWebContentsCreated handler
Parameters:
IOnWebContentsCreated -> unit
Modifiers: inline |
Emitted when a new webContents is created.
|
Full Usage:
app.offWebContentsCreated handler
Parameters:
Event -> WebContents -> unit
Modifiers: inline |
Emitted when a new webContents is created.
|
Full Usage:
app.offWillContinueActivity handler
Parameters:
IOnWillContinueActivity -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff before an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.
|
Full Usage:
app.offWillContinueActivity handler
Parameters:
Event -> string -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff before an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.
|
Full Usage:
app.offWillFinishLaunching handler
Parameters:
unit -> unit
Modifiers: inline |
Emitted when the application has finished basic startup. On Windows and Linux, the will-finish-launching event is the same as the ready event; on macOS, this event represents the applicationWillFinishLaunching notification of NSApplication.In most cases, you should do everything in the ready event handler.
|
|
Emitted when all windows have been closed and the application will quit. Calling event.preventDefault() will prevent the default behavior, which is terminating the application.See the description of the window-all-closed event for the differences between the will-quit and window-all-closed events.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
Full Usage:
app.offWindowAllClosed handler
Parameters:
unit -> unit
Modifiers: inline |
Emitted when all windows have been closed.If you do not subscribe to this event and all windows are closed, the default behavior is to quit the app; however, if you subscribe, you control whether the app quits or not. If the user pressed Cmd + Q, or the developer called app.quit(), Electron will first try to close all the windows and then emit the will-quit event, and in this case the window-all-closed event would not be emitted.
|
Full Usage:
app.onAccessibilitySupportChanged handler
Parameters:
IOnAccessibilitySupportChanged -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Chrome's accessibility support changes. This event fires when assistive technologies, such as screen readers, are enabled or disabled. See https://www.chromium.org/developers/design-documents/accessibility for more details.
|
Full Usage:
app.onAccessibilitySupportChanged handler
Parameters:
Event -> bool -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Chrome's accessibility support changes. This event fires when assistive technologies, such as screen readers, are enabled or disabled. See https://www.chromium.org/developers/design-documents/accessibility for more details.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the application is activated. Various actions can trigger this event, such as launching the application for the first time, attempting to re-launch the application when it's already running, or clicking on the application's dock or taskbar icon.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the application is activated. Various actions can trigger this event, such as launching the application for the first time, attempting to re-launch the application when it's already running, or clicking on the application's dock or taskbar icon.
|
Full Usage:
app.onActivityWasContinued handler
Parameters:
IOnActivityWasContinued -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff after an activity from this device was successfully resumed on another one.
|
Full Usage:
app.onActivityWasContinued handler
Parameters:
Event -> string -> obj -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff after an activity from this device was successfully resumed on another one.
|
|
Emitted before the application starts closing its windows. Calling event.preventDefault() will prevent the default behavior, which is terminating the application.> [!NOTE] If application quit was initiated by autoUpdater.quitAndInstall(), then before-quit is emitted after emitting close event on all windows and closing them.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
Full Usage:
app.onBrowserWindowBlur handler
Parameters:
IOnBrowserWindowBlur -> unit
Modifiers: inline |
Emitted when a browserWindow gets blurred.
|
Full Usage:
app.onBrowserWindowBlur handler
Parameters:
Event -> BrowserWindow -> unit
Modifiers: inline |
Emitted when a browserWindow gets blurred.
|
Full Usage:
app.onBrowserWindowCreated handler
Parameters:
IOnBrowserWindowCreated -> unit
Modifiers: inline |
Emitted when a new browserWindow is created.
|
Full Usage:
app.onBrowserWindowCreated handler
Parameters:
Event -> BrowserWindow -> unit
Modifiers: inline |
Emitted when a new browserWindow is created.
|
Full Usage:
app.onBrowserWindowFocus handler
Parameters:
IOnBrowserWindowFocus -> unit
Modifiers: inline |
Emitted when a browserWindow gets focused.
|
Full Usage:
app.onBrowserWindowFocus handler
Parameters:
Event -> BrowserWindow -> unit
Modifiers: inline |
Emitted when a browserWindow gets focused.
|
Full Usage:
app.onCertificateError handler
Parameters:
IOnCertificateError -> unit
Modifiers: inline |
Emitted when failed to verify the certificate for url, to trust the certificate you should prevent the default behavior with event.preventDefault() and call callback(true).
|
Full Usage:
app.onCertificateError handler
Parameters:
Event -> WebContents -> string -> string -> Certificate -> bool -> unit -> bool -> unit
Modifiers: inline |
Emitted when failed to verify the certificate for url, to trust the certificate you should prevent the default behavior with event.preventDefault() and call callback(true).
|
Full Usage:
app.onChildProcessGone handler
Parameters:
IOnChildProcessGone -> unit
Modifiers: inline |
Emitted when the child process unexpectedly disappears. This is normally because it was crashed or killed. It does not include renderer processes.
|
|
|
Full Usage:
app.onContinueActivity handler
Parameters:
IOnContinueActivity -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.A user activity can be continued only in an app that has the same developer Team ID as the activity's source app and that supports the activity's type. Supported activity types are specified in the app's Info.plist under the NSUserActivityTypes key.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.A user activity can be continued only in an app that has the same developer Team ID as the activity's source app and that supports the activity's type. Supported activity types are specified in the app's Info.plist under the NSUserActivityTypes key. |
Full Usage:
app.onContinueActivityError handler
Parameters:
IOnContinueActivityError -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device fails to be resumed.
|
Full Usage:
app.onContinueActivityError handler
Parameters:
Event -> string -> string -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device fails to be resumed.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the application becomes active. This differs from the activate event in that did-become-active is emitted every time the app becomes active, not only when Dock icon is clicked or application is re-launched. It is also emitted when a user switches to the app via the macOS App Switcher.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the app is no longer active and doesn’t have focus. This can be triggered, for example, by clicking on another application or by using the macOS App Switcher to switch to another application.
|
Full Usage:
app.onGpuInfoUpdate handler
Parameters:
unit -> unit
Modifiers: inline |
Emitted whenever there is a GPU info update.
|
|
Emitted when webContents or Utility process wants to do basic auth.The default behavior is to cancel all authentications. To override this you should prevent the default behavior with event.preventDefault() and call callback(username, password) with the credentials.If callback is called without a username or password, the authentication request will be cancelled and the authentication error will be returned to the page.
|
Full Usage:
app.onLogin handler
Parameters:
Event -> WebContents -> AuthenticationResponseDetails -> AuthInfo -> Option<string> * Option<string> -> unit -> unit
Modifiers: inline |
Emitted when webContents or Utility process wants to do basic auth.The default behavior is to cancel all authentications. To override this you should prevent the default behavior with event.preventDefault() and call callback(username, password) with the credentials.If callback is called without a username or password, the authentication request will be cancelled and the authentication error will be returned to the page.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user clicks the native macOS new tab button. The new tab button is only visible if the current BrowserWindow has a tabbingIdentifier
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a file with the application. The open-file event is usually emitted when the application is already open and the OS wants to reuse the application to open the file. open-file is also emitted when a file is dropped onto the dock and the application is not yet running. Make sure to listen for the open-file event very early in your application startup to handle this case (even before the ready event is emitted).You should call event.preventDefault() if you want to handle this event.On Windows, you have to parse process.argv (in the main process) to get the filepath.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a file with the application. The open-file event is usually emitted when the application is already open and the OS wants to reuse the application to open the file. open-file is also emitted when a file is dropped onto the dock and the application is not yet running. Make sure to listen for the open-file event very early in your application startup to handle this case (even before the ready event is emitted).You should call event.preventDefault() if you want to handle this event.On Windows, you have to parse process.argv (in the main process) to get the filepath.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a URL with the application. Your application's Info.plist file must define the URL scheme within the CFBundleURLTypes key, and set NSPrincipalClass to AtomApplication.As with the open-file event, be sure to register a listener for the open-url event early in your application startup to detect if the application is being opened to handle a URL. If you register the listener in response to a ready event, you'll miss URLs that trigger the launch of your application.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a URL with the application. Your application's Info.plist file must define the URL scheme within the CFBundleURLTypes key, and set NSPrincipalClass to AtomApplication.As with the open-file event, be sure to register a listener for the open-url event early in your application startup to detect if the application is being opened to handle a URL. If you register the listener in response to a ready event, you'll miss URLs that trigger the launch of your application.
|
|
Emitted when the application is quitting.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
|
Emitted when the application is quitting.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
|
Emitted once, when Electron has finished initializing. On macOS, launchInfo holds the userInfo of the NSUserNotification or information from UNNotificationResponse that was used to open the application, if it was launched from Notification Center. You can also call app.isReady() to check if this event has already fired and app.whenReady() to get a Promise that is fulfilled when Electron is initialized.> [!NOTE] The ready event is only fired after the main process has finished running the first tick of the event loop. If an Electron API needs to be called before the ready event, ensure that it is called synchronously in the top-level context of the main process.
|
Full Usage:
app.onReady handler
Parameters:
Event -> U2<Record<string, obj>, NotificationResponse> -> unit
Modifiers: inline |
Emitted once, when Electron has finished initializing. On macOS, launchInfo holds the userInfo of the NSUserNotification or information from UNNotificationResponse that was used to open the application, if it was launched from Notification Center. You can also call app.isReady() to check if this event has already fired and app.whenReady() to get a Promise that is fulfilled when Electron is initialized.> [!NOTE] The ready event is only fired after the main process has finished running the first tick of the event loop. If an Electron API needs to be called before the ready event, ensure that it is called synchronously in the top-level context of the main process.
|
Full Usage:
app.onRenderProcessGone handler
Parameters:
IOnRenderProcessGone -> unit
Modifiers: inline |
Emitted when the renderer process unexpectedly disappears. This is normally because it was crashed or killed.
|
Full Usage:
app.onRenderProcessGone handler
Parameters:
Event -> WebContents -> RenderProcessGoneDetails -> unit
Modifiers: inline |
Emitted when the renderer process unexpectedly disappears. This is normally because it was crashed or killed.
|
Full Usage:
app.onSecondInstance handler
Parameters:
IOnSecondInstance -> unit
Modifiers: inline |
This event will be emitted inside the primary instance of your application when a second instance has been executed and calls app.requestSingleInstanceLock().argv is an Array of the second instance's command line arguments, and workingDirectory is its current working directory. Usually applications respond to this by making their primary window focused and non-minimized.> [!NOTE] argv will not be exactly the same list of arguments as those passed to the second instance. The order might change and additional arguments might be appended. If you need to maintain the exact same arguments, it's advised to use additionalData instead.> [!NOTE] If the second instance is started by a different user than the first, the argv array will not include the arguments.This event is guaranteed to be emitted after the ready event of app gets emitted.> [!NOTE] Extra command line arguments might be added by Chromium, such as --original-process-start-time.
|
Full Usage:
app.onSecondInstance handler
Parameters:
Event -> string[] -> string -> obj -> unit
Modifiers: inline |
This event will be emitted inside the primary instance of your application when a second instance has been executed and calls app.requestSingleInstanceLock().argv is an Array of the second instance's command line arguments, and workingDirectory is its current working directory. Usually applications respond to this by making their primary window focused and non-minimized.> [!NOTE] argv will not be exactly the same list of arguments as those passed to the second instance. The order might change and additional arguments might be appended. If you need to maintain the exact same arguments, it's advised to use additionalData instead.> [!NOTE] If the second instance is started by a different user than the first, the argv array will not include the arguments.This event is guaranteed to be emitted after the ready event of app gets emitted.> [!NOTE] Extra command line arguments might be added by Chromium, such as --original-process-start-time.
|
Full Usage:
app.onSelectClientCertificate handler
Parameters:
IOnSelectClientCertificate -> unit
Modifiers: inline |
Emitted when a client certificate is requested.The url corresponds to the navigation entry requesting the client certificate and callback can be called with an entry filtered from the list. Using event.preventDefault() prevents the application from using the first certificate from the store.
|
Full Usage:
app.onSelectClientCertificate handler
Parameters:
Event -> WebContents -> URL -> Certificate[] -> Option<Certificate> -> unit -> unit
Modifiers: inline |
Emitted when a client certificate is requested.The url corresponds to the navigation entry requesting the client certificate and callback can be called with an entry filtered from the list. Using event.preventDefault() prevents the application from using the first certificate from the store.
|
|
Emitted when Electron has created a new session.
|
Full Usage:
app.onUpdateActivityState handler
Parameters:
IOnUpdateActivityState -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Handoff is about to be resumed on another device. If you need to update the state to be transferred, you should call event.preventDefault() immediately, construct a new userInfo dictionary and call app.updateCurrentActivity() in a timely manner. Otherwise, the operation will fail and continue-activity-error will be called.
|
Full Usage:
app.onUpdateActivityState handler
Parameters:
Event -> string -> obj -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Handoff is about to be resumed on another device. If you need to update the state to be transferred, you should call event.preventDefault() immediately, construct a new userInfo dictionary and call app.updateCurrentActivity() in a timely manner. Otherwise, the operation will fail and continue-activity-error will be called.
|
Full Usage:
app.onWebContentsCreated handler
Parameters:
IOnWebContentsCreated -> unit
Modifiers: inline |
Emitted when a new webContents is created.
|
Full Usage:
app.onWebContentsCreated handler
Parameters:
Event -> WebContents -> unit
Modifiers: inline |
Emitted when a new webContents is created.
|
Full Usage:
app.onWillContinueActivity handler
Parameters:
IOnWillContinueActivity -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff before an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.
|
Full Usage:
app.onWillContinueActivity handler
Parameters:
Event -> string -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff before an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.
|
Full Usage:
app.onWillFinishLaunching handler
Parameters:
unit -> unit
Modifiers: inline |
Emitted when the application has finished basic startup. On Windows and Linux, the will-finish-launching event is the same as the ready event; on macOS, this event represents the applicationWillFinishLaunching notification of NSApplication.In most cases, you should do everything in the ready event handler.
|
|
Emitted when all windows have been closed and the application will quit. Calling event.preventDefault() will prevent the default behavior, which is terminating the application.See the description of the window-all-closed event for the differences between the will-quit and window-all-closed events.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
Full Usage:
app.onWindowAllClosed handler
Parameters:
unit -> unit
Modifiers: inline |
Emitted when all windows have been closed.If you do not subscribe to this event and all windows are closed, the default behavior is to quit the app; however, if you subscribe, you control whether the app quits or not. If the user pressed Cmd + Q, or the developer called app.quit(), Electron will first try to close all the windows and then emit the will-quit event, and in this case the window-all-closed event would not be emitted.
|
Full Usage:
app.onceAccessibilitySupportChanged handler
Parameters:
IOnAccessibilitySupportChanged -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Chrome's accessibility support changes. This event fires when assistive technologies, such as screen readers, are enabled or disabled. See https://www.chromium.org/developers/design-documents/accessibility for more details.
|
Full Usage:
app.onceAccessibilitySupportChanged handler
Parameters:
Event -> bool -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Chrome's accessibility support changes. This event fires when assistive technologies, such as screen readers, are enabled or disabled. See https://www.chromium.org/developers/design-documents/accessibility for more details.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the application is activated. Various actions can trigger this event, such as launching the application for the first time, attempting to re-launch the application when it's already running, or clicking on the application's dock or taskbar icon.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the application is activated. Various actions can trigger this event, such as launching the application for the first time, attempting to re-launch the application when it's already running, or clicking on the application's dock or taskbar icon.
|
Full Usage:
app.onceActivityWasContinued handler
Parameters:
IOnActivityWasContinued -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff after an activity from this device was successfully resumed on another one.
|
Full Usage:
app.onceActivityWasContinued handler
Parameters:
Event -> string -> obj -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff after an activity from this device was successfully resumed on another one.
|
|
Emitted before the application starts closing its windows. Calling event.preventDefault() will prevent the default behavior, which is terminating the application.> [!NOTE] If application quit was initiated by autoUpdater.quitAndInstall(), then before-quit is emitted after emitting close event on all windows and closing them.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
Full Usage:
app.onceBrowserWindowBlur handler
Parameters:
IOnBrowserWindowBlur -> unit
Modifiers: inline |
Emitted when a browserWindow gets blurred.
|
Full Usage:
app.onceBrowserWindowBlur handler
Parameters:
Event -> BrowserWindow -> unit
Modifiers: inline |
Emitted when a browserWindow gets blurred.
|
Full Usage:
app.onceBrowserWindowCreated handler
Parameters:
IOnBrowserWindowCreated -> unit
Modifiers: inline |
Emitted when a new browserWindow is created.
|
Full Usage:
app.onceBrowserWindowCreated handler
Parameters:
Event -> BrowserWindow -> unit
Modifiers: inline |
Emitted when a new browserWindow is created.
|
Full Usage:
app.onceBrowserWindowFocus handler
Parameters:
IOnBrowserWindowFocus -> unit
Modifiers: inline |
Emitted when a browserWindow gets focused.
|
Full Usage:
app.onceBrowserWindowFocus handler
Parameters:
Event -> BrowserWindow -> unit
Modifiers: inline |
Emitted when a browserWindow gets focused.
|
Full Usage:
app.onceCertificateError handler
Parameters:
IOnCertificateError -> unit
Modifiers: inline |
Emitted when failed to verify the certificate for url, to trust the certificate you should prevent the default behavior with event.preventDefault() and call callback(true).
|
Full Usage:
app.onceCertificateError handler
Parameters:
Event -> WebContents -> string -> string -> Certificate -> bool -> unit -> bool -> unit
Modifiers: inline |
Emitted when failed to verify the certificate for url, to trust the certificate you should prevent the default behavior with event.preventDefault() and call callback(true).
|
Full Usage:
app.onceChildProcessGone handler
Parameters:
IOnChildProcessGone -> unit
Modifiers: inline |
Emitted when the child process unexpectedly disappears. This is normally because it was crashed or killed. It does not include renderer processes.
|
|
|
Full Usage:
app.onceContinueActivity handler
Parameters:
IOnContinueActivity -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.A user activity can be continued only in an app that has the same developer Team ID as the activity's source app and that supports the activity's type. Supported activity types are specified in the app's Info.plist under the NSUserActivityTypes key.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.A user activity can be continued only in an app that has the same developer Team ID as the activity's source app and that supports the activity's type. Supported activity types are specified in the app's Info.plist under the NSUserActivityTypes key. |
Full Usage:
app.onceContinueActivityError handler
Parameters:
IOnContinueActivityError -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device fails to be resumed.
|
Full Usage:
app.onceContinueActivityError handler
Parameters:
Event -> string -> string -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff when an activity from a different device fails to be resumed.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the application becomes active. This differs from the activate event in that did-become-active is emitted every time the app becomes active, not only when Dock icon is clicked or application is re-launched. It is also emitted when a user switches to the app via the macOS App Switcher.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the app is no longer active and doesn’t have focus. This can be triggered, for example, by clicking on another application or by using the macOS App Switcher to switch to another application.
|
Full Usage:
app.onceGpuInfoUpdate handler
Parameters:
unit -> unit
Modifiers: inline |
Emitted whenever there is a GPU info update.
|
|
Emitted when webContents or Utility process wants to do basic auth.The default behavior is to cancel all authentications. To override this you should prevent the default behavior with event.preventDefault() and call callback(username, password) with the credentials.If callback is called without a username or password, the authentication request will be cancelled and the authentication error will be returned to the page.
|
Full Usage:
app.onceLogin handler
Parameters:
Event -> WebContents -> AuthenticationResponseDetails -> AuthInfo -> Option<string> * Option<string> -> unit -> unit
Modifiers: inline |
Emitted when webContents or Utility process wants to do basic auth.The default behavior is to cancel all authentications. To override this you should prevent the default behavior with event.preventDefault() and call callback(username, password) with the credentials.If callback is called without a username or password, the authentication request will be cancelled and the authentication error will be returned to the page.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user clicks the native macOS new tab button. The new tab button is only visible if the current BrowserWindow has a tabbingIdentifier
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a file with the application. The open-file event is usually emitted when the application is already open and the OS wants to reuse the application to open the file. open-file is also emitted when a file is dropped onto the dock and the application is not yet running. Make sure to listen for the open-file event very early in your application startup to handle this case (even before the ready event is emitted).You should call event.preventDefault() if you want to handle this event.On Windows, you have to parse process.argv (in the main process) to get the filepath.
|
Full Usage:
app.onceOpenFile handler
Parameters:
Event -> string -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a file with the application. The open-file event is usually emitted when the application is already open and the OS wants to reuse the application to open the file. open-file is also emitted when a file is dropped onto the dock and the application is not yet running. Make sure to listen for the open-file event very early in your application startup to handle this case (even before the ready event is emitted).You should call event.preventDefault() if you want to handle this event.On Windows, you have to parse process.argv (in the main process) to get the filepath.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a URL with the application. Your application's Info.plist file must define the URL scheme within the CFBundleURLTypes key, and set NSPrincipalClass to AtomApplication.As with the open-file event, be sure to register a listener for the open-url event early in your application startup to detect if the application is being opened to handle a URL. If you register the listener in response to a ready event, you'll miss URLs that trigger the launch of your application.
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when the user wants to open a URL with the application. Your application's Info.plist file must define the URL scheme within the CFBundleURLTypes key, and set NSPrincipalClass to AtomApplication.As with the open-file event, be sure to register a listener for the open-url event early in your application startup to detect if the application is being opened to handle a URL. If you register the listener in response to a ready event, you'll miss URLs that trigger the launch of your application.
|
|
Emitted when the application is quitting.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
|
Emitted when the application is quitting.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
|
Emitted once, when Electron has finished initializing. On macOS, launchInfo holds the userInfo of the NSUserNotification or information from UNNotificationResponse that was used to open the application, if it was launched from Notification Center. You can also call app.isReady() to check if this event has already fired and app.whenReady() to get a Promise that is fulfilled when Electron is initialized.> [!NOTE] The ready event is only fired after the main process has finished running the first tick of the event loop. If an Electron API needs to be called before the ready event, ensure that it is called synchronously in the top-level context of the main process.
|
Full Usage:
app.onceReady handler
Parameters:
Event -> U2<Record<string, obj>, NotificationResponse> -> unit
Modifiers: inline |
Emitted once, when Electron has finished initializing. On macOS, launchInfo holds the userInfo of the NSUserNotification or information from UNNotificationResponse that was used to open the application, if it was launched from Notification Center. You can also call app.isReady() to check if this event has already fired and app.whenReady() to get a Promise that is fulfilled when Electron is initialized.> [!NOTE] The ready event is only fired after the main process has finished running the first tick of the event loop. If an Electron API needs to be called before the ready event, ensure that it is called synchronously in the top-level context of the main process.
|
Full Usage:
app.onceRenderProcessGone handler
Parameters:
IOnRenderProcessGone -> unit
Modifiers: inline |
Emitted when the renderer process unexpectedly disappears. This is normally because it was crashed or killed.
|
Full Usage:
app.onceRenderProcessGone handler
Parameters:
Event -> WebContents -> RenderProcessGoneDetails -> unit
Modifiers: inline |
Emitted when the renderer process unexpectedly disappears. This is normally because it was crashed or killed.
|
Full Usage:
app.onceSecondInstance handler
Parameters:
IOnSecondInstance -> unit
Modifiers: inline |
This event will be emitted inside the primary instance of your application when a second instance has been executed and calls app.requestSingleInstanceLock().argv is an Array of the second instance's command line arguments, and workingDirectory is its current working directory. Usually applications respond to this by making their primary window focused and non-minimized.> [!NOTE] argv will not be exactly the same list of arguments as those passed to the second instance. The order might change and additional arguments might be appended. If you need to maintain the exact same arguments, it's advised to use additionalData instead.> [!NOTE] If the second instance is started by a different user than the first, the argv array will not include the arguments.This event is guaranteed to be emitted after the ready event of app gets emitted.> [!NOTE] Extra command line arguments might be added by Chromium, such as --original-process-start-time.
|
Full Usage:
app.onceSecondInstance handler
Parameters:
Event -> string[] -> string -> obj -> unit
Modifiers: inline |
This event will be emitted inside the primary instance of your application when a second instance has been executed and calls app.requestSingleInstanceLock().argv is an Array of the second instance's command line arguments, and workingDirectory is its current working directory. Usually applications respond to this by making their primary window focused and non-minimized.> [!NOTE] argv will not be exactly the same list of arguments as those passed to the second instance. The order might change and additional arguments might be appended. If you need to maintain the exact same arguments, it's advised to use additionalData instead.> [!NOTE] If the second instance is started by a different user than the first, the argv array will not include the arguments.This event is guaranteed to be emitted after the ready event of app gets emitted.> [!NOTE] Extra command line arguments might be added by Chromium, such as --original-process-start-time.
|
Full Usage:
app.onceSelectClientCertificate handler
Parameters:
IOnSelectClientCertificate -> unit
Modifiers: inline |
Emitted when a client certificate is requested.The url corresponds to the navigation entry requesting the client certificate and callback can be called with an entry filtered from the list. Using event.preventDefault() prevents the application from using the first certificate from the store.
|
Full Usage:
app.onceSelectClientCertificate handler
Parameters:
Event -> WebContents -> URL -> Certificate[] -> Option<Certificate> -> unit -> unit
Modifiers: inline |
Emitted when a client certificate is requested.The url corresponds to the navigation entry requesting the client certificate and callback can be called with an entry filtered from the list. Using event.preventDefault() prevents the application from using the first certificate from the store.
|
|
Emitted when Electron has created a new session.
|
Full Usage:
app.onceUpdateActivityState handler
Parameters:
IOnUpdateActivityState -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Handoff is about to be resumed on another device. If you need to update the state to be transferred, you should call event.preventDefault() immediately, construct a new userInfo dictionary and call app.updateCurrentActivity() in a timely manner. Otherwise, the operation will fail and continue-activity-error will be called.
|
Full Usage:
app.onceUpdateActivityState handler
Parameters:
Event -> string -> obj -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted when Handoff is about to be resumed on another device. If you need to update the state to be transferred, you should call event.preventDefault() immediately, construct a new userInfo dictionary and call app.updateCurrentActivity() in a timely manner. Otherwise, the operation will fail and continue-activity-error will be called.
|
Full Usage:
app.onceWebContentsCreated handler
Parameters:
IOnWebContentsCreated -> unit
Modifiers: inline |
Emitted when a new webContents is created.
|
Full Usage:
app.onceWebContentsCreated handler
Parameters:
Event -> WebContents -> unit
Modifiers: inline |
Emitted when a new webContents is created.
|
Full Usage:
app.onceWillContinueActivity handler
Parameters:
IOnWillContinueActivity -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff before an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.
|
Full Usage:
app.onceWillContinueActivity handler
Parameters:
Event -> string -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Emitted during Handoff before an activity from a different device wants to be resumed. You should call event.preventDefault() if you want to handle this event.
|
Full Usage:
app.onceWillFinishLaunching handler
Parameters:
unit -> unit
Modifiers: inline |
Emitted when the application has finished basic startup. On Windows and Linux, the will-finish-launching event is the same as the ready event; on macOS, this event represents the applicationWillFinishLaunching notification of NSApplication.In most cases, you should do everything in the ready event handler.
|
|
Emitted when all windows have been closed and the application will quit. Calling event.preventDefault() will prevent the default behavior, which is terminating the application.See the description of the window-all-closed event for the differences between the will-quit and window-all-closed events.> [!NOTE] On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout.
|
Full Usage:
app.onceWindowAllClosed handler
Parameters:
unit -> unit
Modifiers: inline |
Emitted when all windows have been closed.If you do not subscribe to this event and all windows are closed, the default behavior is to quit the app; however, if you subscribe, you control whether the app quits or not. If the user pressed Cmd + Q, or the developer called app.quit(), Electron will first try to close all the windows and then emit the will-quit event, and in this case the window-all-closed event would not be emitted.
|
Full Usage:
app.quit ()
Modifiers: inline |
Try to close all windows. The before-quit event will be emitted first. If all windows are successfully closed, the will-quit event will be emitted and by default the application will terminate.This method guarantees that all beforeunload and unload event handlers are correctly executed. It is possible that a window cancels the quitting by returning false in the beforeunload event handler. |
Full Usage:
app.relaunch (?args, ?execPath)
Parameters:
string[]
?execPath : string
Modifiers: inline |
Relaunches the app when the current instance exits.By default, the new instance will use the same working directory and command line arguments as the current instance. When args is specified, the args will be passed as the command line arguments instead. When execPath is specified, the execPath will be executed for the relaunch instead of the current app.Note that this method does not quit the app when executed. You have to call app.quit or app.exit after calling app.relaunch to make the app restart.When app.relaunch is called multiple times, multiple instances will be started after the current instance exits.An example of restarting the current instance immediately and adding a new command line argument to the new instance:
|
Full Usage:
app.releaseSingleInstanceLock ()
Modifiers: inline |
Releases all locks that were created by requestSingleInstanceLock. This will allow multiple instances of the application to once again run side by side. |
Full Usage:
app.removeAsDefaultProtocolClient (protocol, ?path, ?args)
Parameters:
string
?path : string
?args : string[]
Returns: bool
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Whether the call succeeded.This method checks if the current executable as the default handler for a protocol (aka URI scheme). If so, it will remove the app as the default handler.
|
Full Usage:
app.requestSingleInstanceLock ?additionalData
Parameters:
Record<obj, obj>
Returns: bool
Modifiers: inline |
The return value of this method indicates whether or not this instance of your application successfully obtained the lock. If it failed to obtain the lock, you can assume that another instance of your application is already running with the lock and exit immediately.I.e. This method returns true if your process is the primary instance of your application and your app should continue loading. It returns false if your process should immediately quit as it has sent its parameters to another instance that has already acquired the lock.On macOS, the system enforces single instance automatically when users try to open a second instance of your app in Finder, and the open-file and open-url events will be emitted for that. However when users start your app in command line, the system's single instance mechanism will be bypassed, and you have to use this method to ensure single instance.An example of activating the window of primary instance when a second instance starts:
|
Full Usage:
app.resignCurrentActivity ()
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Marks the current Handoff user activity as inactive without invalidating it. |
|
|
Full Usage:
app.runningUnderARM64Translation
Returns: bool
|
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ A boolean which when true indicates that the app is currently running under an ARM64 translator (like the macOS Rosetta Translator Environment or Windows WOW).You can use this property to prompt users to download the arm64 version of your application when they are mistakenly running the x64 version under Rosetta or WOW.
|
Full Usage:
app.setAboutPanelOptions (?applicationName, ?applicationVersion, ?copyright, ?version, ?credits, ?authors, ?website, ?iconPath)
Parameters:
string
?applicationVersion : string
?copyright : string
?version : string
?credits : string
?authors : string[]
?website : string
?iconPath : string
Modifiers: inline |
Set the about panel options. This will override the values defined in the app's .plist file on macOS. See the Apple docs for more details. On Linux, values must be set in order to be shown; there are no defaults.If you do not set credits but still wish to surface them in your app, AppKit will look for a file named "Credits.html", "Credits.rtf", and "Credits.rtfd", in that order, in the bundle returned by the NSBundle class method main. The first file found is used, and if none is found, the info area is left blank. See Apple documentation for more information.
|
Full Usage:
app.setAccessibilitySupportEnabled enabled
Parameters:
bool
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Manually enables Chrome's accessibility support, allowing to expose accessibility switch to users in application settings. See Chromium's accessibility docs for more details. Disabled by default.This API must be called after the ready event is emitted.> [!NOTE] Rendering accessibility tree can significantly affect the performance of your app. It should not be enabled by default. Calling this method will enable the following accessibility support features: nativeAPIs, webContents, inlineTextBoxes, and extendedProperties.
|
Full Usage:
app.setAccessibilitySupportFeatures features
Parameters:
string[]
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Possible values are:* nativeAPIs - Native OS accessibility APIs integration enabled.* webContents - Web contents accessibility tree exposure enabled.* inlineTextBoxes - Inline text boxes (character bounding boxes) enabled.* extendedProperties - Extended accessibility properties enabled.* screenReader - Screen reader specific mode enabled.* html - HTML accessibility tree construction enabled.* labelImages - Accessibility support for automatic image annotations.* pdfPrinting - Accessibility support for PDF printing enabled.To disable all supported features, pass an empty array [].Example:
|
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Sets the activation policy for a given app.Activation policy types:* 'regular' - The application is an ordinary app that appears in the Dock and may have a user interface.* 'accessory' - The application doesn’t appear in the Dock and doesn’t have a menu bar, but it may be activated programmatically or by clicking on one of its windows.* 'prohibited' - The application doesn’t appear in the Dock and may not create windows or be activated.
|
Full Usage:
app.setAppLogsPath ?path
Parameters:
string
Modifiers: inline |
Sets or creates a directory your app's logs which can then be manipulated with app.getPath() or app.setPath(pathName, newPath).Calling app.setAppLogsPath() without a path parameter will result in this directory being set to ~/Library/Logs/YourAppName on macOS, and inside the userData directory on Linux and Windows.
|
Full Usage:
app.setAppUserModelId id
Parameters:
string
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ Changes the Application User Model ID to id.
|
Full Usage:
app.setAsDefaultProtocolClient (protocol, ?path, ?args)
Parameters:
string
?path : string
?args : string[]
Returns: bool
Modifiers: inline |
Whether the call succeeded.Sets the current executable as the default handler for a protocol (aka URI scheme). It allows you to integrate your app deeper into the operating system. Once registered, all links with your-protocol:// will be opened with the current executable. The whole link, including protocol, will be passed to your application as a parameter.> [!NOTE] On macOS, you can only register protocols that have been added to your app's info.plist, which cannot be modified at runtime. However, you can change the file during build time via Electron Forge, Electron Packager, or by editing info.plist with a text editor. Please refer to Apple's documentation for details.> [!NOTE] In a Windows Store environment (when packaged as an appx) this API will return true for all calls but the registry key it sets won't be accessible by other applications. In order to register your Windows Store application as a default protocol handler you must declare the protocol in your manifest.The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally.
|
Full Usage:
app.setBadgeCount ?count
Parameters:
int
Returns: bool
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ✔ | MAS ❌ Whether the call succeeded.Sets the counter badge for current app. Setting the count to 0 will hide the badge.On macOS, it shows on the dock icon. On Linux, it only works for Unity launcher.> [!NOTE] Unity launcher requires a .desktop file to work. For more information, please read the Unity integration documentation.> [!NOTE] On macOS, you need to ensure that your application has the permission to display notifications for this method to work.
|
Full Usage:
app.setClientCertRequestPasswordHandler handler
Parameters:
ClientCertRequestParams -> Promise<string>
Modifiers: inline |
The handler is called when a password is needed to unlock a client certificate for hostname.
|
Full Usage:
app.setJumpList categories
Parameters:
Option<JumpListCategory[]>
Returns: SetJumpList
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ Sets or removes a custom Jump List for the application, and returns one of the following strings:* ok - Nothing went wrong.* error - One or more errors occurred, enable runtime logging to figure out the likely cause.* invalidSeparatorError - An attempt was made to add a separator to a custom category in the Jump List. Separators are only allowed in the standard Tasks category.* fileTypeRegistrationError - An attempt was made to add a file link to the Jump List for a file type the app isn't registered to handle.* customCategoryAccessDeniedError - Custom categories can't be added to the Jump List due to user privacy or group policy settings.If categories is null the previously set custom Jump List (if any) will be replaced by the standard Jump List for the app (managed by Windows).> [!NOTE] If a JumpListCategory object has neither the type nor the name property set then its type is assumed to be tasks. If the name property is set but the type property is omitted then the type is assumed to be custom.> [!NOTE] Users can remove items from custom categories, and Windows will not allow a removed item to be added back into a custom category until after the next successful call to app.setJumpList(categories). Any attempt to re-add a removed item to a custom category earlier than that will result in the entire custom category being omitted from the Jump List. The list of removed items can be obtained using app.getJumpListSettings().> [!NOTE] The maximum length of a Jump List item's description property is 260 characters. Beyond this limit, the item will not be added to the Jump List, nor will it be displayed.Here's a very simple example of creating a custom Jump List:
|
Full Usage:
app.setLoginItemSettings (?openAtLogin, ?openAsHidden, ?type, ?serviceName, ?path, ?args, ?enabled, ?name)
Parameters:
bool
?openAsHidden : bool
?type : Type
?serviceName : string
?path : string
?args : string[]
?enabled : bool
?name : string
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Set the app's login item settings.To work with Electron's autoUpdater on Windows, which uses Squirrel, you'll want to set the launch path to your executable's name but a directory up, which is a stub application automatically generated by Squirrel which will automatically launch the latest version.For more information about setting different services as login items on macOS 13 and up, see SMAppService.
|
Full Usage:
app.setName name
Parameters:
string
Modifiers: inline |
Overrides the current application's name.> [!NOTE] This function overrides the name used internally by Electron; it does not affect the name that the OS uses.
|
Full Usage:
app.setPath (name, path)
Parameters:
string
path : string
Modifiers: inline |
Overrides the path to a special directory or file associated with name. If the path specifies a directory that does not exist, an Error is thrown. In that case, the directory should be created with fs.mkdirSync or similar.You can only override paths of a name defined in app.getPath.By default, web pages' cookies and caches will be stored under the sessionData directory. If you want to change this location, you have to override the sessionData path before the ready event of the app module is emitted.
|
Full Usage:
app.setProxy config
Parameters:
ProxyConfig
Returns: Promise<unit>
Modifiers: inline |
Resolves when the proxy setting process is complete.Sets the proxy settings for networks requests made without an associated Session. Currently this will affect requests made with Net in the utility process and internal requests made by the runtime (ex: geolocation queries).This method can only be called after app is ready.
|
Full Usage:
app.setSecureKeyboardEntryEnabled enabled
Parameters:
bool
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Set the Secure Keyboard Entry is enabled in your application.By using this API, important information such as password and other sensitive information can be prevented from being intercepted by other processes.See Apple's documentation for more details.> [!NOTE] Enable Secure Keyboard Entry only when it is needed and disable it when it is no longer needed.
|
Full Usage:
app.setUserActivity (type, userInfo, ?webpageURL)
Parameters:
string
userInfo : obj
?webpageURL : string
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Creates an NSUserActivity and sets it as the current activity. The activity is eligible for Handoff to another device afterward.
|
|
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ Adds tasks to the Tasks category of the Jump List on Windows.tasks is an array of Task objects.Whether the call succeeded.> [!NOTE] If you'd like to customize the Jump List even more use app.setJumpList(categories) instead.
|
Full Usage:
app.show ()
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Shows application windows after they were hidden. Does not automatically focus them. |
Full Usage:
app.showAboutPanel ()
Modifiers: inline |
Show the app's about panel options. These options can be overridden with app.setAboutPanelOptions(options). This function runs asynchronously. |
Full Usage:
app.showEmojiPanel ()
Modifiers: inline |
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Show the platform's native emoji picker. |
Full Usage:
app.startAccessingSecurityScopedResource bookmarkData
Parameters:
string
Returns: unit -> unit
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ❌ | LIN ❌ | MAS ✔ This function must be called once you have finished accessing the security scoped file. If you do not remember to stop accessing the bookmark, kernel resources will be leaked and your app will lose its ability to reach outside the sandbox completely, until your app is restarted.Start accessing a security scoped resource. With this method Electron applications that are packaged for the Mac App Store may reach outside their sandbox to access files chosen by the user. See Apple's documentation for a description of how this system works.
|
Full Usage:
app.updateCurrentActivity (type, userInfo)
Parameters:
string
userInfo : obj
Modifiers: inline |
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Updates the current activity if its type matches type, merging the entries from userInfo into its current userInfo dictionary.
|
Full Usage:
app.userAgentFallback
|
A string which is the user agent string Electron will use as a global fallback.This is the user agent that will be used when no user agent is set at the webContents or session level. It is useful for ensuring that your entire app has the same user agent. Set to a custom value as early as possible in your app's initialization to ensure that your overridden value is used. |
|
fulfilled when Electron is initialized. May be used as a convenient alternative to checking app.isReady() and subscribing to the ready event if the app is not ready yet.
|