2013-09-09 07:35:57 +00:00
# app
2013-08-14 22:43:35 +00:00
2016-04-21 22:39:12 +00:00
> Control your application's event lifecycle.
2013-08-14 22:43:35 +00:00
2016-11-01 23:35:31 +00:00
Process: [Main ](../tutorial/quick-start.md#main-process )
2015-08-24 12:38:29 +00:00
The following example shows how to quit the application when the last window is
closed:
2013-08-14 22:43:35 +00:00
```javascript
2016-07-26 01:39:25 +00:00
const {app} = require('electron')
2016-05-04 17:59:02 +00:00
app.on('window-all-closed', () => {
2016-07-26 01:39:25 +00:00
app.quit()
})
2013-08-14 22:43:35 +00:00
```
2015-08-19 16:28:48 +00:00
## Events
2015-08-19 16:51:36 +00:00
The `app` object emits the following events:
2015-08-19 16:28:48 +00:00
### Event: 'will-finish-launching'
2013-08-14 22:43:35 +00:00
2015-07-18 14:40:01 +00:00
Emitted when the application has finished basic startup. On Windows and Linux,
2016-06-18 13:26:26 +00:00
the `will-finish-launching` event is the same as the `ready` event; on macOS,
2015-08-24 12:38:29 +00:00
this event represents the `applicationWillFinishLaunching` notification of
`NSApplication` . You would usually set up listeners for the `open-file` and
`open-url` events here, and start the crash reporter and auto updater.
2013-08-14 22:43:35 +00:00
2015-07-18 14:40:01 +00:00
In most cases, you should just do everything in the `ready` event handler.
2013-08-14 22:43:35 +00:00
2015-08-19 16:28:48 +00:00
### Event: 'ready'
2013-12-27 03:08:26 +00:00
2016-09-03 19:03:58 +00:00
Returns:
* `launchInfo` Object _macOS_
2016-09-13 16:37:03 +00:00
Emitted when Electron has finished initializing. On macOS, `launchInfo` holds
2016-09-03 19:03:58 +00:00
the `userInfo` of the `NSUserNotification` that was used to open the application,
2016-09-13 16:35:39 +00:00
if it was launched from Notification Center. You can call `app.isReady()` to
check if this event has already fired.
2013-08-14 22:43:35 +00:00
2015-08-19 16:28:48 +00:00
### Event: 'window-all-closed'
2013-08-14 22:43:35 +00:00
Emitted when all windows have been closed.
2016-05-19 09:32:43 +00:00
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.
2013-08-14 22:43:35 +00:00
2015-08-19 16:28:48 +00:00
### Event: 'before-quit'
2015-02-26 03:33:42 +00:00
2015-08-19 16:51:36 +00:00
Returns:
2015-02-26 03:33:42 +00:00
* `event` Event
Emitted before the application starts closing its windows.
Calling `event.preventDefault()` will prevent the default behaviour, which is
terminating the application.
2015-08-19 16:28:48 +00:00
### Event: 'will-quit'
2013-08-14 22:43:35 +00:00
2015-08-19 16:51:36 +00:00
Returns:
2013-08-14 22:43:35 +00:00
* `event` Event
2013-08-29 14:37:51 +00:00
Emitted when all windows have been closed and the application will quit.
Calling `event.preventDefault()` will prevent the default behaviour, which is
terminating the application.
2013-08-14 22:43:35 +00:00
2015-08-24 12:38:29 +00:00
See the description of the `window-all-closed` event for the differences between
the `will-quit` and `window-all-closed` events.
2013-08-14 22:43:35 +00:00
2015-08-19 16:28:48 +00:00
### Event: 'quit'
2014-09-25 13:47:54 +00:00
2015-12-10 02:22:54 +00:00
Returns:
* `event` Event
* `exitCode` Integer
2015-07-18 14:40:01 +00:00
Emitted when the application is quitting.
2014-09-25 13:47:54 +00:00
2016-06-18 13:26:26 +00:00
### Event: 'open-file' _macOS_
2013-08-14 22:43:35 +00:00
2015-08-19 16:51:36 +00:00
Returns:
2013-08-14 22:43:35 +00:00
* `event` Event
* `path` String
2015-08-24 12:38:29 +00:00
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).
2013-08-14 22:43:35 +00:00
You should call `event.preventDefault()` if you want to handle this event.
2016-05-19 09:32:43 +00:00
On Windows, you have to parse `process.argv` (in the main process) to get the
filepath.
2015-11-26 08:05:02 +00:00
2016-06-18 13:26:26 +00:00
### Event: 'open-url' _macOS_
2013-08-14 22:43:35 +00:00
2015-08-19 16:51:36 +00:00
Returns:
2013-08-14 22:43:35 +00:00
* `event` Event
* `url` String
2015-07-18 14:40:01 +00:00
Emitted when the user wants to open a URL with the application. The URL scheme
2013-08-29 14:37:51 +00:00
must be registered to be opened by your application.
2013-08-14 22:43:35 +00:00
You should call `event.preventDefault()` if you want to handle this event.
2016-06-18 13:26:26 +00:00
### Event: 'activate' _macOS_
2015-09-14 11:28:13 +00:00
2015-09-15 01:34:27 +00:00
Returns:
* `event` Event
2015-10-20 05:56:31 +00:00
* `hasVisibleWindows` Boolean
2015-09-15 01:34:27 +00:00
2016-05-19 09:32:43 +00:00
Emitted when the application is activated, which usually happens when the user
clicks on the application's dock icon.
2016-04-30 05:25:09 +00:00
2016-06-18 13:26:26 +00:00
### Event: 'continue-activity' _macOS_
2016-04-30 05:25:09 +00:00
Returns:
* `event` Event
2016-05-05 08:07:46 +00:00
* `type` String - A string identifying the activity. Maps to
[`NSUserActivity.activityType`][activity-type].
2016-05-03 17:34:59 +00:00
* `userInfo` Object - Contains app-specific state stored by the activity on
2016-05-05 08:07:46 +00:00
another device.
2016-04-30 05:25:09 +00:00
2016-05-05 08:07:46 +00:00
Emitted during [Handoff][handoff] when an activity from a different device wants
2016-05-05 03:26:23 +00:00
to be resumed. You should call `event.preventDefault()` if you want to handle
this event.
2015-09-14 11:28:13 +00:00
2016-05-05 03:26:23 +00:00
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
2016-04-30 20:03:10 +00:00
`NSUserActivityTypes` key.
2015-08-19 16:28:48 +00:00
### Event: 'browser-window-blur'
2015-06-18 05:59:08 +00:00
2015-08-19 16:51:36 +00:00
Returns:
2015-06-18 05:59:08 +00:00
* `event` Event
* `window` BrowserWindow
Emitted when a [browserWindow ](browser-window.md ) gets blurred.
2015-08-19 16:28:48 +00:00
### Event: 'browser-window-focus'
2015-06-18 05:59:08 +00:00
2015-08-19 16:51:36 +00:00
Returns:
2015-06-18 05:59:08 +00:00
* `event` Event
* `window` BrowserWindow
Emitted when a [browserWindow ](browser-window.md ) gets focused.
2015-09-14 09:02:36 +00:00
### Event: 'browser-window-created'
Returns:
* `event` Event
* `window` BrowserWindow
Emitted when a new [browserWindow ](browser-window.md ) is created.
2016-06-13 16:01:06 +00:00
### Event: 'web-contents-created'
Returns:
* `event` Event
* `webContents` WebContents
Emitted when a new [webContents ](web-contents.md ) is created.
2015-11-18 03:35:26 +00:00
### Event: 'certificate-error'
Returns:
* `event` Event
* `webContents` [WebContents ](web-contents.md )
* `url` URL
* `error` String - The error code
2016-10-13 03:38:06 +00:00
* `certificate` [Certificate ](structures/certificate.md )
2015-11-18 03:35:26 +00:00
* `callback` Function
2016-10-13 06:30:57 +00:00
* `isTrusted` Boolean - Whether to consider the certificate as trusted
2015-11-18 03:35:26 +00:00
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)` .
```javascript
2016-07-26 01:39:25 +00:00
const {app} = require('electron')
2016-05-10 17:15:09 +00:00
app.on('certificate-error', (event, webContents, url, error, certificate, callback) => {
2016-05-10 09:42:11 +00:00
if (url === 'https://github.com') {
2015-11-18 03:35:26 +00:00
// Verification logic.
2016-07-26 01:39:25 +00:00
event.preventDefault()
callback(true)
2015-11-18 03:35:26 +00:00
} else {
2016-07-26 01:39:25 +00:00
callback(false)
2015-11-18 03:35:26 +00:00
}
2016-07-26 01:39:25 +00:00
})
2015-11-18 03:35:26 +00:00
```
2015-11-18 02:10:21 +00:00
### Event: 'select-client-certificate'
2015-06-11 15:22:07 +00:00
2015-08-19 16:51:36 +00:00
Returns:
2015-06-11 15:22:07 +00:00
* `event` Event
2015-10-28 13:14:00 +00:00
* `webContents` [WebContents ](web-contents.md )
* `url` URL
2016-10-04 22:35:23 +00:00
* `certificateList` [Certificate[]](structures/certificate.md)
2015-06-11 15:22:07 +00:00
* `callback` Function
2016-10-13 06:30:57 +00:00
* `certificate` [Certificate ](structures/certificate.md )
2015-06-11 15:22:07 +00:00
2015-10-28 13:14:00 +00:00
Emitted when a client certificate is requested.
The `url` corresponds to the navigation entry requesting the client certificate
and `callback` needs to be called with an entry filtered from the list. Using
`event.preventDefault()` prevents the application from using the first
certificate from the store.
2015-08-19 16:28:48 +00:00
```javascript
2016-07-26 01:39:25 +00:00
const {app} = require('electron')
2016-05-10 17:15:09 +00:00
app.on('select-client-certificate', (event, webContents, url, list, callback) => {
2016-07-26 01:39:25 +00:00
event.preventDefault()
callback(list[0])
})
2015-06-11 15:22:07 +00:00
```
2015-10-28 13:14:00 +00:00
### Event: 'login'
Returns:
* `event` Event
* `webContents` [WebContents ](web-contents.md )
* `request` Object
* `method` String
* `url` URL
* `referrer` URL
* `authInfo` Object
* `isProxy` Boolean
* `scheme` String
* `host` String
* `port` Integer
* `realm` String
* `callback` Function
2016-10-13 06:30:57 +00:00
* `username` String
* `password` String
2015-10-28 13:14:00 +00:00
Emitted when `webContents` wants to do basic auth.
The default behavior is to cancel all authentications, to override this you
2015-10-29 05:22:00 +00:00
should prevent the default behavior with `event.preventDefault()` and call
2015-10-28 13:14:00 +00:00
`callback(username, password)` with the credentials.
```javascript
2016-07-26 01:39:25 +00:00
const {app} = require('electron')
2016-05-04 17:59:02 +00:00
app.on('login', (event, webContents, request, authInfo, callback) => {
2016-07-26 01:39:25 +00:00
event.preventDefault()
callback('username', 'secret')
})
2015-10-28 13:14:00 +00:00
```
2015-06-11 15:22:07 +00:00
2015-06-25 14:01:57 +00:00
### Event: 'gpu-process-crashed'
2015-06-25 13:53:22 +00:00
2016-09-18 00:00:45 +00:00
Returns:
* `event` Event
* `killed` Boolean
Emitted when the gpu process crashes or is killed.
2015-06-25 13:53:22 +00:00
2016-07-11 21:41:35 +00:00
### Event: 'accessibility-support-changed' _macOS_ _Windows_
Returns:
* `event` Event
* `accessibilitySupportEnabled` Boolean - `true` when Chrome's accessibility
support is enabled, `false` otherwise.
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.
2015-08-19 16:28:48 +00:00
## Methods
2015-08-19 16:51:36 +00:00
The `app` object has the following methods:
2015-08-19 16:28:48 +00:00
2016-05-19 09:32:43 +00:00
**Note:** Some methods are only available on specific operating systems and are
labeled as such.
2015-08-25 17:12:21 +00:00
2015-08-19 16:28:48 +00:00
### `app.quit()`
2013-08-14 22:43:35 +00:00
2015-10-20 16:44:01 +00:00
Try to close all windows. The `before-quit` event will be emitted first. If all
2015-02-26 03:33:42 +00:00
windows are successfully closed, the `will-quit` event will be emitted and by
2015-07-18 14:40:01 +00:00
default the application will terminate.
2013-08-14 22:43:35 +00:00
2015-08-24 12:38:29 +00:00
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.
2013-08-14 22:43:35 +00:00
2016-08-30 03:30:56 +00:00
### `app.exit([exitCode])`
2015-11-06 10:27:13 +00:00
2016-08-30 03:30:56 +00:00
* `exitCode` Integer (optional)
2015-11-06 10:27:13 +00:00
2016-08-30 03:30:56 +00:00
Exits immediately with `exitCode` . `exitCode` defaults to 0.
2015-11-06 10:27:13 +00:00
All windows will be closed immediately without asking user and the `before-quit`
and `will-quit` events will not be emitted.
2016-06-02 13:06:27 +00:00
### `app.relaunch([options])`
* `options` Object (optional)
2016-09-28 05:28:44 +00:00
* `args` String[] (optional)
2016-06-02 13:06:27 +00:00
* `execPath` String (optional)
Relaunches the app when current instance exits.
By default the new instance will use the same working directory and command line
arguments with current instance. When `args` is specified, the `args` will be
passed as command line arguments instead. When `execPath` is specified, the
`execPath` will be executed for relaunch instead of 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 for multiple times, multiple instances will be
started after current instance exited.
An example of restarting current instance immediately and adding a new command
line argument to the new instance:
```javascript
2016-07-26 01:39:25 +00:00
const {app} = require('electron')
2016-09-28 17:23:03 +00:00
app.relaunch({args: process.argv.slice(1).concat(['--relaunch'])})
2016-06-02 13:06:27 +00:00
app.exit(0)
```
2016-09-13 16:35:39 +00:00
### `app.isReady()`
2016-09-24 23:59:30 +00:00
Returns `Boolean` - `true` if Electron has finished initializing, `false` otherwise.
2016-09-13 16:35:39 +00:00
2016-03-09 03:31:13 +00:00
### `app.focus()`
2016-06-18 13:26:26 +00:00
On Linux, focuses on the first visible window. On macOS, makes the application
2016-03-10 07:54:07 +00:00
the active app. On Windows, focuses on the application's first window.
2016-03-09 03:31:13 +00:00
2016-06-18 13:26:26 +00:00
### `app.hide()` _macOS_
2016-03-09 03:31:13 +00:00
Hides all application windows without minimizing them.
2016-06-18 13:26:26 +00:00
### `app.show()` _macOS_
2016-03-09 03:31:13 +00:00
2016-05-19 09:32:43 +00:00
Shows application windows after they were hidden. Does not automatically focus
them.
2016-03-09 03:31:13 +00:00
2015-08-19 16:28:48 +00:00
### `app.getAppPath()`
2015-07-06 09:35:35 +00:00
2016-09-24 23:59:30 +00:00
Returns `String` - The current application directory.
2015-07-06 09:35:35 +00:00
2015-08-19 16:28:48 +00:00
### `app.getPath(name)`
2014-08-15 15:29:36 +00:00
2015-01-19 02:25:31 +00:00
* `name` String
2014-08-15 15:29:36 +00:00
2016-09-24 23:59:30 +00:00
Returns `String` - A path to a special directory or file associated with `name` . On
2015-07-18 14:40:01 +00:00
failure an `Error` is thrown.
2015-01-19 02:25:31 +00:00
2015-07-18 14:40:01 +00:00
You can request the following paths by the name:
2015-01-19 02:25:31 +00:00
2015-08-19 16:28:48 +00:00
* `home` User's home directory.
* `appData` Per-user application data directory, which by default points to:
2015-01-19 02:25:31 +00:00
* `%APPDATA%` on Windows
2015-01-19 05:10:42 +00:00
* `$XDG_CONFIG_HOME` or `~/.config` on Linux
2016-06-18 13:26:26 +00:00
* `~/Library/Application Support` on macOS
2015-08-19 16:28:48 +00:00
* `userData` The directory for storing your app's configuration files, which by
default it is the `appData` directory appended with your app's name.
* `temp` Temporary directory.
* `exe` The current executable file.
* `module` The `libchromiumcontent` library.
2015-11-13 05:05:16 +00:00
* `desktop` The current user's Desktop directory.
* `documents` Directory for a user's "My Documents".
* `downloads` Directory for a user's downloads.
* `music` Directory for a user's music.
* `pictures` Directory for a user's pictures.
* `videos` Directory for a user's videos.
2016-06-08 20:37:27 +00:00
* `pepperFlashSystemPlugin` Full path to the system version of the Pepper Flash plugin.
2015-01-19 02:25:31 +00:00
2015-08-19 16:28:48 +00:00
### `app.setPath(name, path)`
2015-01-19 02:25:31 +00:00
* `name` String
* `path` String
2015-07-18 14:40:01 +00:00
Overrides the `path` to a special directory or file associated with `name` . If
2015-01-19 02:25:31 +00:00
the path specifies a directory that does not exist, the directory will be
2015-07-18 14:40:01 +00:00
created by this method. On failure an `Error` is thrown.
2015-01-19 02:25:31 +00:00
2015-08-19 16:28:48 +00:00
You can only override paths of a `name` defined in `app.getPath` .
2014-08-15 15:29:36 +00:00
2015-10-20 16:44:01 +00:00
By default, web pages' cookies and caches will be stored under the `userData`
2015-07-18 14:40:01 +00:00
directory. If you want to change this location, you have to override the
`userData` path before the `ready` event of the `app` module is emitted.
2015-01-19 04:39:38 +00:00
2015-08-19 16:28:48 +00:00
### `app.getVersion()`
2013-08-14 22:43:35 +00:00
2016-09-24 23:59:30 +00:00
Returns `String` - The version of the loaded application. If no version is found in the
2015-08-24 12:38:29 +00:00
application's `package.json` file, the version of the current bundle or
executable is returned.
2013-12-05 03:02:09 +00:00
2015-08-19 16:28:48 +00:00
### `app.getName()`
2013-12-05 03:02:09 +00:00
2016-09-24 23:59:30 +00:00
Returns `String` - The current application's name, which is the name in the application's
2015-07-18 14:40:01 +00:00
`package.json` file.
2013-12-05 03:02:09 +00:00
2013-12-05 03:46:36 +00:00
Usually the `name` field of `package.json` is a short lowercased name, according
2015-07-18 14:40:01 +00:00
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
2015-04-16 03:31:12 +00:00
preferred over `name` by Electron.
2013-08-14 22:43:35 +00:00
2016-03-19 15:20:32 +00:00
### `app.setName(name)`
* `name` String
Overrides the current application's name.
2015-09-16 08:17:49 +00:00
### `app.getLocale()`
2016-09-24 23:59:30 +00:00
Returns `String` - The current application locale. Possible return values are documented
2016-07-11 18:37:22 +00:00
[here ](locales.md ).
2015-09-16 08:17:49 +00:00
2016-03-31 08:22:09 +00:00
**Note:** When distributing your packaged app, you have to also ship the
`locales` folder.
**Note:** On Windows you have to call it after the `ready` events gets emitted.
2016-06-18 13:26:26 +00:00
### `app.addRecentDocument(path)` _macOS_ _Windows_
2014-11-17 11:02:37 +00:00
* `path` String
2015-07-18 14:40:01 +00:00
Adds `path` to the recent documents list.
2014-11-17 11:02:37 +00:00
2015-07-18 14:40:01 +00:00
This list is managed by the OS. On Windows you can visit the list from the task
2016-06-18 13:26:26 +00:00
bar, and on macOS you can visit it from dock menu.
2014-11-17 11:02:37 +00:00
2016-06-18 13:26:26 +00:00
### `app.clearRecentDocuments()` _macOS_ _Windows_
2014-11-17 11:02:37 +00:00
Clears the recent documents list.
2016-08-16 05:38:32 +00:00
### `app.setAsDefaultProtocolClient(protocol[, path, args])` _macOS_ _Windows_
2016-03-21 18:24:25 +00:00
2016-03-31 05:16:14 +00:00
* `protocol` String - The name of your protocol, without `://` . If you want your
app to handle `electron://` links, call this method with `electron` as the
parameter.
2016-08-16 05:39:36 +00:00
* `path` String (optional) _Windows_ - Defaults to `process.execPath`
2016-09-28 05:28:44 +00:00
* `args` String[] (optional) _Windows_ - Defaults to an empty array
Returns `Boolean` - Whether the call succeeded.
2016-03-31 05:16:14 +00:00
2016-03-21 18:24:25 +00:00
This method 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
2016-06-16 22:19:38 +00:00
system. Once registered, all links with `your-protocol://` will be opened with
2016-03-21 18:24:25 +00:00
the current executable. The whole link, including protocol, will be passed to
your application as a parameter.
2016-03-31 05:16:14 +00:00
2016-08-18 08:02:13 +00:00
On Windows you can provide optional parameters path, the path to your executable,
2016-08-16 05:38:32 +00:00
and args, an array of arguments to be passed to your executable when it launches.
2016-06-18 13:26:26 +00:00
**Note:** On macOS, you can only register protocols that have been added to
2016-03-21 18:24:25 +00:00
your app's `info.plist` , which can not be modified at runtime. You can however
change the file with a simple text editor or script during build time.
Please refer to [Apple's documentation][CFBundleURLTypes] for details.
The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally.
2016-08-18 08:02:13 +00:00
### `app.removeAsDefaultProtocolClient(protocol[, path, args])` _macOS_ _Windows_
2016-03-24 17:55:09 +00:00
2016-03-31 05:16:14 +00:00
* `protocol` String - The name of your protocol, without `://` .
2016-08-18 08:02:13 +00:00
* `path` String (optional) _Windows_ - Defaults to `process.execPath`
2016-09-28 05:28:44 +00:00
* `args` String[] (optional) _Windows_ - Defaults to an empty array
Returns `Boolean` - Whether the call succeeded.
2016-03-31 05:16:14 +00:00
2016-05-19 09:32:43 +00:00
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.
2016-03-31 05:16:14 +00:00
2016-08-08 00:26:27 +00:00
2016-08-18 08:02:13 +00:00
### `app.isDefaultProtocolClient(protocol[, path, args])` _macOS_ _Windows_
2016-04-25 05:17:01 +00:00
2016-04-30 05:25:09 +00:00
* `protocol` String - The name of your protocol, without `://` .
2016-08-18 08:02:13 +00:00
* `path` String (optional) _Windows_ - Defaults to `process.execPath`
2016-09-28 05:28:44 +00:00
* `args` String[] (optional) _Windows_ - Defaults to an empty array
2016-04-25 05:17:01 +00:00
2016-09-24 23:59:30 +00:00
Returns `Boolean`
2016-04-25 05:17:01 +00:00
This method checks if the current executable is the default handler for a protocol
2016-04-30 05:25:09 +00:00
(aka URI scheme). If so, it will return true. Otherwise, it will return false.
2016-04-25 05:17:01 +00:00
2016-06-18 13:26:26 +00:00
**Note:** On macOS, you can use this method to check if the app has been
2016-05-19 09:32:43 +00:00
registered as the default protocol handler for a protocol. You can also verify
this by checking `~/Library/Preferences/com.apple.LaunchServices.plist` on the
2016-06-18 13:26:26 +00:00
macOS machine. Please refer to
2016-05-19 09:32:43 +00:00
[Apple's documentation][LSCopyDefaultHandlerForURLScheme] for details.
2016-04-25 05:17:01 +00:00
The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme internally.
2015-08-24 22:33:07 +00:00
### `app.setUserTasks(tasks)` _Windows_
2014-11-17 11:50:34 +00:00
2016-10-04 22:35:23 +00:00
* `tasks` [Task[]](structures/task.md) - Array of `Task` objects
2014-11-17 11:50:34 +00:00
2015-07-18 14:40:01 +00:00
Adds `tasks` to the [Tasks][tasks] category of the JumpList on Windows.
2014-11-17 11:50:34 +00:00
2016-10-30 10:46:20 +00:00
`tasks` is an array of [`Task` ](structures/task.md ) objects.
2014-11-17 11:50:34 +00:00
2016-09-28 05:28:44 +00:00
Returns `Boolean` - Whether the call succeeded.
2016-08-07 22:22:32 +00:00
2016-08-12 09:31:17 +00:00
**Note:** If you'd like to customize the Jump List even more use
`app.setJumpList(categories)` instead.
### `app.getJumpListSettings()` _Windows_
2016-09-24 23:59:30 +00:00
Returns `Object` :
2016-10-25 03:35:18 +00:00
2016-08-12 09:31:17 +00:00
* `minItems` Integer - The minimum number of items that will be shown in the
Jump List (for a more detailed description of this value see the
[MSDN docs][JumpListBeginListMSDN]).
2016-10-04 22:35:23 +00:00
* `removedItems` [JumpListItem[]](structures/jump-list-item.md) - Array of `JumpListItem` objects that correspond to
2016-08-12 09:31:17 +00:00
items that the user has explicitly removed from custom categories in the
Jump List. These items must not be re-added to the Jump List in the **next**
call to `app.setJumpList()` , Windows will not display any custom category
that contains any of the removed items.
### `app.setJumpList(categories)` _Windows_
2016-10-04 22:35:23 +00:00
* `categories` [JumpListCategory[]](structures/jump-list-category.md) or `null` - Array of `JumpListCategory` objects.
2016-08-12 09:31:17 +00:00
Sets or removes a custom Jump List for the application, and returns one of the
following strings:
* `ok` - Nothing went wrong.
2016-10-06 00:17:49 +00:00
* `error` - One or more errors occurred, enable runtime logging to figure out
2016-08-12 09:31:17 +00:00
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()` .
Here's a very simple example of creating a custom Jump List:
```javascript
const {app} = require('electron')
app.setJumpList([
{
type: 'custom',
name: 'Recent Projects',
items: [
{ type: 'file', path: 'C:\\Projects\\project1.proj' },
{ type: 'file', path: 'C:\\Projects\\project2.proj' }
]
},
{ // has a name so `type` is assumed to be "custom"
name: 'Tools',
items: [
{
2016-10-05 22:09:30 +00:00
type: 'task',
title: 'Tool A',
program: process.execPath,
args: '--run-tool-a',
icon: process.execPath,
iconIndex: 0,
2016-08-12 09:31:17 +00:00
description: 'Runs Tool A'
},
{
2016-10-05 22:09:30 +00:00
type: 'task',
title: 'Tool B',
program: process.execPath,
args: '--run-tool-b',
icon: process.execPath,
iconIndex: 0,
2016-08-12 09:31:17 +00:00
description: 'Runs Tool B'
}
]
},
{ type: 'frequent' },
{ // has no name and no type so `type` is assumed to be "tasks"
items: [
{
2016-10-05 22:09:30 +00:00
type: 'task',
title: 'New Project',
program: process.execPath,
args: '--new-project',
2016-08-12 09:31:17 +00:00
description: 'Create a new project.'
},
{ type: 'separator' },
{
2016-10-05 22:09:30 +00:00
type: 'task',
title: 'Recover Project',
program: process.execPath,
args: '--recover-project',
2016-08-12 09:31:17 +00:00
description: 'Recover Project'
}
]
}
])
```
2015-10-22 09:03:18 +00:00
### `app.makeSingleInstance(callback)`
2015-10-21 20:52:17 +00:00
* `callback` Function
2016-10-13 06:30:57 +00:00
* `argv` String[] - An array of the second instance's command line arguments
* `workingDirectory` String - The second instance's working directory
2015-10-21 20:52:17 +00:00
This method makes your application a Single Instance Application - instead of
allowing multiple instances of your app to run, this will ensure that only a
single instance of your app is running, and other instances signal this
instance and exit.
2015-10-22 11:26:05 +00:00
`callback` will be called with `callback(argv, workingDirectory)` when a second
instance has been executed. `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.
2015-10-21 20:52:17 +00:00
2015-10-22 11:26:05 +00:00
The `callback` is guaranteed to be executed after the `ready` event of `app`
gets emitted.
This method returns `false` if your process is the primary instance of the
application and your app should continue loading. And returns `true` if your
process has sent its parameters to another instance, and you should immediately
quit.
2016-06-18 13:26:26 +00:00
On macOS the system enforces single instance automatically when users try to open
2015-10-22 11:26:05 +00:00
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
2016-02-15 03:13:11 +00:00
line the system's single instance mechanism will be bypassed and you have to
2015-10-22 11:26:05 +00:00
use this method to ensure single instance.
An example of activating the window of primary instance when a second instance
starts:
2015-10-21 20:52:17 +00:00
2016-04-22 14:15:31 +00:00
```javascript
2016-07-26 01:39:25 +00:00
const {app} = require('electron')
let myWindow = null
2015-10-22 11:26:05 +00:00
2016-05-04 17:59:02 +00:00
const shouldQuit = app.makeSingleInstance((commandLine, workingDirectory) => {
2016-01-16 05:18:20 +00:00
// Someone tried to run a second instance, we should focus our window.
2015-10-22 11:26:05 +00:00
if (myWindow) {
2016-07-26 01:39:25 +00:00
if (myWindow.isMinimized()) myWindow.restore()
myWindow.focus()
2015-10-21 20:52:17 +00:00
}
2016-07-26 01:39:25 +00:00
})
2015-10-22 11:26:05 +00:00
if (shouldQuit) {
2016-07-26 01:39:25 +00:00
app.quit()
2015-10-22 11:26:05 +00:00
}
2015-10-21 20:52:17 +00:00
2015-10-22 11:26:05 +00:00
// Create myWindow, load the rest of the app, etc...
2016-05-04 17:59:02 +00:00
app.on('ready', () => {
2016-07-26 01:39:25 +00:00
})
2015-10-21 20:52:17 +00:00
```
2016-05-26 18:07:19 +00:00
### `app.releaseSingleInstance()`
Releases all locks that were created by `makeSingleInstance` . This will allow
multiple instances of the application to once again run side by side.
2016-06-18 13:26:26 +00:00
### `app.setUserActivity(type, userInfo[, webpageURL])` _macOS_
2016-04-30 05:25:09 +00:00
2016-05-05 08:07:46 +00:00
* `type` String - Uniquely identifies the activity. Maps to
[`NSUserActivity.activityType`][activity-type].
2016-05-03 17:34:59 +00:00
* `userInfo` Object - App-specific state to store for use by another device.
2016-10-30 10:46:20 +00:00
* `webpageURL` String (optional) - The webpage to load in a browser if no suitable app is
2016-05-23 15:49:46 +00:00
installed on the resuming device. The scheme must be `http` or `https` .
2016-04-30 05:25:09 +00:00
Creates an `NSUserActivity` and sets it as the current activity. The activity
2016-05-05 08:07:46 +00:00
is eligible for [Handoff][handoff] to another device afterward.
2016-04-30 05:25:09 +00:00
2016-06-18 13:26:26 +00:00
### `app.getCurrentActivityType()` _macOS_
2016-05-03 22:51:31 +00:00
2016-09-24 23:59:30 +00:00
Returns `String` - The type of the currently running activity.
2016-05-03 22:51:31 +00:00
2015-11-03 07:36:44 +00:00
### `app.setAppUserModelId(id)` _Windows_
* `id` String
Changes the [Application User Model ID][app-user-model-id] to `id` .
2016-04-20 03:15:49 +00:00
### `app.importCertificate(options, callback)` _LINUX_
* `options` Object
* `certificate` String - Path for the pkcs12 file.
* `password` String - Passphrase for the certificate.
* `callback` Function
* `result` Integer - Result of import.
Imports the certificate in pkcs12 format into the platform certificate store.
2016-04-22 13:53:26 +00:00
`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 ](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h ).
2016-04-20 03:15:49 +00:00
2016-06-06 11:19:55 +00:00
### `app.disableHardwareAcceleration()`
Disables hardware acceleration for current app.
This method can only be called before app is ready.
2016-07-01 08:44:09 +00:00
### `app.setBadgeCount(count)` _Linux_ _macOS_
* `count` Integer
2016-09-28 05:28:44 +00:00
Returns `Boolean` - Whether the call succeeded.
2016-07-01 08:44:09 +00:00
Sets the counter badge for current app. Setting the count to `0` will hide the
2016-09-28 05:28:44 +00:00
badge.
2016-07-01 08:44:09 +00:00
On macOS it shows on the dock icon. On Linux it only works for Unity launcher,
2016-07-01 15:51:25 +00:00
**Note:** Unity launcher requires the exsistence of a `.desktop` file to work,
for more information please read [Desktop Environment Integration][unity-requiremnt].
2016-07-01 08:44:09 +00:00
### `app.getBadgeCount()` _Linux_ _macOS_
2016-09-24 23:59:30 +00:00
Returns `Integer` - The current value displayed in the counter badge.
2016-07-01 08:44:09 +00:00
### `app.isUnityRunning()` _Linux_
2016-09-24 23:59:30 +00:00
Returns `Boolean` - Whether the current desktop environment is Unity launcher.
2016-07-01 08:44:09 +00:00
2016-07-11 19:36:06 +00:00
### `app.getLoginItemSettings()` _macOS_ _Windows_
2016-07-06 21:06:38 +00:00
2016-09-24 23:59:30 +00:00
Returns `Object` :
2016-10-05 16:24:33 +00:00
2016-07-06 21:06:38 +00:00
* `openAtLogin` Boolean - `true` if the app is set to open at login.
* `openAsHidden` Boolean - `true` if the app is set to open as hidden at login.
2016-07-11 19:36:06 +00:00
This setting is only supported on macOS.
2016-07-07 23:33:26 +00:00
* `wasOpenedAtLogin` Boolean - `true` if the app was opened at login
2016-07-11 19:36:06 +00:00
automatically. This setting is only supported on macOS.
2016-07-07 23:33:26 +00:00
* `wasOpenedAsHidden` Boolean - `true` if the app was opened as a hidden login
2016-07-06 21:06:38 +00:00
item. This indicates that the app should not open any windows at startup.
2016-07-11 19:36:06 +00:00
This setting is only supported on macOS.
2016-07-06 21:06:38 +00:00
* `restoreState` Boolean - `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
2016-07-11 19:36:06 +00:00
closed. This setting is only supported on macOS.
2016-07-06 21:06:38 +00:00
2016-09-26 18:00:13 +00:00
**Note:** This API has no effect on
2016-10-17 10:26:28 +00:00
[MAS builds][mas-builds].
2016-09-26 18:00:13 +00:00
2016-07-11 19:36:06 +00:00
### `app.setLoginItemSettings(settings)` _macOS_ _Windows_
2016-07-06 21:06:38 +00:00
2016-07-07 23:33:26 +00:00
* `settings` Object
2016-10-30 10:46:20 +00:00
* `openAtLogin` Boolean (optional) - `true` to open the app at login, `false` to remove
2016-07-07 23:33:26 +00:00
the app as a login item. Defaults to `false` .
2016-10-30 10:46:20 +00:00
* `openAsHidden` Boolean (optional) - `true` to open the app as hidden. Defaults to
2016-07-07 23:33:26 +00:00
`false` . The user can edit this setting from the System Preferences so
`app.getLoginItemStatus().wasOpenedAsHidden` should be checked when the app
2016-07-11 19:36:06 +00:00
is opened to know the current value. This setting is only supported on
macOS.
2016-07-06 21:06:38 +00:00
2016-07-07 23:40:53 +00:00
Set the app's login item settings.
2016-07-06 21:06:38 +00:00
2016-09-26 18:00:13 +00:00
**Note:** This API has no effect on
2016-10-17 10:26:28 +00:00
[MAS builds][mas-builds].
2016-09-26 18:00:13 +00:00
2016-07-11 21:41:35 +00:00
### `app.isAccessibilitySupportEnabled()` _macOS_ _Windows_
2016-09-24 23:59:30 +00:00
Returns `Boolean` - `true` if Chrome's accessibility support is enabled,
2016-07-11 21:41:35 +00:00
`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.
2016-10-10 20:40:25 +00:00
### `app.setAboutPanelOptions(options)` _macOS_
* `options` Object
2016-10-12 17:52:59 +00:00
* `applicationName` String (optional) - The app's name.
* `applicationVersion` String (optional) - The app's version.
* `copyright` String (optional) - Copyright information.
* `credits` String (optional) - Credit information.
* `version` String (optional) - The app's build version number.
2016-10-10 20:40:25 +00:00
Set the about panel options. This will override the values defined in the app's
`.plist` file. See the [Apple docs][about-panel-options] for more details.
2015-08-19 16:28:48 +00:00
### `app.commandLine.appendSwitch(switch[, value])`
2013-08-14 22:43:35 +00:00
2016-08-25 17:52:19 +00:00
* `switch` String - A command-line switch
* `value` String (optional) - A value for the given switch
2015-08-19 16:28:48 +00:00
Append a switch (with optional `value` ) to Chromium's command line.
2013-08-14 22:43:35 +00:00
2013-10-05 05:03:08 +00:00
**Note:** This will not affect `process.argv` , and is mainly used by developers
to control some low-level Chromium behaviors.
2013-08-14 22:43:35 +00:00
2015-08-19 16:28:48 +00:00
### `app.commandLine.appendArgument(value)`
2013-08-14 22:43:35 +00:00
2016-08-25 17:52:19 +00:00
* `value` String - The argument to append to the command line
2015-08-24 12:38:29 +00:00
Append an argument to Chromium's command line. The argument will be quoted
correctly.
2013-08-14 22:43:35 +00:00
**Note:** This will not affect `process.argv` .
2016-06-18 13:26:26 +00:00
### `app.dock.bounce([type])` _macOS_
2013-08-14 22:43:35 +00:00
2015-08-24 12:56:19 +00:00
* `type` String (optional) - Can be `critical` or `informational` . The default is
2015-03-30 08:13:11 +00:00
`informational`
2013-08-14 22:43:35 +00:00
2013-08-29 14:37:51 +00:00
When `critical` is passed, the dock icon will bounce until either the
application becomes active or the request is canceled.
2013-08-14 22:43:35 +00:00
2015-08-24 12:38:29 +00:00
When `informational` is passed, the dock icon will bounce for one second.
However, the request remains active until either the application becomes active
or the request is canceled.
2013-08-14 22:43:35 +00:00
2015-08-19 16:28:48 +00:00
Returns an ID representing the request.
2013-08-14 22:43:35 +00:00
2016-06-18 13:26:26 +00:00
### `app.dock.cancelBounce(id)` _macOS_
2013-08-14 22:43:35 +00:00
* `id` Integer
Cancel the bounce of `id` .
2016-06-18 13:26:26 +00:00
### `app.dock.downloadFinished(filePath)` _macOS_
2016-05-10 19:02:56 +00:00
* `filePath` String
Bounces the Downloads stack if the filePath is inside the Downloads folder.
2016-06-18 13:26:26 +00:00
### `app.dock.setBadge(text)` _macOS_
2013-08-14 22:43:35 +00:00
* `text` String
Sets the string to be displayed in the dock’ s badging area.
2016-06-18 13:26:26 +00:00
### `app.dock.getBadge()` _macOS_
2013-08-14 22:43:35 +00:00
2016-09-24 23:59:30 +00:00
Returns `String` - The badge string of the dock.
2013-08-14 22:43:35 +00:00
2016-06-18 13:26:26 +00:00
### `app.dock.hide()` _macOS_
2014-06-25 03:55:33 +00:00
Hides the dock icon.
2016-06-18 13:26:26 +00:00
### `app.dock.show()` _macOS_
2014-06-25 03:55:33 +00:00
Shows the dock icon.
2016-08-01 22:22:37 +00:00
### `app.dock.isVisible()` _macOS_
2016-09-24 23:59:30 +00:00
Returns `Boolean` - Whether the dock icon is visible.
2016-08-01 22:22:37 +00:00
The `app.dock.show()` call is asynchronous so this method might not
return true immediately after that call.
2016-06-18 13:26:26 +00:00
### `app.dock.setMenu(menu)` _macOS_
2014-11-17 10:48:02 +00:00
2016-02-18 05:30:01 +00:00
* `menu` [Menu ](menu.md )
2014-11-17 10:48:02 +00:00
2015-07-18 14:40:01 +00:00
Sets the application's [dock menu][dock-menu].
2014-11-17 10:48:02 +00:00
2016-06-18 13:26:26 +00:00
### `app.dock.setIcon(image)` _macOS_
2016-01-23 23:30:14 +00:00
* `image` [NativeImage ](native-image.md )
Sets the `image` associated with this dock icon.
2014-11-17 10:48:02 +00:00
[dock-menu]:https://developer.apple.com/library/mac/documentation/Carbon/Conceptual/customizing_docktile/concepts/dockconcepts.html#//apple_ref/doc/uid/TP30000986-CH2-TPXREF103
2014-11-17 11:50:34 +00:00
[tasks]:http://msdn.microsoft.com/en-us/library/windows/desktop/dd378460(v=vs.85).aspx#tasks
2015-11-03 07:36:44 +00:00
[app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx
2016-03-31 08:22:09 +00:00
[CFBundleURLTypes]: https://developer.apple.com/library/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CoreFoundationKeys.html#//apple_ref/doc/uid/TP40009249-102207-TPXREF115
2016-05-05 03:26:23 +00:00
[LSCopyDefaultHandlerForURLScheme]: https://developer.apple.com/library/mac/documentation/Carbon/Reference/LaunchServicesReference/#//apple_ref/c/func/LSCopyDefaultHandlerForURLScheme
[handoff]: https://developer.apple.com/library/ios/documentation/UserExperience/Conceptual/Handoff/HandoffFundamentals/HandoffFundamentals.html
2016-05-05 08:07:46 +00:00
[activity-type]: https://developer.apple.com/library/ios/documentation/Foundation/Reference/NSUserActivity_Class/index.html#//apple_ref/occ/instp/NSUserActivity/activityType
2016-07-01 08:44:09 +00:00
[unity-requiremnt]: ../tutorial/desktop-environment-integration.md#unity-launcher-shortcuts-linux
2016-10-17 10:26:28 +00:00
[mas-builds]: ../tutorial/mac-app-store-submission-guide.md
2016-08-12 09:31:17 +00:00
[JumpListBeginListMSDN]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378398(v=vs.85).aspx
2016-10-10 20:40:25 +00:00
[about-panel-options]: https://developer.apple.com/reference/appkit/nsapplication/1428479-orderfrontstandardaboutpanelwith?language=objc