2015-08-20 13:17:53 +00:00
# BrowserWindow
2013-08-14 22:43:35 +00:00
2015-08-24 22:41:02 +00:00
The `BrowserWindow` class gives you the ability to create a browser window, for
example:
2013-08-14 22:43:35 +00:00
```javascript
var BrowserWindow = require('browser-window');
var win = new BrowserWindow({ width: 800, height: 600, show: false });
2014-04-25 09:15:26 +00:00
win.on('closed', function() {
2013-08-14 22:43:35 +00:00
win = null;
});
win.loadUrl('https://github.com');
win.show();
```
2015-08-20 17:03:53 +00:00
You can also create a window without chrome by using
2013-09-09 06:52:46 +00:00
[Frameless Window ](frameless-window.md ) API.
2013-08-14 22:43:35 +00:00
## Class: BrowserWindow
2013-08-29 14:37:51 +00:00
`BrowserWindow` is an
[EventEmitter ](http://nodejs.org/api/events.html#events_class_events_eventemitter ).
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
It creates a new `BrowserWindow` with native properties as set by the `options` .
Properties `width` and `height` are required.
### `new BrowserWindow(options)`
`options` Object, properties:
* `width` Integer **required** - Window's width.
* `height` Integer **required** - Window's height.
* `x` Integer - Window's left offset from screen.
* `y` Integer - Window's top offset from screen.
* `use-content-size` Boolean - The `width` and `height` would be used as web
page's size, which means the actual window's size will include window
frame's size and be slightly larger.
* `center` Boolean - Show window in the center of the screen.
* `min-width` Integer - Window's minimum width.
* `min-height` Integer - Window's minimum height.
* `max-width` Integer - Window's maximum width.
* `max-height` Integer - Window's maximum height.
* `resizable` Boolean - Whether window is resizable.
* `always-on-top` Boolean - Whether the window should always stay on top of
other windows.
* `fullscreen` Boolean - Whether the window should show in fullscreen. When
set to `false` the fullscreen button will also be hidden on OS X.
* `skip-taskbar` Boolean - Whether to show the window in taskbar.
* `zoom-factor` Number - The default zoom factor of the page, `3.0` represents
`300%` .
* `kiosk` Boolean - The kiosk mode.
* `title` String - Default window title.
* `icon` [NativeImage ](native-image.md ) - The window icon, when omitted on
Windows the executable's icon would be used as window icon.
* `show` Boolean - Whether window should be shown when created.
* `frame` Boolean - Specify `false` to create a
[Frameless Window ](frameless-window.md ).
* `node-integration` Boolean - Whether node integration is enabled. Default
is `true` .
* `accept-first-mouse` Boolean - Whether the web view accepts a single
mouse-down event that simultaneously activates the window.
* `disable-auto-hide-cursor` Boolean - Whether to hide cursor when typing.
* `auto-hide-menu-bar` Boolean - Auto hide the menu bar unless the `Alt`
key is pressed.
* `enable-larger-than-screen` Boolean - Enable the window to be resized larger
than screen.
* `dark-theme` Boolean - Forces using dark theme for the window, only works on
some GTK+3 desktop environments.
* `preload` String - Specifies a script that will be loaded before other
scripts run in the window. This script will always have access to node APIs
no matter whether node integration is turned on for the window, and the path
of `preload` script has to be absolute path.
* `transparent` Boolean - Makes the window [transparent ](frameless-window.md ).
* `type` String - Specifies the type of the window, possible types are
`desktop` , `dock` , `toolbar` , `splash` , `notification` . This only works on
Linux.
* `standard-window` Boolean - Uses the OS X's standard window instead of the
textured window. Defaults to `true` .
* `web-preferences` Object - Settings of web page's features, properties:
* `javascript` Boolean
2015-08-24 22:41:02 +00:00
* `web-security` Boolean - When setting `false` , it will disable the
same-origin policy (Usually using testing websites by people), and set `allow_displaying_insecure_content`
2015-08-20 13:17:53 +00:00
and `allow_running_insecure_content` to `true` if these two options are not
set by user.
* `allow-displaying-insecure-content` Boolean - Allow an https page to display
content like images from http URLs.
2015-08-24 22:41:02 +00:00
* `allow-running-insecure-content` Boolean - Allow a https page to run
JavaScript, CSS or plugins from http URLs.
2015-08-20 13:17:53 +00:00
* `images` Boolean
* `java` Boolean
* `text-areas-are-resizable` Boolean
* `webgl` Boolean
* `webaudio` Boolean
* `plugins` Boolean - Whether plugins should be enabled, currently only
`NPAPI` plugins are supported.
* `extra-plugin-dirs` Array - Array of paths that would be searched for
plugins. Note that if you want to add a directory under your app, you
should use `__dirname` or `process.resourcesPath` to join the paths to
make them absolute, using relative paths would make Electron search
under current working directory.
* `experimental-features` Boolean
* `experimental-canvas-features` Boolean
* `subpixel-font-scaling` Boolean
* `overlay-scrollbars` Boolean
* `overlay-fullscreen-video` Boolean
* `shared-worker` Boolean
* `direct-write` Boolean - Whether the DirectWrite font rendering system on
Windows is enabled.
* `page-visibility` Boolean - Page would be forced to be always in visible
or hidden state once set, instead of reflecting current window's
visibility. Users can set it to `true` to prevent throttling of DOM
timers.
## Events
The `BrowserWindow` object emits the following events:
2013-08-14 22:43:35 +00:00
### Event: 'page-title-updated'
2015-08-20 13:17:53 +00:00
Returns:
2013-08-14 22:43:35 +00:00
* `event` Event
2013-08-29 14:37:51 +00:00
Emitted when the document changed its title, calling `event.preventDefault()`
would prevent the native window's title to change.
2013-08-14 22:43:35 +00:00
### Event: 'close'
2015-08-20 13:17:53 +00:00
Returns:
2013-08-14 22:43:35 +00:00
* `event` Event
2013-08-29 14:37:51 +00:00
Emitted when the window is going to be closed. It's emitted before the
2015-08-20 13:17:53 +00:00
`beforeunload` and `unload` event of the DOM. Calling `event.preventDefault()`
will cancel the close.
2013-08-14 22:43:35 +00:00
2013-08-29 14:37:51 +00:00
Usually you would want to use the `beforeunload` handler to decide whether the
window should be closed, which will also be called when the window is
2015-04-16 03:31:12 +00:00
reloaded. In Electron, returning an empty string or `false` would cancel the
2015-08-20 13:17:53 +00:00
close. For example:
2013-08-14 22:43:35 +00:00
```javascript
window.onbeforeunload = function(e) {
console.log('I do not want to be closed');
// Unlike usual browsers, in which a string should be returned and the user is
2015-06-09 14:56:45 +00:00
// prompted to confirm the page unload, Electron gives developers more options.
2015-08-20 17:03:53 +00:00
// Returning an empty string or `false` will prevent the unloading.
2015-08-24 22:41:02 +00:00
< < < < < < < HEAD
2015-06-09 14:56:45 +00:00
// You can also use the dialog API to let the user confirm closing the application.
2015-08-18 16:34:14 +00:00
e.returnValue = false;
2015-08-24 22:41:02 +00:00
=======
// You can also use the dialog API to let the user confirm closing the app.
return false;
>>>>>>> Line wrap 80-col
2013-08-14 22:43:35 +00:00
};
```
### Event: 'closed'
2014-04-30 06:52:58 +00:00
Emitted when the window is closed. After you have received this event you should
remove the reference to the window and avoid using it anymore.
2013-08-14 22:43:35 +00:00
2014-01-15 14:42:47 +00:00
### Event: 'unresponsive'
2014-05-07 06:34:53 +00:00
Emitted when the web page becomes unresponsive.
2014-01-15 14:42:47 +00:00
### Event: 'responsive'
Emitted when the unresponsive web page becomes responsive again.
### Event: 'blur'
2015-08-20 13:17:53 +00:00
Emitted when the window loses focus.
2014-01-15 14:42:47 +00:00
2014-05-21 17:46:13 +00:00
### Event: 'focus'
2015-08-20 13:17:53 +00:00
Emitted when the window gains focus.
2014-05-21 17:46:13 +00:00
2014-11-25 06:43:11 +00:00
### Event: 'maximize'
Emitted when window is maximized.
### Event: 'unmaximize'
2015-08-20 13:17:53 +00:00
Emitted when the window exits from maximized state.
2014-11-25 06:43:11 +00:00
### Event: 'minimize'
2015-08-20 13:17:53 +00:00
Emitted when the window is minimized.
2014-11-25 06:43:11 +00:00
### Event: 'restore'
2015-08-20 13:17:53 +00:00
Emitted when the window is restored from minimized state.
2014-11-25 06:43:11 +00:00
2015-05-09 15:55:10 +00:00
### Event: 'resize'
2015-08-20 13:17:53 +00:00
Emitted when the window is getting resized.
2015-05-09 15:55:10 +00:00
### Event: 'move'
2015-05-20 08:37:13 +00:00
Emitted when the window is getting moved to a new position.
2015-05-27 06:57:14 +00:00
__Note__: On OS X this event is just an alias of `moved` .
2015-05-20 08:37:13 +00:00
### Event: 'moved'
Emitted once when the window is moved to a new position.
2015-05-09 15:55:10 +00:00
2015-05-27 06:57:14 +00:00
__Note__: This event is available only on OS X.
2014-11-25 06:43:11 +00:00
### Event: 'enter-full-screen'
2015-08-20 13:17:53 +00:00
Emitted when the window enters full screen state.
2014-11-25 06:43:11 +00:00
### Event: 'leave-full-screen'
2015-08-20 13:17:53 +00:00
Emitted when the window leaves full screen state.
2014-11-25 06:43:11 +00:00
2015-05-16 21:01:30 +00:00
### Event: 'enter-html-full-screen'
2015-08-20 13:17:53 +00:00
Emitted when the window enters full screen state triggered by html api.
2015-05-16 21:01:30 +00:00
### Event: 'leave-html-full-screen'
2015-08-20 13:17:53 +00:00
Emitted when the window leaves full screen state triggered by html api.
2015-05-16 21:01:30 +00:00
2014-08-28 08:00:29 +00:00
### Event: 'devtools-opened'
2014-08-28 06:25:00 +00:00
Emitted when devtools is opened.
2014-08-28 08:00:29 +00:00
### Event: 'devtools-closed'
2014-08-28 06:25:00 +00:00
Emitted when devtools is closed.
2015-03-31 15:45:06 +00:00
### Event: 'devtools-focused'
Emitted when devtools is focused / opened.
2015-06-25 17:20:33 +00:00
### Event: 'app-command':
2015-06-19 19:58:47 +00:00
2015-08-24 22:41:02 +00:00
Emitted when an [App Command ](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85 ).aspx
is invoked. These are typically related to keyboard media keys or browser
commands, as well as the "Back" button built into some mice on Windows.
2015-06-19 19:58:47 +00:00
```js
2015-06-26 03:20:12 +00:00
someWindow.on('app-command', function(e, cmd) {
2015-06-19 19:58:47 +00:00
// Navigate the window back when the user hits their mouse back button
2015-06-26 03:20:12 +00:00
if (cmd === 'browser-backward' & & someWindow.webContents.canGoBack()) {
2015-06-19 19:58:47 +00:00
someWindow.webContents.goBack();
}
});
```
2015-06-26 03:20:12 +00:00
__Note__: This event is only fired on Windows.
2015-06-25 17:20:33 +00:00
2015-08-20 13:17:53 +00:00
## Methods
The `BrowserWindow` object has the following methods:
### `BrowserWindow.getAllWindows()`
2013-12-26 10:41:21 +00:00
Returns an array of all opened browser windows.
2015-08-20 13:17:53 +00:00
### `BrowserWindow.getFocusedWindow()`
2013-08-14 22:43:35 +00:00
Returns the window that is focused in this application.
2015-08-20 13:17:53 +00:00
### `BrowserWindow.fromWebContents(webContents)`
2014-04-25 09:15:26 +00:00
2015-08-20 13:17:53 +00:00
* `webContents` [WebContents ](#webcontents )
2014-04-25 09:15:26 +00:00
2015-08-20 13:17:53 +00:00
Find a window according to the `webContents` it owns.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `BrowserWindow.fromId(id)`
2014-05-22 01:56:04 +00:00
* `id` Integer
Find a window according to its ID.
2015-08-20 13:17:53 +00:00
### `BrowserWindow.addDevToolsExtension(path)`
2014-08-28 08:33:27 +00:00
* `path` String
Adds devtools extension located at `path` , and returns extension's name.
The extension will be remembered so you only need to call this API once, this
API is not for programming use.
2015-08-20 13:17:53 +00:00
### `BrowserWindow.removeDevToolsExtension(name)`
2014-08-28 08:33:27 +00:00
* `name` String
Remove the devtools extension whose name is `name` .
2015-08-20 13:17:53 +00:00
## Instance Methods
Objects created with `new BrowserWindow` have the following instance methods:
```javascript
var BrowserWindow = require('browser-window');
// In this example `win` is our instance
2015-08-20 17:03:53 +00:00
var win = new BrowserWindow({ width: 800, height: 600 });
2015-08-20 13:17:53 +00:00
```
### `win.webContents`
2013-08-14 22:43:35 +00:00
2014-04-25 09:15:26 +00:00
The `WebContents` object this window owns, all web page related events and
2015-08-20 13:17:53 +00:00
operations will be done via it.
2015-08-24 22:41:02 +00:00
See the [`webContents` documentation ](web-contents.md ) for its methods and
events.
2014-04-25 09:15:26 +00:00
2015-03-26 15:20:31 +00:00
**Note:** Users should never store this object because it may become `null`
when the renderer process (web page) has crashed.
2014-05-22 01:56:04 +00:00
2015-08-20 13:17:53 +00:00
### `win.devToolsWebContents`
2014-04-25 09:15:26 +00:00
2015-08-20 13:17:53 +00:00
Get the `WebContents` of devtools for this window.
2013-08-14 22:43:35 +00:00
2015-03-26 15:20:31 +00:00
**Note:** Users should never store this object because it may become `null`
2014-05-22 01:56:04 +00:00
when the devtools has been closed.
2015-08-20 13:17:53 +00:00
### `win.id`
2014-05-22 01:56:04 +00:00
Get the unique ID of this window.
2015-08-20 13:17:53 +00:00
### `win.destroy()`
2013-08-14 22:43:35 +00:00
2014-04-30 06:52:58 +00:00
Force closing the window, the `unload` and `beforeunload` event won't be emitted
2015-08-20 13:17:53 +00:00
for the web page, and `close` event will also not be emitted
for this window, but it guarantees the `closed` event will be emitted.
2013-08-14 22:43:35 +00:00
2015-03-26 15:20:31 +00:00
You should only use this method when the renderer process (web page) has crashed.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.close()`
2013-08-14 22:43:35 +00:00
2013-08-29 14:37:51 +00:00
Try to close the window, this has the same effect with user manually clicking
the close button of the window. The web page may cancel the close though, see
2015-04-01 00:24:39 +00:00
the [close event ](#event-close ).
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.focus()`
2013-08-14 22:43:35 +00:00
Focus on the window.
2015-08-20 13:17:53 +00:00
### `win.isFocused()`
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
Returns a boolean, whether the window is focused.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.show()`
2013-08-14 22:43:35 +00:00
2014-10-17 14:46:00 +00:00
Shows and gives focus to the window.
2015-08-20 13:17:53 +00:00
### `win.showInactive()`
2014-10-17 14:46:00 +00:00
Shows the window but doesn't focus on it.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.hide()`
2013-08-14 22:43:35 +00:00
Hides the window.
2015-08-20 13:17:53 +00:00
### `win.isVisible()`
2013-10-03 00:27:59 +00:00
2015-08-20 13:17:53 +00:00
Returns a boolean, whether the window is visible to the user.
2013-10-03 00:27:59 +00:00
2015-08-20 13:17:53 +00:00
### `win.maximize()`
2013-08-14 22:43:35 +00:00
Maximizes the window.
2015-08-20 13:17:53 +00:00
### `win.unmaximize()`
2013-08-14 22:43:35 +00:00
Unmaximizes the window.
2015-08-20 13:17:53 +00:00
### `win.isMaximized()`
2014-05-14 21:58:49 +00:00
2015-08-20 13:17:53 +00:00
Returns a boolean, whether the window is maximized.
2014-05-14 21:58:49 +00:00
2015-08-20 13:17:53 +00:00
### `win.minimize()`
2013-08-14 22:43:35 +00:00
2013-08-29 14:37:51 +00:00
Minimizes the window. On some platforms the minimized window will be shown in
the Dock.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.restore()`
2013-08-14 22:43:35 +00:00
Restores the window from minimized state to its previous state.
2015-08-20 13:17:53 +00:00
### `win.isMinimized()`
2014-07-26 05:58:26 +00:00
2015-08-20 13:17:53 +00:00
Returns a boolean, whether the window is minimized.
2014-07-26 05:58:26 +00:00
2015-08-20 13:17:53 +00:00
### `win.setFullScreen(flag)`
2013-08-14 22:43:35 +00:00
* `flag` Boolean
Sets whether the window should be in fullscreen mode.
2015-08-20 13:17:53 +00:00
### `win.isFullScreen()`
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
Returns a boolean, whether the window is in fullscreen mode.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.setAspectRatio(aspectRatio[, extraSize])`
2015-07-22 14:23:31 +00:00
2015-08-24 22:41:02 +00:00
* `aspectRatio` The aspect ratio we want to maintain for some portion of the
content view.
* `rect` Object - The extra size to not be included in the aspect ratio to be
maintained. Properties:
2015-07-22 14:23:31 +00:00
* `width` Integer
* `height` Integer
2015-08-24 22:41:02 +00:00
This will have a window maintain an aspect ratio. The extra size allows a
developer to have space, specified in pixels, not included within the aspect ratio calculations. This API already takes into account the difference between a
window's size and its content size.
2015-07-22 14:23:31 +00:00
2015-08-24 22:41:02 +00:00
Consider a normal window with an HD video player and associated controls.
Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls
on the right edge and 50 pixels of controls below the player. In order to
maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080 ) within
the player itself we would call this function with arguments of 16/9 and
[ 40, 50 ]. The second argument doesn't care where the extra width and height
are within the content view--only that they exist. Just sum any extra width and
height areas you have within the overall content view.
2015-07-22 14:23:31 +00:00
2015-07-23 02:14:02 +00:00
__Note__: This API is only implemented on OS X.
2015-08-20 13:17:53 +00:00
### `win.setBounds(options)`
2015-05-01 10:50:53 +00:00
2015-08-20 13:17:53 +00:00
`options` Object, properties:
* `x` Integer
* `y` Integer
* `width` Integer
* `height` Integer
2015-05-01 10:50:53 +00:00
Resizes and moves the window to `width` , `height` , `x` , `y` .
2015-08-20 13:17:53 +00:00
### `win.getBounds()`
2015-05-01 10:50:53 +00:00
Returns an object that contains window's width, height, x and y values.
2015-08-20 13:17:53 +00:00
### `win.setSize(width, height)`
2013-08-14 22:43:35 +00:00
* `width` Integer
* `height` Integer
Resizes the window to `width` and `height` .
2015-08-20 13:17:53 +00:00
### `win.getSize()`
2013-08-14 22:43:35 +00:00
Returns an array that contains window's width and height.
2015-08-20 13:17:53 +00:00
### `win.setContentSize(width, height)`
2014-05-18 13:33:31 +00:00
* `width` Integer
* `height` Integer
Resizes the window's client area (e.g. the web page) to `width` and `height` .
2015-08-20 13:17:53 +00:00
### `win.getContentSize()`
2014-05-18 13:33:31 +00:00
Returns an array that contains window's client area's width and height.
2015-08-20 13:17:53 +00:00
### `win.setMinimumSize(width, height)`
2013-08-14 22:43:35 +00:00
* `width` Integer
* `height` Integer
Sets the minimum size of window to `width` and `height` .
2015-08-20 13:17:53 +00:00
### `win.getMinimumSize()`
2013-08-14 22:43:35 +00:00
Returns an array that contains window's minimum width and height.
2015-08-20 13:17:53 +00:00
### `win.setMaximumSize(width, height)`
2013-08-14 22:43:35 +00:00
* `width` Integer
* `height` Integer
Sets the maximum size of window to `width` and `height` .
2015-08-20 13:17:53 +00:00
### `win.getMaximumSize()`
2013-08-14 22:43:35 +00:00
Returns an array that contains window's maximum width and height.
2015-08-20 13:17:53 +00:00
### `win.setResizable(resizable)`
2013-08-14 22:43:35 +00:00
* `resizable` Boolean
Sets whether the window can be manually resized by user.
2015-08-20 13:17:53 +00:00
### `win.isResizable()`
2013-08-14 22:43:35 +00:00
Returns whether the window can be manually resized by user.
2015-08-20 13:17:53 +00:00
### `win.setAlwaysOnTop(flag)`
2013-08-14 22:43:35 +00:00
* `flag` Boolean
2013-08-29 14:37:51 +00:00
Sets whether the window should show always on top of other windows. After
setting this, the window is still a normal window, not a toolbox window which
can not be focused on.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.isAlwaysOnTop()`
2013-08-14 22:43:35 +00:00
Returns whether the window is always on top of other windows.
2015-08-20 13:17:53 +00:00
### `win.center()`
2013-08-14 22:43:35 +00:00
Moves window to the center of the screen.
2015-08-20 13:17:53 +00:00
### `win.setPosition(x, y)`
2013-08-14 22:43:35 +00:00
* `x` Integer
* `y` Integer
Moves window to `x` and `y` .
2015-08-20 13:17:53 +00:00
### `win.getPosition()`
2013-08-14 22:43:35 +00:00
Returns an array that contains window's current position.
2015-08-20 13:17:53 +00:00
### `win.setTitle(title)`
2013-08-14 22:43:35 +00:00
* `title` String
Changes the title of native window to `title` .
2015-08-20 13:17:53 +00:00
### `win.getTitle()`
2013-08-14 22:43:35 +00:00
Returns the title of the native window.
2013-08-29 14:37:51 +00:00
**Note:** The title of web page can be different from the title of the native
2014-08-22 07:14:49 +00:00
window.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.flashFrame(flag)`
2014-08-28 08:00:29 +00:00
2014-08-23 05:20:47 +00:00
* `flag` Boolean
2013-08-14 22:43:35 +00:00
2014-08-23 05:20:47 +00:00
Starts or stops flashing the window to attract user's attention.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.setSkipTaskbar(skip)`
2014-06-16 02:51:45 +00:00
* `skip` Boolean
2015-06-09 14:49:44 +00:00
Makes the window not show in the taskbar.
2014-06-16 02:51:45 +00:00
2015-08-20 13:17:53 +00:00
### `win.setKiosk(flag)`
2013-08-14 22:43:35 +00:00
* `flag` Boolean
Enters or leaves the kiosk mode.
2015-08-20 13:17:53 +00:00
### `win.isKiosk()`
2013-08-14 22:43:35 +00:00
Returns whether the window is in kiosk mode.
2015-08-20 13:17:53 +00:00
### `win.setRepresentedFilename(filename)`
2014-05-27 06:15:34 +00:00
* `filename` String
2014-12-19 20:48:53 +00:00
Sets the pathname of the file the window represents, and the icon of the file
will show in window's title bar.
2015-06-09 14:51:54 +00:00
__Note__: This API is only available on OS X.
2014-05-27 06:15:34 +00:00
2015-08-20 13:17:53 +00:00
### `win.getRepresentedFilename()`
2014-07-18 13:42:26 +00:00
2014-12-19 20:48:53 +00:00
Returns the pathname of the file the window represents.
2015-06-09 14:51:54 +00:00
__Note__: This API is only available on OS X.
2014-07-18 13:42:26 +00:00
2015-08-20 13:17:53 +00:00
### `win.setDocumentEdited(edited)`
2014-05-27 06:15:34 +00:00
* `edited` Boolean
2014-12-19 20:48:53 +00:00
Specifies whether the window’ s document has been edited, and the icon in title
bar will become grey when set to `true` .
2015-06-09 14:51:54 +00:00
__Note__: This API is only available on OS X.
2014-05-27 06:15:34 +00:00
2015-08-20 13:17:53 +00:00
### `win.IsDocumentEdited()`
2014-07-24 07:48:33 +00:00
2014-12-19 20:48:53 +00:00
Whether the window's document has been edited.
2015-06-09 14:51:54 +00:00
__Note__: This API is only available on OS X.
2014-07-24 07:48:33 +00:00
2015-08-20 13:17:53 +00:00
### `win.openDevTools([options])`
2015-03-26 09:13:35 +00:00
2015-08-20 13:17:53 +00:00
* `options` Object, optional. Properties:
2015-03-26 09:13:35 +00:00
* `detach` Boolean - opens devtools in a new window
2013-08-14 22:43:35 +00:00
Opens the developer tools.
2015-08-20 13:17:53 +00:00
### `win.closeDevTools()`
2013-08-14 22:43:35 +00:00
Closes the developer tools.
2015-08-20 13:17:53 +00:00
### `win.isDevToolsOpened()`
2015-06-21 02:56:40 +00:00
Returns whether the developer tools are opened.
2015-08-20 13:17:53 +00:00
### `win.toggleDevTools()`
2014-07-01 15:32:44 +00:00
Toggle the developer tools.
2015-08-20 13:17:53 +00:00
### `win.inspectElement(x, y)`
2013-08-14 22:43:35 +00:00
* `x` Integer
* `y` Integer
Starts inspecting element at position (`x`, `y` ).
2015-08-20 13:17:53 +00:00
### `win.inspectServiceWorker()`
2015-05-18 14:38:08 +00:00
2015-08-24 22:41:02 +00:00
Opens the developer tools for the service worker context present in the web
contents.
2015-05-18 14:38:08 +00:00
2015-08-20 13:17:53 +00:00
### `win.focusOnWebView()`
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.blurWebView()`
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.capturePage([rect, ]callback)`
2013-11-22 06:39:10 +00:00
2015-08-20 13:17:53 +00:00
* `rect` Object - The area of page to be captured, properties:
2014-08-22 07:14:49 +00:00
* `x` Integer
* `y` Integer
* `width` Integer
* `height` Integer
2013-11-22 06:39:10 +00:00
* `callback` Function
2015-08-20 13:17:53 +00:00
Captures a snapshot of the page within `rect` . Upon completion `callback` will be
called with `callback(image)` . The `image` is an instance of
[NativeImage ](native-image.md ) that stores data of the snapshot. Omitting
`rect` will capture the whole visible page.
2013-11-22 06:39:10 +00:00
2015-08-20 13:17:53 +00:00
< < < < < < < HEAD
2014-08-22 07:14:49 +00:00
### BrowserWindow.print([options])
2015-08-20 13:17:53 +00:00
=======
**Note:** Be sure to read documents on remote buffer in
[remote ](remote.md ) if you are going to use this API in renderer
process.
### `win.print([options])`
>>>>>>> Break out methods, standardize
2014-08-22 07:14:49 +00:00
2015-08-20 13:17:53 +00:00
Same as `webContents.print([options])`
2015-05-23 13:39:59 +00:00
2015-08-20 13:17:53 +00:00
### `win.printToPDF(options, callback)`
2015-06-13 13:39:06 +00:00
2015-08-20 13:17:53 +00:00
Same as `webContents.printToPDF(options, callback)`
2015-06-13 13:39:06 +00:00
2015-08-20 13:17:53 +00:00
### `win.loadUrl(url[, options])`
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
Same as `webContents.loadUrl(url[, options])` .
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.reload()`
2014-05-15 12:21:37 +00:00
2015-08-20 13:17:53 +00:00
Same as `webContents.reload` .
2014-05-14 16:06:56 +00:00
2015-08-20 13:17:53 +00:00
### `win.setMenu(menu)`
2014-05-14 16:19:30 +00:00
2014-05-27 06:20:22 +00:00
* `menu` Menu
2015-06-04 08:12:29 +00:00
Sets the `menu` as the window's menu bar, setting it to `null` will remove the
menu bar.
2014-05-14 16:19:30 +00:00
2014-05-27 06:20:22 +00:00
__Note:__ This API is not available on OS X.
2015-08-20 13:17:53 +00:00
### `win.setProgressBar(progress)`
2014-09-18 11:29:23 +00:00
* `progress` Double
Sets progress value in progress bar. Valid range is [0, 1.0].
Remove progress bar when progress < 0 ;
Change to indeterminate mode when progress > 1.
On Linux platform, only supports Unity desktop environment, you need to specify
the `*.desktop` file name to `desktopName` field in `package.json` . By default,
2014-09-18 14:58:17 +00:00
it will assume `app.getName().desktop` .
2014-09-18 11:29:23 +00:00
2015-08-20 13:17:53 +00:00
### `win.setOverlayIcon(overlay, description)`
2015-02-07 01:11:54 +00:00
2015-02-12 05:52:28 +00:00
* `overlay` [NativeImage ](native-image.md ) - the icon to display on the bottom
2015-06-09 14:49:44 +00:00
right corner of the taskbar icon. If this parameter is `null` , the overlay is
2015-02-12 05:52:28 +00:00
cleared
* `description` String - a description that will be provided to Accessibility
screen readers
2015-02-07 01:11:54 +00:00
2015-08-24 22:41:02 +00:00
Sets a 16px overlay onto the current taskbar icon, usually used to convey some
sort of application status or to passively notify the user.
2015-02-07 01:11:54 +00:00
2015-06-09 14:51:54 +00:00
__Note:__ This API is only available on Windows (Windows 7 and above)
2015-02-07 01:11:54 +00:00
2015-08-02 05:07:55 +00:00
2015-08-20 13:17:53 +00:00
### `win.setThumbarButtons(buttons)`
2015-08-20 17:03:53 +00:00
`buttons` Array of `button` Objects:
2015-08-20 13:17:53 +00:00
`button` Object, properties:
* `icon` [NativeImage ](native-image.md ) - The icon showing in thumbnail
toolbar.
* `tooltip` String (optional) - The text of the button's tooltip.
* `flags` Array (optional) - Control specific states and behaviors
of the button. By default, it uses `enabled` . It can include following
Strings:
* `enabled` - The button is active and available to the user.
* `disabled` - The button is disabled. It is present, but has a visual
2015-08-20 17:03:53 +00:00
state indicating it will not respond to user action.
2015-08-20 13:17:53 +00:00
* `dismissonclick` - When the button is clicked, the taskbar button's
flyout closes immediately.
* `nobackground` - Do not draw a button border, use only the image.
* `hidden` - The button is not shown to the user.
* `noninteractive` - The button is enabled but not interactive; no
pressed button state is drawn. This value is intended for instances
where the button is used in a notification.
* `click` - Function
2015-08-05 05:47:59 +00:00
Add a thumbnail toolbar with a specified set of buttons to the thumbnail image
of a window in a taskbar button layout. Returns a `Boolean` object indicates
whether the thumbnail has been added successfully.
2015-08-02 05:07:55 +00:00
__Note:__ This API is only available on Windows (Windows 7 and above).
2015-08-05 05:47:59 +00:00
The number of buttons in thumbnail toolbar should be no greater than 7 due to
the limited room. Once you setup the thumbnail toolbar, the toolbar cannot be
removed due to the platform's limitation. But you can call the API with an empty
array to clean the buttons.
2015-08-02 05:07:55 +00:00
2015-08-20 13:17:53 +00:00
### `win.showDefinitionForSelection()`
2014-12-18 23:40:35 +00:00
2014-12-19 20:48:53 +00:00
Shows pop-up dictionary that searches the selected word on the page.
2015-06-09 14:51:54 +00:00
__Note__: This API is only available on OS X.
2014-12-18 23:40:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.setAutoHideMenuBar(hide)`
2014-11-12 12:49:38 +00:00
* `hide` Boolean
Sets whether the window menu bar should hide itself automatically. Once set the
menu bar will only show when users press the single `Alt` key.
If the menu bar is already visible, calling `setAutoHideMenuBar(true)` won't
hide it immediately.
2015-08-20 13:17:53 +00:00
### `win.isMenuBarAutoHide()`
2014-11-12 12:49:38 +00:00
Returns whether menu bar automatically hides itself.
2015-08-20 13:17:53 +00:00
### `win.setMenuBarVisibility(visible)`
2014-11-12 12:49:38 +00:00
* `visible` Boolean
Sets whether the menu bar should be visible. If the menu bar is auto-hide, users
can still bring up the menu bar by pressing the single `Alt` key.
2015-08-20 13:17:53 +00:00
### `win.isMenuBarVisible()`
2014-11-12 12:49:38 +00:00
Returns whether the menu bar is visible.
2015-08-20 13:17:53 +00:00
### `win.setVisibleOnAllWorkspaces(visible)`
2015-03-26 10:59:24 +00:00
* `visible` Boolean
Sets whether the window should be visible on all workspaces.
2015-03-27 11:41:07 +00:00
**Note:** This API does nothing on Windows.
2015-03-26 10:59:24 +00:00
2015-08-20 13:17:53 +00:00
### `win.isVisibleOnAllWorkspaces()`
2015-03-26 10:59:24 +00:00
Returns whether the window is visible on all workspaces.
2015-03-29 12:40:02 +00:00
**Note:** This API always returns false on Windows.
2015-08-20 13:17:53 +00:00
< < < < < < < HEAD
2015-03-26 10:59:24 +00:00
2014-04-25 09:15:26 +00:00
## Class: WebContents
2013-08-14 22:43:35 +00:00
2014-04-25 09:15:26 +00:00
A `WebContents` is responsible for rendering and controlling a web page.
2013-08-14 22:43:35 +00:00
2014-04-25 09:15:26 +00:00
`WebContents` is an
[EventEmitter ](http://nodejs.org/api/events.html#events_class_events_eventemitter ).
2013-08-14 22:43:35 +00:00
2014-04-25 09:15:26 +00:00
### Event: 'did-finish-load'
2013-08-14 22:43:35 +00:00
2014-04-25 09:15:26 +00:00
Emitted when the navigation is done, i.e. the spinner of the tab will stop
2014-10-24 15:05:25 +00:00
spinning, and the `onload` event was dispatched.
### Event: 'did-fail-load'
* `event` Event
* `errorCode` Integer
* `errorDescription` String
This event is like `did-finish-load` , but emitted when the load failed or was
cancelled, e.g. `window.stop()` is invoked.
2013-08-14 22:43:35 +00:00
2014-06-09 04:03:19 +00:00
### Event: 'did-frame-finish-load'
* `event` Event
* `isMainFrame` Boolean
Emitted when a frame has done navigation.
2014-04-25 09:15:26 +00:00
### Event: 'did-start-loading'
2013-08-14 22:43:35 +00:00
2014-10-24 15:05:25 +00:00
Corresponds to the points in time when the spinner of the tab starts spinning.
2014-04-25 09:15:26 +00:00
### Event: 'did-stop-loading'
2013-08-14 22:43:35 +00:00
2014-10-24 15:05:25 +00:00
Corresponds to the points in time when the spinner of the tab stops spinning.
2015-04-08 13:44:47 +00:00
### Event: 'did-get-response-details'
* `event` Event
* `status` Boolean
* `newUrl` String
* `originalUrl` String
* `httpResponseCode` Integer
* `requestMethod` String
* `referrer` String
2015-05-21 21:22:52 +00:00
* `headers` Object
2015-04-08 13:44:47 +00:00
Emitted when details regarding a requested resource is available.
`status` indicates the socket connection to download the resource.
2014-10-24 15:05:25 +00:00
### Event: 'did-get-redirect-request'
* `event` Event
* `oldUrl` String
* `newUrl` String
* `isMainFrame` Boolean
Emitted when a redirect was received while requesting a resource.
2015-04-29 13:49:31 +00:00
### Event: 'dom-ready'
* `event` Event
Emitted when document in the given frame is loaded.
2015-04-20 06:50:04 +00:00
### Event: 'page-favicon-updated'
2015-04-17 19:55:31 +00:00
* `event` Event
2015-04-25 03:30:24 +00:00
* `favicons` Array - Array of Urls
2015-04-17 19:55:31 +00:00
Emitted when page receives favicon urls.
2014-10-27 15:23:26 +00:00
### Event: 'new-window'
* `event` Event
* `url` String
* `frameName` String
2014-11-04 10:37:06 +00:00
* `disposition` String - Can be `default` , `foreground-tab` , `background-tab` ,
`new-window` and `other`
2014-10-27 15:23:26 +00:00
Emitted when the page requested to open a new window for `url` . It could be
2014-11-02 15:20:00 +00:00
requested by `window.open` or an external link like `<a target='_blank'>` .
2015-03-04 16:47:04 +00:00
By default a new `BrowserWindow` will be created for the `url` .
2014-10-27 15:23:26 +00:00
Calling `event.preventDefault()` can prevent creating new windows.
2015-02-05 00:23:16 +00:00
### Event: 'will-navigate'
2014-12-17 23:15:37 +00:00
* `event` Event
* `url` String
2015-07-15 14:29:02 +00:00
Emitted when user or the page wants to start a navigation, it can happen when
2014-12-17 23:15:37 +00:00
`window.location` object is changed or user clicks a link in the page.
2015-06-09 14:49:21 +00:00
This event will not emit when the navigation is started programmatically with APIs
2014-12-17 23:15:37 +00:00
like `WebContents.loadUrl` and `WebContents.back` .
Calling `event.preventDefault()` can prevent the navigation.
2014-10-24 15:05:25 +00:00
### Event: 'crashed'
Emitted when the renderer process is crashed.
2015-05-12 19:35:56 +00:00
### Event: 'plugin-crashed'
* `event` Event
* `name` String
* `version` String
Emitted when a plugin process is crashed.
2014-10-24 15:05:25 +00:00
### Event: 'destroyed'
Emitted when the WebContents is destroyed.
2015-07-13 19:41:07 +00:00
### WebContents.session
Returns the `Session` object used by this WebContents.
2015-06-06 09:51:27 +00:00
### WebContents.loadUrl(url, [options])
2013-08-14 22:43:35 +00:00
* `url` URL
2015-06-06 09:51:27 +00:00
* `options` URL
2015-06-09 01:27:57 +00:00
* `httpReferrer` String - A HTTP Referer url
* `userAgent` String - A user agent originating the request
2013-08-14 22:43:35 +00:00
2013-08-29 14:37:51 +00:00
Loads the `url` in the window, the `url` must contains the protocol prefix,
e.g. the `http://` or `file://` .
2013-08-14 22:43:35 +00:00
2014-04-25 09:15:26 +00:00
### WebContents.getUrl()
2013-08-14 22:43:35 +00:00
Returns URL of current web page.
2014-04-25 09:15:26 +00:00
### WebContents.getTitle()
Returns the title of web page.
### WebContents.isLoading()
Returns whether web page is still loading resources.
### WebContents.isWaitingForResponse()
Returns whether web page is waiting for a first-response for the main resource
of the page.
### WebContents.stop()
Stops any pending navigation.
### WebContents.reload()
Reloads current page.
### WebContents.reloadIgnoringCache()
Reloads current page and ignores cache.
### WebContents.canGoBack()
2013-08-14 22:43:35 +00:00
Returns whether the web page can go back.
2014-04-25 09:15:26 +00:00
### WebContents.canGoForward()
2013-08-14 22:43:35 +00:00
Returns whether the web page can go forward.
2014-04-25 09:15:26 +00:00
### WebContents.canGoToOffset(offset)
2013-08-14 22:43:35 +00:00
* `offset` Integer
Returns whether the web page can go to `offset` .
2015-05-19 17:11:03 +00:00
### WebContents.clearHistory()
Clears the navigation history.
2014-04-25 09:15:26 +00:00
### WebContents.goBack()
2013-08-14 22:43:35 +00:00
Makes the web page go back.
2014-04-25 09:15:26 +00:00
### WebContents.goForward()
2013-08-14 22:43:35 +00:00
Makes the web page go forward.
2014-04-25 09:15:26 +00:00
### WebContents.goToIndex(index)
2013-08-14 22:43:35 +00:00
* `index` Integer
Navigates to the specified absolute index.
2014-04-25 09:15:26 +00:00
### WebContents.goToOffset(offset)
2013-08-14 22:43:35 +00:00
* `offset` Integer
Navigates to the specified offset from the "current entry".
2014-10-24 12:49:51 +00:00
### WebContents.isCrashed()
2014-04-25 09:15:26 +00:00
Whether the renderer process has crashed.
2014-10-24 12:57:44 +00:00
### WebContents.setUserAgent(userAgent)
* `userAgent` String
Overrides the user agent for this page.
2015-07-22 04:25:10 +00:00
### WebContents.getUserAgent()
Returns a `String` represents the user agent for this page.
2014-10-24 13:04:50 +00:00
### WebContents.insertCSS(css)
* `css` String
Injects CSS into this page.
2015-08-03 06:43:01 +00:00
### WebContents.executeJavaScript(code[, userGesture])
2014-04-25 09:15:26 +00:00
* `code` String
2015-08-03 06:43:01 +00:00
* `userGesture` Boolean
2014-04-25 09:15:26 +00:00
2015-08-03 06:43:01 +00:00
Evaluates `code` in page.
In browser some HTML APIs like `requestFullScreen` can only be invoked if it
is started by user gesture, by specifying `userGesture` to `true` developers
can ignore this limitation.
2015-01-19 20:30:28 +00:00
2015-06-15 13:40:49 +00:00
### WebContents.setAudioMuted(muted)
+ `muted` Boolean
Set the page muted.
### WebContents.isAudioMuted()
Returns whether this page has been muted.
2015-01-19 20:30:28 +00:00
### WebContents.undo()
Executes editing command `undo` in page.
### WebContents.redo()
Executes editing command `redo` in page.
### WebContents.cut()
Executes editing command `cut` in page.
### WebContents.copy()
Executes editing command `copy` in page.
### WebContents.paste()
Executes editing command `paste` in page.
2015-05-15 07:15:33 +00:00
### WebContents.pasteAndMatchStyle()
Executes editing command `pasteAndMatchStyle` in page.
2015-01-19 20:30:28 +00:00
### WebContents.delete()
Executes editing command `delete` in page.
### WebContents.selectAll()
Executes editing command `selectAll` in page.
### WebContents.unselect()
Executes editing command `unselect` in page.
### WebContents.replace(text)
* `text` String
Executes editing command `replace` in page.
### WebContents.replaceMisspelling(text)
* `text` String
Executes editing command `replaceMisspelling` in page.
2013-08-14 22:43:35 +00:00
2015-04-30 13:15:19 +00:00
### WebContents.hasServiceWorker(callback)
* `callback` Function
Checks if any serviceworker is registered and returns boolean as
response to `callback` .
### WebContents.unregisterServiceWorker(callback)
* `callback` Function
Unregisters any serviceworker if present and returns boolean as
response to `callback` when the JS promise is fullfilled or false
when the JS promise is rejected.
2015-06-13 13:23:45 +00:00
### WebContents.print([options])
* `options` Object
* `silent` Boolean - Don't ask user for print settings, defaults to `false`
* `printBackground` Boolean - Also prints the background color and image of
the web page, defaults to `false` .
Prints window's web page. When `silent` is set to `false` , Electron will pick
up system's default printer and default settings for printing.
Calling `window.print()` in web page is equivalent to call
`WebContents.print({silent: false, printBackground: false})` .
**Note:** On Windows, the print API relies on `pdf.dll` . If your application
doesn't need print feature, you can safely remove `pdf.dll` in saving binary
size.
2015-06-11 07:04:58 +00:00
### WebContents.printToPDF(options, callback)
* `options` Object
* `marginsType` Integer - Specify the type of margins to use
* 0 - default
* 1 - none
* 2 - minimum
2015-07-26 03:56:07 +00:00
* `pageSize` String - Specify page size of the generated PDF
* `A4`
* `A3`
* `Legal`
* `Letter`
* `Tabloid`
2015-06-11 07:04:58 +00:00
* `printBackground` Boolean - Whether to print CSS backgrounds.
* `printSelectionOnly` Boolean - Whether to print selection only.
* `landscape` Boolean - `true` for landscape, `false` for portrait.
* `callback` Function - `function(error, data) {}`
* `error` Error
* `data` Buffer - PDF file content
Prints windows' web page as PDF with Chromium's preview printing custom
settings.
2015-06-20 07:18:21 +00:00
By default, an empty `options` will be regarded as
2015-08-19 01:44:33 +00:00
`{marginsType:0, printBackground:false, printSelectionOnly:false,
2015-06-11 07:04:58 +00:00
landscape:false}`.
2015-06-20 07:18:21 +00:00
```javascript
var BrowserWindow = require('browser-window');
var fs = require('fs');
var win = new BrowserWindow({width: 800, height: 600});
win.loadUrl("http://github.com");
win.webContents.on("did-finish-load", function() {
// Use default printing options
win.webContents.printToPDF({}, function(error, data) {
if (error) throw error;
2015-07-26 03:56:07 +00:00
fs.writeFile("/tmp/print.pdf", data, function(error) {
2015-06-20 07:18:21 +00:00
if (err)
2015-07-26 03:56:07 +00:00
throw error;
console.log("Write PDF successfully.");
2015-06-20 07:18:21 +00:00
})
})
});
```
2015-07-24 09:39:11 +00:00
### WebContents.addWorkSpace(path)
* `path` String
Adds the specified path to devtools workspace.
### WebContents.removeWorkSpace(path)
* `path` String
Removes the specified path from devtools workspace.
2014-04-25 09:15:26 +00:00
### WebContents.send(channel[, args...])
2013-08-14 22:43:35 +00:00
2014-04-25 09:15:26 +00:00
* `channel` String
2013-08-14 22:43:35 +00:00
2014-04-25 09:15:26 +00:00
Send `args..` to the web page via `channel` in asynchronous message, the web
page can handle it by listening to the `channel` event of `ipc` module.
2014-05-07 01:45:39 +00:00
2015-03-26 15:20:31 +00:00
An example of sending messages from the main process to the renderer process:
2014-05-07 01:45:39 +00:00
```javascript
2015-03-26 15:20:31 +00:00
// On the main process.
2014-05-07 01:45:39 +00:00
var window = null;
app.on('ready', function() {
window = new BrowserWindow({width: 800, height: 600});
window.loadUrl('file://' + __dirname + '/index.html');
2014-05-07 23:32:02 +00:00
window.webContents.on('did-finish-load', function() {
2014-05-07 01:45:39 +00:00
window.webContents.send('ping', 'whoooooooh!');
});
});
```
```html
// index.html
< html >
< body >
< script >
require('ipc').on('ping', function(message) {
console.log(message); // Prints "whoooooooh!"
});
< / script >
< / body >
< / html >
```
**Note:**
2014-05-07 01:47:58 +00:00
2014-05-07 01:45:39 +00:00
1. The IPC message handler in web pages do not have a `event` parameter, which
2015-03-26 15:20:31 +00:00
is different from the handlers on the main process.
2. There is no way to send synchronous messages from the main process to a
renderer process, because it would be very easy to cause dead locks.
2015-06-16 09:23:29 +00:00
2015-07-02 14:12:18 +00:00
## Class: Session
### Session.cookies
2015-06-16 09:23:29 +00:00
The `cookies` gives you ability to query and modify cookies, an example is:
2015-07-12 02:46:26 +00:00
```javascript
2015-06-16 09:23:29 +00:00
var BrowserWindow = require('browser-window');
var win = new BrowserWindow({ width: 800, height: 600 });
win.loadUrl('https://github.com');
win.webContents.on('did-finish-load', function() {
// Query all cookies.
win.webContents.session.cookies.get({}, function(error, cookies) {
if (error) throw error;
console.log(cookies);
});
// Query all cookies that are associated with a specific url.
win.webContents.session.cookies.get({ url : "http://www.github.com" },
function(error, cookies) {
if (error) throw error;
console.log(cookies);
});
// Set a cookie with the given cookie data;
// may overwrite equivalent cookies if they exist.
win.webContents.session.cookies.set(
{ url : "http://www.github.com", name : "dummy_name", value : "dummy"},
function(error, cookies) {
if (error) throw error;
console.log(cookies);
});
});
```
2015-07-02 14:12:18 +00:00
### Session.cookies.get(details, callback)
2015-06-16 09:23:29 +00:00
* `details` Object
* `url` String - Retrieves cookies which are associated with `url` .
Empty imples retrieving cookies of all urls.
* `name` String - Filters cookies by name
* `domain` String - Retrieves cookies whose domains match or are subdomains of `domains`
* `path` String - Retrieves cookies whose path matches `path`
* `secure` Boolean - Filters cookies by their Secure property
* `session` Boolean - Filters out session or persistent cookies.
* `callback` Function - function(error, cookies)
* `error` Error
2015-06-19 06:18:22 +00:00
* `cookies` Array - array of `cookie` objects.
* `cookie` - Object
* `name` String - The name of the cookie
* `value` String - The value of the cookie
* `domain` String - The domain of the cookie
* `host_only` String - Whether the cookie is a host-only cookie
* `path` String - The path of the cookie
* `secure` Boolean - Whether the cookie is marked as Secure (typically HTTPS)
* `http_only` Boolean - Whether the cookie is marked as HttpOnly
* `session` Boolean - Whether the cookie is a session cookie or a persistent
2015-06-26 02:47:50 +00:00
cookie with an expiration date.
2015-06-19 06:18:22 +00:00
* `expirationDate` Double - (Option) The expiration date of the cookie as
2015-06-26 02:47:50 +00:00
the number of seconds since the UNIX epoch. Not provided for session cookies.
2015-06-19 06:18:22 +00:00
2015-06-16 09:23:29 +00:00
2015-07-02 14:12:18 +00:00
### Session.cookies.set(details, callback)
2015-06-16 09:23:29 +00:00
* `details` Object
* `url` String - Retrieves cookies which are associated with `url`
* `name` String - The name of the cookie. Empty by default if omitted.
* `value` String - The value of the cookie. Empty by default if omitted.
* `domain` String - The domain of the cookie. Empty by default if omitted.
* `path` String - The path of the cookie. Empty by default if omitted.
* `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to false.
* `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults to false.
* `expirationDate` Double - The expiration date of the cookie as the number of
seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie.
* `callback` Function - function(error)
* `error` Error
2015-07-02 14:12:18 +00:00
### Session.cookies.remove(details, callback)
2015-06-16 09:23:29 +00:00
* `details` Object
* `url` String - The URL associated with the cookie
* `name` String - The name of cookie to remove
* `callback` Function - function(error)
* `error` Error
2015-07-02 14:12:18 +00:00
2015-07-13 22:13:17 +00:00
### Session.clearCache(callback)
2015-07-02 14:12:18 +00:00
2015-07-13 22:13:17 +00:00
* `callback` Function - Called when operation is done
2015-07-02 14:12:18 +00:00
2015-07-13 22:13:17 +00:00
Clears the session's HTTP cache.
2015-07-02 14:12:18 +00:00
2015-07-13 22:13:17 +00:00
### Session.clearStorageData([options, ]callback)
2015-07-02 14:12:18 +00:00
2015-07-13 22:13:17 +00:00
* `options` Object
* `origin` String - Should follow `window.location.origin` 's representation
`scheme://host:port`
* `storages` Array - The types of storages to clear, can contain:
`appcache` , `cookies` , `filesystem` , `indexdb` , `localstorage` ,
`shadercache` , `websql` , `serviceworkers`
* `quotas` Array - The types of quotas to clear, can contain:
`temporary` , `persistent` , `syncable`
* `callback` Function - Called when operation is done
Clears the data of web storages.
2015-07-16 14:36:48 +00:00
### Session.setProxy(config, callback)
* `config` String
* `callback` Function - Called when operation is done
Parses the `config` indicating which proxies to use for the session.
```
config = scheme-proxies[";"< scheme-proxies > ]
scheme-proxies = [< url-scheme > "="]< proxy-uri-list >
url-scheme = "http" | "https" | "ftp" | "socks"
proxy-uri-list = < proxy-uri > [","< proxy-uri-list > ]
proxy-uri = [< proxy-scheme > "://"]< proxy-host > [":"< proxy-port > ]
For example:
"http=foopy:80;ftp=foopy2" -- use HTTP proxy "foopy:80" for http://
URLs, and HTTP proxy "foopy2:80" for
ftp:// URLs.
"foopy:80" -- use HTTP proxy "foopy:80" for all URLs.
"foopy:80,bar,direct://" -- use HTTP proxy "foopy:80" for all URLs,
failing over to "bar" if "foopy:80" is
unavailable, and after that using no
proxy.
"socks4://foopy" -- use SOCKS v4 proxy "foopy:1080" for all
URLs.
"http=foopy,socks5://bar.com -- use HTTP proxy "foopy" for http URLs,
and fail over to the SOCKS5 proxy
"bar.com" if "foopy" is unavailable.
"http=foopy,direct:// -- use HTTP proxy "foopy" for http URLs,
and use no proxy if "foopy" is
unavailable.
"http=foopy;socks=foopy2 -- use HTTP proxy "foopy" for http URLs,
and use socks4://foopy2 for all other
URLs.
```
2015-07-26 08:52:02 +00:00
### Session.setDownloadPath(path)
* `path` String - The download location
2015-07-29 06:13:28 +00:00
Sets download saving directory. By default, the download directory will be the
`Downloads` under the respective app folder.
2015-08-20 13:17:53 +00:00
=======
>>>>>>> Break out methods, standardize