electron.d.ts 312.3 KB
Newer Older
B
Benjamin Pasero 已提交
1
// Type definitions for Electron 3.1.6
2
// Project: http://electronjs.org/
3 4
// Definitions by: The Electron Team <https://github.com/electron/electron>
// Definitions: https://github.com/electron/electron-typescript-definitions
B
Benjamin Pasero 已提交
5

6
/// <reference types="node" />
B
Benjamin Pasero 已提交
7

8 9
type GlobalEvent = Event;

B
Benjamin Pasero 已提交
10
declare namespace Electron {
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
	class EventEmitter {
		addListener(event: string, listener: Function): this;
		on(event: string, listener: Function): this;
		once(event: string, listener: Function): this;
		removeListener(event: string, listener: Function): this;
		removeAllListeners(event?: string): this;
		setMaxListeners(n: number): this;
		getMaxListeners(): number;
		listeners(event: string): Function[];
		emit(event: string, ...args: any[]): boolean;
		listenerCount(type: string): number;
		prependListener(event: string, listener: Function): this;
		prependOnceListener(event: string, listener: Function): this;
		eventNames(): string[];
	}

	class Accelerator extends String {
B
Benjamin Pasero 已提交
28 29 30

	}

B
Benjamin Pasero 已提交
31 32 33 34 35 36 37 38 39
	interface Event extends GlobalEvent {
		preventDefault: () => void;
		sender: WebContents;
		returnValue: any;
		ctrlKey?: boolean;
		metaKey?: boolean;
		shiftKey?: boolean;
		altKey?: boolean;
	}
B
Benjamin Pasero 已提交
40

41
	interface CommonInterface {
B
Benjamin Pasero 已提交
42 43 44 45 46
		clipboard: Clipboard;
		crashReporter: CrashReporter;
		nativeImage: typeof NativeImage;
		screen: Screen;
		shell: Shell;
B
Benjamin Pasero 已提交
47 48
	}

49
	interface MainInterface extends CommonInterface {
B
Benjamin Pasero 已提交
50 51 52 53 54 55 56 57 58 59 60
		app: App;
		autoUpdater: AutoUpdater;
		BrowserView: typeof BrowserView;
		BrowserWindow: typeof BrowserWindow;
		ClientRequest: typeof ClientRequest;
		contentTracing: ContentTracing;
		Cookies: typeof Cookies;
		Debugger: typeof Debugger;
		dialog: Dialog;
		DownloadItem: typeof DownloadItem;
		globalShortcut: GlobalShortcut;
61
		inAppPurchase: InAppPurchase;
B
Benjamin Pasero 已提交
62 63 64 65 66
		IncomingMessage: typeof IncomingMessage;
		ipcMain: IpcMain;
		Menu: typeof Menu;
		MenuItem: typeof MenuItem;
		net: Net;
67
		netLog: NetLog;
B
Benjamin Pasero 已提交
68 69 70 71 72 73 74 75 76 77
		Notification: typeof Notification;
		powerMonitor: PowerMonitor;
		powerSaveBlocker: PowerSaveBlocker;
		protocol: Protocol;
		session: typeof Session;
		systemPreferences: SystemPreferences;
		TouchBar: typeof TouchBar;
		Tray: typeof Tray;
		webContents: typeof WebContents;
		WebRequest: typeof WebRequest;
B
Benjamin Pasero 已提交
78 79
	}

80
	interface RendererInterface extends CommonInterface {
B
Benjamin Pasero 已提交
81 82 83 84 85 86 87 88
		BrowserWindowProxy: typeof BrowserWindowProxy;
		desktopCapturer: DesktopCapturer;
		ipcRenderer: IpcRenderer;
		remote: Remote;
		webFrame: WebFrame;
		webviewTag: WebviewTag;
	}

89
	interface AllElectron extends MainInterface, RendererInterface { }
B
Benjamin Pasero 已提交
90 91 92 93 94 95 96 97 98

	const app: App;
	const autoUpdater: AutoUpdater;
	const clipboard: Clipboard;
	const contentTracing: ContentTracing;
	const crashReporter: CrashReporter;
	const desktopCapturer: DesktopCapturer;
	const dialog: Dialog;
	const globalShortcut: GlobalShortcut;
99
	const inAppPurchase: InAppPurchase;
B
Benjamin Pasero 已提交
100 101 102 103 104
	const ipcMain: IpcMain;
	const ipcRenderer: IpcRenderer;
	type nativeImage = NativeImage;
	const nativeImage: typeof NativeImage;
	const net: Net;
105
	const netLog: NetLog;
B
Benjamin Pasero 已提交
106 107 108
	const powerMonitor: PowerMonitor;
	const powerSaveBlocker: PowerSaveBlocker;
	const protocol: Protocol;
109
	// const remote: Remote; ### VSCODE CHANGE (we do not want to use remote)
B
Benjamin Pasero 已提交
110 111 112 113 114 115 116 117 118
	const screen: Screen;
	type session = Session;
	const session: typeof Session;
	const shell: Shell;
	const systemPreferences: SystemPreferences;
	type webContents = WebContents;
	const webContents: typeof WebContents;
	const webFrame: WebFrame;
	const webviewTag: WebviewTag;
119

120 121 122
	interface App extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/app
B
Benjamin Pasero 已提交
123

B
Benjamin Pasero 已提交
124
		/**
125 126 127 128
		 * 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.
B
Benjamin Pasero 已提交
129
		 */
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
		on(event: 'accessibility-support-changed', listener: (event: Event,
			/**
			 * `true` when Chrome's accessibility support is enabled, `false` otherwise.
			 */
			accessibilitySupportEnabled: boolean) => void): this;
		once(event: 'accessibility-support-changed', listener: (event: Event,
			/**
			 * `true` when Chrome's accessibility support is enabled, `false` otherwise.
			 */
			accessibilitySupportEnabled: boolean) => void): this;
		addListener(event: 'accessibility-support-changed', listener: (event: Event,
			/**
			 * `true` when Chrome's accessibility support is enabled, `false` otherwise.
			 */
			accessibilitySupportEnabled: boolean) => void): this;
		removeListener(event: 'accessibility-support-changed', listener: (event: Event,
			/**
			 * `true` when Chrome's accessibility support is enabled, `false` otherwise.
			 */
			accessibilitySupportEnabled: boolean) => void): this;
		/**
		 * 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.
		 */
		on(event: 'activate', listener: (event: Event,
			hasVisibleWindows: boolean) => void): this;
		once(event: 'activate', listener: (event: Event,
			hasVisibleWindows: boolean) => void): this;
		addListener(event: 'activate', listener: (event: Event,
			hasVisibleWindows: boolean) => void): this;
		removeListener(event: 'activate', listener: (event: Event,
			hasVisibleWindows: boolean) => void): this;
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
		/**
		 * Emitted during Handoff after an activity from this device was successfully
		 * resumed on another one.
		 */
		on(event: 'activity-was-continued', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity.
			 */
			userInfo: any) => void): this;
		once(event: 'activity-was-continued', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity.
			 */
			userInfo: any) => void): this;
		addListener(event: 'activity-was-continued', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity.
			 */
			userInfo: any) => void): this;
		removeListener(event: 'activity-was-continued', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity.
			 */
			userInfo: any) => void): this;
204 205 206 207 208
		/**
		 * Emitted before the application starts closing its windows. Calling
		 * event.preventDefault() will prevent the default behaviour, which is terminating
		 * the application. Note: If application quit was initiated by
		 * autoUpdater.quitAndInstall() then before-quit is emitted after emitting close
209 210 211
		 * 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.
B
Benjamin Pasero 已提交
212
		 */
B
Benjamin Pasero 已提交
213
		on(event: 'before-quit', listener: (event: Event) => void): this;
214 215 216
		once(event: 'before-quit', listener: (event: Event) => void): this;
		addListener(event: 'before-quit', listener: (event: Event) => void): this;
		removeListener(event: 'before-quit', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
217
		/**
B
Benjamin Pasero 已提交
218
		 * Emitted when a browserWindow gets blurred.
B
Benjamin Pasero 已提交
219
		 */
220 221 222 223 224 225 226 227
		on(event: 'browser-window-blur', listener: (event: Event,
			window: BrowserWindow) => void): this;
		once(event: 'browser-window-blur', listener: (event: Event,
			window: BrowserWindow) => void): this;
		addListener(event: 'browser-window-blur', listener: (event: Event,
			window: BrowserWindow) => void): this;
		removeListener(event: 'browser-window-blur', listener: (event: Event,
			window: BrowserWindow) => void): this;
B
Benjamin Pasero 已提交
228
		/**
B
Benjamin Pasero 已提交
229
		 * Emitted when a new browserWindow is created.
B
Benjamin Pasero 已提交
230
		 */
231 232 233 234 235 236 237 238
		on(event: 'browser-window-created', listener: (event: Event,
			window: BrowserWindow) => void): this;
		once(event: 'browser-window-created', listener: (event: Event,
			window: BrowserWindow) => void): this;
		addListener(event: 'browser-window-created', listener: (event: Event,
			window: BrowserWindow) => void): this;
		removeListener(event: 'browser-window-created', listener: (event: Event,
			window: BrowserWindow) => void): this;
B
Benjamin Pasero 已提交
239
		/**
240
		 * Emitted when a browserWindow gets focused.
B
Benjamin Pasero 已提交
241
		 */
242 243 244 245 246 247 248 249
		on(event: 'browser-window-focus', listener: (event: Event,
			window: BrowserWindow) => void): this;
		once(event: 'browser-window-focus', listener: (event: Event,
			window: BrowserWindow) => void): this;
		addListener(event: 'browser-window-focus', listener: (event: Event,
			window: BrowserWindow) => void): this;
		removeListener(event: 'browser-window-focus', listener: (event: Event,
			window: BrowserWindow) => void): this;
B
Benjamin Pasero 已提交
250
		/**
B
Benjamin Pasero 已提交
251
		 * Emitted when failed to verify the certificate for url, to trust the certificate
252 253
		 * you should prevent the default behavior with event.preventDefault() and call
		 * callback(true).
B
Benjamin Pasero 已提交
254
		 */
B
Benjamin Pasero 已提交
255 256 257
		on(event: 'certificate-error', listener: (event: Event,
			webContents: WebContents,
			url: string,
258 259 260
			/**
			 * The error code
			 */
B
Benjamin Pasero 已提交
261 262
			error: string,
			certificate: Certificate,
263 264
			callback: (isTrusted: boolean) => void) => void): this;
		once(event: 'certificate-error', listener: (event: Event,
B
Benjamin Pasero 已提交
265 266
			webContents: WebContents,
			url: string,
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
			/**
			 * The error code
			 */
			error: string,
			certificate: Certificate,
			callback: (isTrusted: boolean) => void) => void): this;
		addListener(event: 'certificate-error', listener: (event: Event,
			webContents: WebContents,
			url: string,
			/**
			 * The error code
			 */
			error: string,
			certificate: Certificate,
			callback: (isTrusted: boolean) => void) => void): this;
		removeListener(event: 'certificate-error', listener: (event: Event,
			webContents: WebContents,
			url: string,
			/**
			 * The error code
			 */
			error: string,
			certificate: Certificate,
			callback: (isTrusted: boolean) => void) => void): this;
B
Benjamin Pasero 已提交
291
		/**
292 293 294 295 296 297
		 * 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.
B
Benjamin Pasero 已提交
298
		 */
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
		on(event: 'continue-activity', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity on another device.
			 */
			userInfo: any) => void): this;
		once(event: 'continue-activity', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity on another device.
			 */
			userInfo: any) => void): this;
		addListener(event: 'continue-activity', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity on another device.
			 */
			userInfo: any) => void): this;
		removeListener(event: 'continue-activity', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity on another device.
			 */
			userInfo: any) => void): this;
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
		/**
		 * Emitted during Handoff when an activity from a different device fails to be
		 * resumed.
		 */
		on(event: 'continue-activity-error', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * A string with the error's localized description.
			 */
			error: string) => void): this;
		once(event: 'continue-activity-error', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * A string with the error's localized description.
			 */
			error: string) => void): this;
		addListener(event: 'continue-activity-error', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * A string with the error's localized description.
			 */
			error: string) => void): this;
		removeListener(event: 'continue-activity-error', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * A string with the error's localized description.
			 */
			error: string) => void): this;
B
Benjamin Pasero 已提交
375
		/**
376
		 * Emitted when the gpu process crashes or is killed.
B
Benjamin Pasero 已提交
377
		 */
378 379 380 381 382 383 384 385
		on(event: 'gpu-process-crashed', listener: (event: Event,
			killed: boolean) => void): this;
		once(event: 'gpu-process-crashed', listener: (event: Event,
			killed: boolean) => void): this;
		addListener(event: 'gpu-process-crashed', listener: (event: Event,
			killed: boolean) => void): this;
		removeListener(event: 'gpu-process-crashed', listener: (event: Event,
			killed: boolean) => void): this;
B
Benjamin Pasero 已提交
386
		/**
387 388 389 390
		 * Emitted when webContents 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.
B
Benjamin Pasero 已提交
391
		 */
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
		on(event: 'login', listener: (event: Event,
			webContents: WebContents,
			request: Request,
			authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		once(event: 'login', listener: (event: Event,
			webContents: WebContents,
			request: Request,
			authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		addListener(event: 'login', listener: (event: Event,
			webContents: WebContents,
			request: Request,
			authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		removeListener(event: 'login', listener: (event: Event,
			webContents: WebContents,
			request: Request,
			authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
B
Benjamin Pasero 已提交
412
		/**
B
Benjamin Pasero 已提交
413 414 415
		 * 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
		 */
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
		on(event: 'new-window-for-tab', listener: (event: Event) => void): this;
		once(event: 'new-window-for-tab', listener: (event: Event) => void): this;
		addListener(event: 'new-window-for-tab', listener: (event: Event) => void): this;
		removeListener(event: 'new-window-for-tab', listener: (event: Event) => void): this;
		/**
		 * 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.
		 */
		on(event: 'open-file', listener: (event: Event,
			path: string) => void): this;
		once(event: 'open-file', listener: (event: Event,
			path: string) => void): this;
		addListener(event: 'open-file', listener: (event: Event,
			path: string) => void): this;
		removeListener(event: 'open-file', listener: (event: Event,
			path: string) => void): this;
		/**
		 * 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. You should
		 * call event.preventDefault() if you want to handle this event.
		 */
		on(event: 'open-url', listener: (event: Event,
			url: string) => void): this;
		once(event: 'open-url', listener: (event: Event,
			url: string) => void): this;
		addListener(event: 'open-url', listener: (event: Event,
			url: string) => void): this;
		removeListener(event: 'open-url', listener: (event: Event,
			url: string) => void): this;
B
Benjamin Pasero 已提交
452
		/**
453 454 455
		 * 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.
B
Benjamin Pasero 已提交
456
		 */
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
		on(event: 'quit', listener: (event: Event,
			exitCode: number) => void): this;
		once(event: 'quit', listener: (event: Event,
			exitCode: number) => void): this;
		addListener(event: 'quit', listener: (event: Event,
			exitCode: number) => void): this;
		removeListener(event: 'quit', listener: (event: Event,
			exitCode: number) => void): this;
		/**
		 * Emitted when Electron has finished initializing. On macOS, launchInfo holds the
		 * userInfo of the NSUserNotification that was used to open the application, if it
		 * was launched from Notification Center. You can call app.isReady() to check if
		 * this event has already fired.
		 */
		on(event: 'ready', listener: (launchInfo: any) => void): this;
		once(event: 'ready', listener: (launchInfo: any) => void): this;
		addListener(event: 'ready', listener: (launchInfo: any) => void): this;
		removeListener(event: 'ready', listener: (launchInfo: any) => void): this;
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
		/**
		 * This event will be emitted inside the primary instance of your application 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. This event is guaranteed to be emitted after the ready event of
		 * app gets emitted.
		 */
		on(event: 'second-instance', listener: (event: Event,
			/**
			 * An array of the second instance's command line arguments
			 */
			argv: string[],
			/**
			 * The second instance's working directory
			 */
			workingDirectory: string) => void): this;
		once(event: 'second-instance', listener: (event: Event,
			/**
			 * An array of the second instance's command line arguments
			 */
			argv: string[],
			/**
			 * The second instance's working directory
			 */
			workingDirectory: string) => void): this;
		addListener(event: 'second-instance', listener: (event: Event,
			/**
			 * An array of the second instance's command line arguments
			 */
			argv: string[],
			/**
			 * The second instance's working directory
			 */
			workingDirectory: string) => void): this;
		removeListener(event: 'second-instance', listener: (event: Event,
			/**
			 * An array of the second instance's command line arguments
			 */
			argv: string[],
			/**
			 * The second instance's working directory
			 */
			workingDirectory: string) => void): this;
519 520 521 522 523
		/**
		 * 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.
B
Benjamin Pasero 已提交
524
		 */
525
		on(event: 'select-client-certificate', listener: (event: Event,
B
Benjamin Pasero 已提交
526 527
			webContents: WebContents,
			url: string,
528 529 530
			certificateList: Certificate[],
			callback: (certificate?: Certificate) => void) => void): this;
		once(event: 'select-client-certificate', listener: (event: Event,
B
Benjamin Pasero 已提交
531 532 533
			webContents: WebContents,
			url: string,
			certificateList: Certificate[],
534 535 536 537 538 539 540
			callback: (certificate?: Certificate) => void) => void): this;
		addListener(event: 'select-client-certificate', listener: (event: Event,
			webContents: WebContents,
			url: string,
			certificateList: Certificate[],
			callback: (certificate?: Certificate) => void) => void): this;
		removeListener(event: 'select-client-certificate', listener: (event: Event,
B
Benjamin Pasero 已提交
541
			webContents: WebContents,
542 543 544
			url: string,
			certificateList: Certificate[],
			callback: (certificate?: Certificate) => void) => void): this;
545 546 547 548 549 550 551
		/**
		 * Emitted when Electron has created a new session.
		 */
		on(event: 'session-created', listener: (session: Session) => void): this;
		once(event: 'session-created', listener: (session: Session) => void): this;
		addListener(event: 'session-created', listener: (session: Session) => void): this;
		removeListener(event: 'session-created', listener: (session: Session) => void): this;
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
		/**
		 * 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.updateCurrentActiviy() in a timely manner. Otherwise the operation will fail
		 * and continue-activity-error will be called.
		 */
		on(event: 'update-activity-state', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity.
			 */
			userInfo: any) => void): this;
		once(event: 'update-activity-state', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity.
			 */
			userInfo: any) => void): this;
		addListener(event: 'update-activity-state', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity.
			 */
			userInfo: any) => void): this;
		removeListener(event: 'update-activity-state', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string,
			/**
			 * Contains app-specific state stored by the activity.
			 */
			userInfo: any) => void): this;
B
Benjamin Pasero 已提交
595
		/**
596
		 * Emitted when a new webContents is created.
B
Benjamin Pasero 已提交
597
		 */
598 599 600 601 602 603 604 605
		on(event: 'web-contents-created', listener: (event: Event,
			webContents: WebContents) => void): this;
		once(event: 'web-contents-created', listener: (event: Event,
			webContents: WebContents) => void): this;
		addListener(event: 'web-contents-created', listener: (event: Event,
			webContents: WebContents) => void): this;
		removeListener(event: 'web-contents-created', listener: (event: Event,
			webContents: WebContents) => void): this;
606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
		/**
		 * 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.
		 */
		on(event: 'will-continue-activity', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string) => void): this;
		once(event: 'will-continue-activity', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string) => void): this;
		addListener(event: 'will-continue-activity', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string) => void): this;
		removeListener(event: 'will-continue-activity', listener: (event: Event,
			/**
			 * A string identifying the activity. Maps to .
			 */
			type: string) => void): this;
631 632 633 634 635 636
		/**
		 * 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. You would usually set up listeners for the open-file and open-url
		 * events here, and start the crash reporter and auto updater. In most cases, you
637
		 * should do everything in the ready event handler.
B
Benjamin Pasero 已提交
638
		 */
639 640 641 642
		on(event: 'will-finish-launching', listener: Function): this;
		once(event: 'will-finish-launching', listener: Function): this;
		addListener(event: 'will-finish-launching', listener: Function): this;
		removeListener(event: 'will-finish-launching', listener: Function): this;
B
Benjamin Pasero 已提交
643
		/**
644 645 646
		 * 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. See the description of the window-all-closed event for the
647 648 649
		 * 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.
650
		 */
651 652 653 654
		on(event: 'will-quit', listener: (event: Event) => void): this;
		once(event: 'will-quit', listener: (event: Event) => void): this;
		addListener(event: 'will-quit', listener: (event: Event) => void): this;
		removeListener(event: 'will-quit', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
655
		/**
656 657 658 659 660 661
		 * 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.
B
Benjamin Pasero 已提交
662
		 */
663 664 665 666
		on(event: 'window-all-closed', listener: Function): this;
		once(event: 'window-all-closed', listener: Function): this;
		addListener(event: 'window-all-closed', listener: Function): this;
		removeListener(event: 'window-all-closed', listener: Function): this;
B
Benjamin Pasero 已提交
667
		/**
668 669 670
		 * 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.
B
Benjamin Pasero 已提交
671
		 */
672
		addRecentDocument(path: string): void;
B
Benjamin Pasero 已提交
673
		/**
674
		 * Clears the recent documents list.
B
Benjamin Pasero 已提交
675
		 */
676
		clearRecentDocuments(): void;
B
Benjamin Pasero 已提交
677
		/**
B
Benjamin Pasero 已提交
678 679 680
		 * 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
		 * behaviour. This method can only be called before app is ready.
B
Benjamin Pasero 已提交
681
		 */
B
Benjamin Pasero 已提交
682
		disableDomainBlockingFor3DAPIs(): void;
B
Benjamin Pasero 已提交
683
		/**
684 685
		 * Disables hardware acceleration for current app. This method can only be called
		 * before app is ready.
B
Benjamin Pasero 已提交
686
		 */
687
		disableHardwareAcceleration(): void;
B
Benjamin Pasero 已提交
688
		/**
B
Benjamin Pasero 已提交
689 690
		 * Enables mixed sandbox mode on the app. This method can only be called before app
		 * is ready.
B
Benjamin Pasero 已提交
691
		 */
B
Benjamin Pasero 已提交
692
		enableMixedSandbox(): void;
B
Benjamin Pasero 已提交
693
		/**
694
		 * Exits immediately with exitCode. exitCode defaults to 0. All windows will be
695 696
		 * closed immediately without asking user and the before-quit and will-quit events
		 * will not be emitted.
B
Benjamin Pasero 已提交
697
		 */
698
		exit(exitCode?: number): void;
B
Benjamin Pasero 已提交
699
		/**
700 701
		 * On Linux, focuses on the first visible window. On macOS, makes the application
		 * the active app. On Windows, focuses on the application's first window.
B
Benjamin Pasero 已提交
702
		 */
703 704
		focus(): void;
		getAppMetrics(): ProcessMetric[];
B
Benjamin Pasero 已提交
705
		getAppPath(): string;
706 707
		getBadgeCount(): number;
		getCurrentActivityType(): string;
B
Benjamin Pasero 已提交
708
		/**
709 710
		 * Fetches a path's associated icon. On Windows, there a 2 kinds of icons: On Linux
		 * and macOS, icons depend on the application associated with file mime type.
B
Benjamin Pasero 已提交
711
		 */
712
		getFileIcon(path: string, options: FileIconOptions, callback: (error: Error, icon: NativeImage) => void): void;
B
Benjamin Pasero 已提交
713
		/**
714 715
		 * Fetches a path's associated icon. On Windows, there a 2 kinds of icons: On Linux
		 * and macOS, icons depend on the application associated with file mime type.
B
Benjamin Pasero 已提交
716
		 */
717
		getFileIcon(path: string, callback: (error: Error, icon: NativeImage) => void): void;
718
		getGPUFeatureStatus(): GPUFeatureStatus;
719
		getJumpListSettings(): JumpListSettings;
B
Benjamin Pasero 已提交
720
		/**
721 722 723 724
		 * 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: On Windows you have to call it after the
		 * ready events gets emitted.
B
Benjamin Pasero 已提交
725
		 */
726
		getLocale(): string;
B
Benjamin Pasero 已提交
727
		/**
728
		 * If you provided path and args options to app.setLoginItemSettings then you need
729
		 * to pass the same arguments here for openAtLogin to be set correctly.
B
Benjamin Pasero 已提交
730
		 */
731
		getLoginItemSettings(options?: LoginItemSettingsOptions): LoginItemSettings;
B
Benjamin Pasero 已提交
732
		/**
B
Benjamin Pasero 已提交
733
		 * Usually the name field of package.json is a short lowercased name, according to
734 735
		 * 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
B
Benjamin Pasero 已提交
736
		 * name by Electron.
B
Benjamin Pasero 已提交
737
		 */
B
Benjamin Pasero 已提交
738
		getName(): string;
B
Benjamin Pasero 已提交
739
		/**
740
		 * You can request the following paths by the name:
B
Benjamin Pasero 已提交
741
		 */
742 743
		getPath(name: string): string;
		getVersion(): string;
744 745 746 747 748 749
		/**
		 * 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()
		 */
		hasSingleInstanceLock(): boolean;
B
Benjamin Pasero 已提交
750
		/**
751
		 * Hides all application windows without minimizing them.
B
Benjamin Pasero 已提交
752
		 */
753
		hide(): void;
B
Benjamin Pasero 已提交
754
		/**
755 756 757 758
		 * 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.
B
Benjamin Pasero 已提交
759
		 */
760
		importCertificate(options: ImportCertificateOptions, callback: (result: number) => void): void;
761 762 763 764
		/**
		 * Invalidates the current Handoff user activity.
		 */
		invalidateCurrentActivity(type: string): void;
765
		isAccessibilitySupportEnabled(): boolean;
B
Benjamin Pasero 已提交
766
		/**
767 768 769 770 771 772 773
		 * This method checks if the current executable is the default handler for a
		 * protocol (aka URI scheme). If so, it will return true. Otherwise, it will return
		 * false. 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.
B
Benjamin Pasero 已提交
774
		 */
B
Benjamin Pasero 已提交
775
		isDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean;
776
		isInApplicationsFolder(): boolean;
777 778
		isReady(): boolean;
		isUnityRunning(): boolean;
779 780 781 782 783 784 785 786 787
		/**
		 * 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
		 */
		moveToApplicationsFolder(): boolean;
788 789 790 791 792 793 794
		/**
		 * 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.
B
Benjamin Pasero 已提交
795
		 */
796
		quit(): void;
B
Benjamin Pasero 已提交
797
		/**
798 799 800 801 802 803 804 805 806 807
		 * 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:
B
Benjamin Pasero 已提交
808
		 */
809
		relaunch(options?: RelaunchOptions): void;
B
Benjamin Pasero 已提交
810
		/**
811 812
		 * Releases all locks that were created by requestSingleInstanceLock. This will
		 * allow multiple instances of the application to once again run side by side.
B
Benjamin Pasero 已提交
813
		 */
814
		releaseSingleInstanceLock(): void;
B
Benjamin Pasero 已提交
815
		/**
816 817
		 * 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.
B
Benjamin Pasero 已提交
818
		 */
819
		removeAsDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean;
820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
		/**
		 * 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. 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:
		 */
		requestSingleInstanceLock(): boolean;
B
Benjamin Pasero 已提交
839
		/**
840 841
		 * Set the about panel options. This will override the values defined in the app's
		 * .plist file. See the Apple docs for more details.
B
Benjamin Pasero 已提交
842
		 */
843
		setAboutPanelOptions(options: AboutPanelOptionsOptions): void;
844 845 846 847 848 849 850 851 852
		/**
		 * Manually enables Chrome's accessibility support, allowing to expose
		 * accessibility switch to users in application settings.
		 * https://www.chromium.org/developers/design-documents/accessibility for more
		 * details. Disabled by default. Note: Rendering accessibility tree can
		 * significantly affect the performance of your app. It should not be enabled by
		 * default.
		 */
		setAccessibilitySupportEnabled(enabled: boolean): void;
B
Benjamin Pasero 已提交
853
		/**
B
Benjamin Pasero 已提交
854
		 * Changes the Application User Model ID to id.
B
Benjamin Pasero 已提交
855
		 */
B
Benjamin Pasero 已提交
856
		setAppUserModelId(id: string): void;
B
Benjamin Pasero 已提交
857
		/**
858 859 860 861 862 863 864 865 866 867 868 869
		 * 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
		 * 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. On Windows you can provide optional parameters path,
		 * the path to your executable, and args, an array of arguments to be passed to
		 * your executable when it launches. Note: On macOS, you can only register
		 * protocols that have been added to 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 for details.
		 * The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme
		 * internally.
B
Benjamin Pasero 已提交
870
		 */
871
		setAsDefaultProtocolClient(protocol: string, path?: string, args?: string[]): boolean;
B
Benjamin Pasero 已提交
872
		/**
873 874 875 876
		 * 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 the existence of a .desktop file to
		 * work, for more information please read Desktop Environment Integration.
B
Benjamin Pasero 已提交
877
		 */
878
		setBadgeCount(count: number): boolean;
B
Benjamin Pasero 已提交
879
		/**
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
		 * Sets or removes a custom Jump List for the application, and returns one of the
		 * following strings: 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:
		 */
		setJumpList(categories: JumpListCategory[]): void;
		/**
		 * 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 Update.exe,
898
		 * and pass arguments that specify your application name. For example:
899
		 */
B
Benjamin Pasero 已提交
900
		setLoginItemSettings(settings: Settings): void;
B
Benjamin Pasero 已提交
901
		/**
902
		 * Overrides the current application's name.
B
Benjamin Pasero 已提交
903
		 */
904
		setName(name: string): void;
B
Benjamin Pasero 已提交
905
		/**
906 907 908 909 910 911 912
		 * Overrides the path to a special directory or file associated with name. If the
		 * path specifies a directory that does not exist, the directory will be created by
		 * this method. On failure an Error is thrown. You can only override paths of a
		 * name defined in app.getPath. By default, web pages' cookies and caches will be
		 * stored under the userData 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.
B
Benjamin Pasero 已提交
913
		 */
914
		setPath(name: string, path: string): void;
B
Benjamin Pasero 已提交
915
		/**
916 917
		 * Creates an NSUserActivity and sets it as the current activity. The activity is
		 * eligible for Handoff to another device afterward.
B
Benjamin Pasero 已提交
918
		 */
919
		setUserActivity(type: string, userInfo: any, webpageURL?: string): void;
920
		/**
921 922 923
		 * Adds tasks to the Tasks category of the JumpList on Windows. tasks is an array
		 * of Task objects. Note: If you'd like to customize the Jump List even more use
		 * app.setJumpList(categories) instead.
924
		 */
925
		setUserTasks(tasks: Task[]): boolean;
B
Benjamin Pasero 已提交
926
		/**
927 928
		 * Shows application windows after they were hidden. Does not automatically focus
		 * them.
B
Benjamin Pasero 已提交
929
		 */
930
		show(): void;
931 932 933 934 935 936 937 938 939 940 941 942
		/**
		 * 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.
		 */
		startAccessingSecurityScopedResource(bookmarkData: string): Function;
		/**
		 * Updates the current activity if its type matches type, merging the entries from
		 * userInfo into its current userInfo dictionary.
		 */
		updateCurrentActivity(type: string, userInfo: any): void;
943
		whenReady(): Promise<any>;
944
		commandLine: CommandLine;
B
Benjamin Pasero 已提交
945
		dock: Dock;
946 947 948 949 950 951
		/**
		 * 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.
		 */
		isPackaged?: boolean;
B
Benjamin Pasero 已提交
952 953
	}

954 955 956
	interface AutoUpdater extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/auto-updater
B
Benjamin Pasero 已提交
957

958 959 960 961 962 963 964 965 966 967 968
		/**
		 * This event is emitted after a user calls quitAndInstall(). When this API is
		 * called, the before-quit event is not emitted before all windows are closed. As a
		 * result you should listen to this event if you wish to perform actions before the
		 * windows are closed while a process is quitting, as well as listening to
		 * before-quit.
		 */
		on(event: 'before-quit-for-update', listener: Function): this;
		once(event: 'before-quit-for-update', listener: Function): this;
		addListener(event: 'before-quit-for-update', listener: Function): this;
		removeListener(event: 'before-quit-for-update', listener: Function): this;
B
Benjamin Pasero 已提交
969
		/**
970
		 * Emitted when checking if an update has started.
B
Benjamin Pasero 已提交
971
		 */
972 973 974 975
		on(event: 'checking-for-update', listener: Function): this;
		once(event: 'checking-for-update', listener: Function): this;
		addListener(event: 'checking-for-update', listener: Function): this;
		removeListener(event: 'checking-for-update', listener: Function): this;
B
Benjamin Pasero 已提交
976
		/**
977
		 * Emitted when there is an error while updating.
B
Benjamin Pasero 已提交
978
		 */
979 980 981 982
		on(event: 'error', listener: (error: Error) => void): this;
		once(event: 'error', listener: (error: Error) => void): this;
		addListener(event: 'error', listener: (error: Error) => void): this;
		removeListener(event: 'error', listener: (error: Error) => void): this;
B
Benjamin Pasero 已提交
983
		/**
984 985
		 * Emitted when there is an available update. The update is downloaded
		 * automatically.
B
Benjamin Pasero 已提交
986
		 */
987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
		on(event: 'update-available', listener: Function): this;
		once(event: 'update-available', listener: Function): this;
		addListener(event: 'update-available', listener: Function): this;
		removeListener(event: 'update-available', listener: Function): this;
		/**
		 * Emitted when an update has been downloaded. On Windows only releaseName is
		 * available.
		 */
		on(event: 'update-downloaded', listener: (event: Event,
			releaseNotes: string,
			releaseName: string,
			releaseDate: Date,
			updateURL: string) => void): this;
		once(event: 'update-downloaded', listener: (event: Event,
			releaseNotes: string,
			releaseName: string,
			releaseDate: Date,
			updateURL: string) => void): this;
		addListener(event: 'update-downloaded', listener: (event: Event,
			releaseNotes: string,
			releaseName: string,
			releaseDate: Date,
			updateURL: string) => void): this;
		removeListener(event: 'update-downloaded', listener: (event: Event,
			releaseNotes: string,
			releaseName: string,
			releaseDate: Date,
			updateURL: string) => void): this;
B
Benjamin Pasero 已提交
1015
		/**
1016
		 * Emitted when there is no available update.
B
Benjamin Pasero 已提交
1017
		 */
1018 1019 1020 1021
		on(event: 'update-not-available', listener: Function): this;
		once(event: 'update-not-available', listener: Function): this;
		addListener(event: 'update-not-available', listener: Function): this;
		removeListener(event: 'update-not-available', listener: Function): this;
B
Benjamin Pasero 已提交
1022
		/**
1023 1024
		 * Asks the server whether there is an update. You must call setFeedURL before
		 * using this API.
B
Benjamin Pasero 已提交
1025
		 */
1026 1027
		checkForUpdates(): void;
		getFeedURL(): string;
B
Benjamin Pasero 已提交
1028
		/**
1029
		 * Restarts the app and installs the update after it has been downloaded. It should
1030 1031 1032 1033 1034 1035
		 * only be called after update-downloaded has been emitted. Under the hood calling
		 * autoUpdater.quitAndInstall() will close all application windows first, and
		 * automatically call app.quit() after all windows have been closed. Note: If the
		 * application is quit without calling this API after the update-downloaded event
		 * has been emitted, the application will still be replaced by the updated one on
		 * the next run.
B
Benjamin Pasero 已提交
1036
		 */
1037
		quitAndInstall(): void;
B
Benjamin Pasero 已提交
1038
		/**
1039
		 * Sets the url and initialize the auto updater.
B
Benjamin Pasero 已提交
1040
		 */
1041
		setFeedURL(options: FeedURLOptions): void;
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
	}

	interface BluetoothDevice {

		// Docs: http://electron.atom.io/docs/api/structures/bluetooth-device

		deviceId: string;
		deviceName: string;
	}

	class BrowserView extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/browser-view

		constructor(options?: BrowserViewConstructorOptions);
B
Benjamin Pasero 已提交
1057
		static fromId(id: number): BrowserView;
1058 1059 1060 1061 1062 1063 1064 1065 1066
		static fromWebContents(webContents: WebContents): BrowserView | null;
		static getAllViews(): BrowserView[];
		/**
		 * Force closing the view, the unload and beforeunload events won't be emitted for
		 * the web page. After you're done with a view, call this function in order to free
		 * memory and other resources as soon as possible.
		 */
		destroy(): void;
		isDestroyed(): boolean;
1067 1068
		setAutoResize(options: AutoResizeOptions): void;
		setBackgroundColor(color: string): void;
B
Benjamin Pasero 已提交
1069
		/**
1070
		 * Resizes and moves the view to the supplied bounds relative to the window.
B
Benjamin Pasero 已提交
1071
		 */
1072 1073 1074 1075 1076 1077 1078 1079 1080
		setBounds(bounds: Rectangle): void;
		id: number;
		webContents: WebContents;
	}

	class BrowserWindow extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/browser-window

B
Benjamin Pasero 已提交
1081
		/**
1082 1083 1084 1085 1086
		 * Emitted when an App Command 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. Commands are lowercased, underscores are replaced with hyphens,
		 * and the APPCOMMAND_ prefix is stripped off. e.g. APPCOMMAND_BROWSER_BACKWARD is
		 * emitted as browser-backward.
B
Benjamin Pasero 已提交
1087
		 */
1088 1089 1090 1091 1092 1093 1094 1095
		on(event: 'app-command', listener: (event: Event,
			command: string) => void): this;
		once(event: 'app-command', listener: (event: Event,
			command: string) => void): this;
		addListener(event: 'app-command', listener: (event: Event,
			command: string) => void): this;
		removeListener(event: 'app-command', listener: (event: Event,
			command: string) => void): this;
B
Benjamin Pasero 已提交
1096
		/**
1097
		 * Emitted when the window loses focus.
B
Benjamin Pasero 已提交
1098
		 */
1099 1100 1101 1102
		on(event: 'blur', listener: Function): this;
		once(event: 'blur', listener: Function): this;
		addListener(event: 'blur', listener: Function): this;
		removeListener(event: 'blur', listener: Function): this;
B
Benjamin Pasero 已提交
1103
		/**
1104 1105 1106 1107 1108
		 * Emitted when the window is going to be closed. It's emitted before the
		 * beforeunload and unload event of the DOM. Calling event.preventDefault() will
		 * cancel the close. 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 reloaded. In Electron, returning any value other than undefined would
1109 1110 1111
		 * cancel the close. For example: Note: There is a subtle difference between the
		 * behaviors of window.onbeforeunload = handler and
		 * window.addEventListener('beforeunload', handler). It is recommended to always
1112
		 * set the event.returnValue explicitly, instead of only returning a value, as the
1113
		 * former works more consistently within Electron.
B
Benjamin Pasero 已提交
1114
		 */
1115 1116 1117 1118
		on(event: 'close', listener: (event: Event) => void): this;
		once(event: 'close', listener: (event: Event) => void): this;
		addListener(event: 'close', listener: (event: Event) => void): this;
		removeListener(event: 'close', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
1119
		/**
1120 1121
		 * Emitted when the window is closed. After you have received this event you should
		 * remove the reference to the window and avoid using it any more.
B
Benjamin Pasero 已提交
1122
		 */
1123 1124 1125 1126
		on(event: 'closed', listener: Function): this;
		once(event: 'closed', listener: Function): this;
		addListener(event: 'closed', listener: Function): this;
		removeListener(event: 'closed', listener: Function): this;
B
Benjamin Pasero 已提交
1127
		/**
1128
		 * Emitted when the window enters a full-screen state.
B
Benjamin Pasero 已提交
1129
		 */
1130 1131 1132 1133
		on(event: 'enter-full-screen', listener: Function): this;
		once(event: 'enter-full-screen', listener: Function): this;
		addListener(event: 'enter-full-screen', listener: Function): this;
		removeListener(event: 'enter-full-screen', listener: Function): this;
B
Benjamin Pasero 已提交
1134
		/**
1135
		 * Emitted when the window enters a full-screen state triggered by HTML API.
B
Benjamin Pasero 已提交
1136
		 */
1137 1138 1139 1140
		on(event: 'enter-html-full-screen', listener: Function): this;
		once(event: 'enter-html-full-screen', listener: Function): this;
		addListener(event: 'enter-html-full-screen', listener: Function): this;
		removeListener(event: 'enter-html-full-screen', listener: Function): this;
B
Benjamin Pasero 已提交
1141
		/**
1142
		 * Emitted when the window gains focus.
B
Benjamin Pasero 已提交
1143
		 */
1144 1145 1146 1147
		on(event: 'focus', listener: Function): this;
		once(event: 'focus', listener: Function): this;
		addListener(event: 'focus', listener: Function): this;
		removeListener(event: 'focus', listener: Function): this;
B
Benjamin Pasero 已提交
1148
		/**
1149
		 * Emitted when the window is hidden.
B
Benjamin Pasero 已提交
1150
		 */
1151 1152 1153 1154
		on(event: 'hide', listener: Function): this;
		once(event: 'hide', listener: Function): this;
		addListener(event: 'hide', listener: Function): this;
		removeListener(event: 'hide', listener: Function): this;
B
Benjamin Pasero 已提交
1155
		/**
1156
		 * Emitted when the window leaves a full-screen state.
B
Benjamin Pasero 已提交
1157
		 */
1158 1159 1160 1161
		on(event: 'leave-full-screen', listener: Function): this;
		once(event: 'leave-full-screen', listener: Function): this;
		addListener(event: 'leave-full-screen', listener: Function): this;
		removeListener(event: 'leave-full-screen', listener: Function): this;
B
Benjamin Pasero 已提交
1162
		/**
1163
		 * Emitted when the window leaves a full-screen state triggered by HTML API.
B
Benjamin Pasero 已提交
1164
		 */
1165 1166 1167 1168
		on(event: 'leave-html-full-screen', listener: Function): this;
		once(event: 'leave-html-full-screen', listener: Function): this;
		addListener(event: 'leave-html-full-screen', listener: Function): this;
		removeListener(event: 'leave-html-full-screen', listener: Function): this;
B
Benjamin Pasero 已提交
1169
		/**
1170
		 * Emitted when window is maximized.
B
Benjamin Pasero 已提交
1171
		 */
1172 1173 1174 1175
		on(event: 'maximize', listener: Function): this;
		once(event: 'maximize', listener: Function): this;
		addListener(event: 'maximize', listener: Function): this;
		removeListener(event: 'maximize', listener: Function): this;
B
Benjamin Pasero 已提交
1176
		/**
1177
		 * Emitted when the window is minimized.
B
Benjamin Pasero 已提交
1178
		 */
1179 1180 1181 1182
		on(event: 'minimize', listener: Function): this;
		once(event: 'minimize', listener: Function): this;
		addListener(event: 'minimize', listener: Function): this;
		removeListener(event: 'minimize', listener: Function): this;
B
Benjamin Pasero 已提交
1183
		/**
1184
		 * Emitted when the window is being moved to a new position. Note: On macOS this
1185
		 * event is an alias of moved.
B
Benjamin Pasero 已提交
1186
		 */
1187 1188 1189 1190
		on(event: 'move', listener: Function): this;
		once(event: 'move', listener: Function): this;
		addListener(event: 'move', listener: Function): this;
		removeListener(event: 'move', listener: Function): this;
B
Benjamin Pasero 已提交
1191
		/**
1192
		 * Emitted once when the window is moved to a new position.
B
Benjamin Pasero 已提交
1193
		 */
1194 1195 1196 1197
		on(event: 'moved', listener: Function): this;
		once(event: 'moved', listener: Function): this;
		addListener(event: 'moved', listener: Function): this;
		removeListener(event: 'moved', listener: Function): this;
B
Benjamin Pasero 已提交
1198
		/**
B
Benjamin Pasero 已提交
1199
		 * Emitted when the native new tab button is clicked.
B
Benjamin Pasero 已提交
1200
		 */
B
Benjamin Pasero 已提交
1201 1202 1203 1204
		on(event: 'new-window-for-tab', listener: Function): this;
		once(event: 'new-window-for-tab', listener: Function): this;
		addListener(event: 'new-window-for-tab', listener: Function): this;
		removeListener(event: 'new-window-for-tab', listener: Function): this;
B
Benjamin Pasero 已提交
1205
		/**
1206 1207
		 * Emitted when the document changed its title, calling event.preventDefault() will
		 * prevent the native window's title from changing.
B
Benjamin Pasero 已提交
1208
		 */
1209 1210 1211 1212 1213 1214 1215 1216
		on(event: 'page-title-updated', listener: (event: Event,
			title: string) => void): this;
		once(event: 'page-title-updated', listener: (event: Event,
			title: string) => void): this;
		addListener(event: 'page-title-updated', listener: (event: Event,
			title: string) => void): this;
		removeListener(event: 'page-title-updated', listener: (event: Event,
			title: string) => void): this;
B
Benjamin Pasero 已提交
1217
		/**
1218 1219
		 * Emitted when the web page has been rendered (while not being shown) and window
		 * can be displayed without a visual flash.
B
Benjamin Pasero 已提交
1220
		 */
1221 1222 1223 1224
		on(event: 'ready-to-show', listener: Function): this;
		once(event: 'ready-to-show', listener: Function): this;
		addListener(event: 'ready-to-show', listener: Function): this;
		removeListener(event: 'ready-to-show', listener: Function): this;
B
Benjamin Pasero 已提交
1225
		/**
1226
		 * Emitted when the window is being resized.
B
Benjamin Pasero 已提交
1227
		 */
1228 1229 1230 1231
		on(event: 'resize', listener: Function): this;
		once(event: 'resize', listener: Function): this;
		addListener(event: 'resize', listener: Function): this;
		removeListener(event: 'resize', listener: Function): this;
B
Benjamin Pasero 已提交
1232
		/**
1233
		 * Emitted when the unresponsive web page becomes responsive again.
B
Benjamin Pasero 已提交
1234
		 */
1235 1236 1237 1238
		on(event: 'responsive', listener: Function): this;
		once(event: 'responsive', listener: Function): this;
		addListener(event: 'responsive', listener: Function): this;
		removeListener(event: 'responsive', listener: Function): this;
B
Benjamin Pasero 已提交
1239
		/**
1240
		 * Emitted when the window is restored from a minimized state.
B
Benjamin Pasero 已提交
1241
		 */
1242 1243 1244 1245
		on(event: 'restore', listener: Function): this;
		once(event: 'restore', listener: Function): this;
		addListener(event: 'restore', listener: Function): this;
		removeListener(event: 'restore', listener: Function): this;
B
Benjamin Pasero 已提交
1246
		/**
1247
		 * Emitted when scroll wheel event phase has begun.
B
Benjamin Pasero 已提交
1248
		 */
1249 1250 1251 1252
		on(event: 'scroll-touch-begin', listener: Function): this;
		once(event: 'scroll-touch-begin', listener: Function): this;
		addListener(event: 'scroll-touch-begin', listener: Function): this;
		removeListener(event: 'scroll-touch-begin', listener: Function): this;
B
Benjamin Pasero 已提交
1253
		/**
1254
		 * Emitted when scroll wheel event phase filed upon reaching the edge of element.
B
Benjamin Pasero 已提交
1255
		 */
1256 1257 1258 1259
		on(event: 'scroll-touch-edge', listener: Function): this;
		once(event: 'scroll-touch-edge', listener: Function): this;
		addListener(event: 'scroll-touch-edge', listener: Function): this;
		removeListener(event: 'scroll-touch-edge', listener: Function): this;
B
Benjamin Pasero 已提交
1260
		/**
1261
		 * Emitted when scroll wheel event phase has ended.
B
Benjamin Pasero 已提交
1262
		 */
1263 1264 1265 1266
		on(event: 'scroll-touch-end', listener: Function): this;
		once(event: 'scroll-touch-end', listener: Function): this;
		addListener(event: 'scroll-touch-end', listener: Function): this;
		removeListener(event: 'scroll-touch-end', listener: Function): this;
B
Benjamin Pasero 已提交
1267
		/**
1268 1269
		 * Emitted when window session is going to end due to force shutdown or machine
		 * restart or session log off.
B
Benjamin Pasero 已提交
1270
		 */
1271 1272 1273 1274
		on(event: 'session-end', listener: Function): this;
		once(event: 'session-end', listener: Function): this;
		addListener(event: 'session-end', listener: Function): this;
		removeListener(event: 'session-end', listener: Function): this;
B
Benjamin Pasero 已提交
1275
		/**
1276
		 * Emitted when the window opens a sheet.
B
Benjamin Pasero 已提交
1277
		 */
1278 1279 1280 1281
		on(event: 'sheet-begin', listener: Function): this;
		once(event: 'sheet-begin', listener: Function): this;
		addListener(event: 'sheet-begin', listener: Function): this;
		removeListener(event: 'sheet-begin', listener: Function): this;
B
Benjamin Pasero 已提交
1282
		/**
1283
		 * Emitted when the window has closed a sheet.
B
Benjamin Pasero 已提交
1284
		 */
1285 1286 1287 1288
		on(event: 'sheet-end', listener: Function): this;
		once(event: 'sheet-end', listener: Function): this;
		addListener(event: 'sheet-end', listener: Function): this;
		removeListener(event: 'sheet-end', listener: Function): this;
B
Benjamin Pasero 已提交
1289
		/**
1290
		 * Emitted when the window is shown.
B
Benjamin Pasero 已提交
1291
		 */
1292 1293 1294 1295
		on(event: 'show', listener: Function): this;
		once(event: 'show', listener: Function): this;
		addListener(event: 'show', listener: Function): this;
		removeListener(event: 'show', listener: Function): this;
B
Benjamin Pasero 已提交
1296
		/**
1297
		 * Emitted on 3-finger swipe. Possible directions are up, right, down, left.
B
Benjamin Pasero 已提交
1298
		 */
1299 1300 1301 1302 1303 1304 1305 1306
		on(event: 'swipe', listener: (event: Event,
			direction: string) => void): this;
		once(event: 'swipe', listener: (event: Event,
			direction: string) => void): this;
		addListener(event: 'swipe', listener: (event: Event,
			direction: string) => void): this;
		removeListener(event: 'swipe', listener: (event: Event,
			direction: string) => void): this;
B
Benjamin Pasero 已提交
1307
		/**
1308
		 * Emitted when the window exits from a maximized state.
B
Benjamin Pasero 已提交
1309
		 */
1310 1311 1312 1313
		on(event: 'unmaximize', listener: Function): this;
		once(event: 'unmaximize', listener: Function): this;
		addListener(event: 'unmaximize', listener: Function): this;
		removeListener(event: 'unmaximize', listener: Function): this;
B
Benjamin Pasero 已提交
1314
		/**
1315
		 * Emitted when the web page becomes unresponsive.
B
Benjamin Pasero 已提交
1316
		 */
1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331
		on(event: 'unresponsive', listener: Function): this;
		once(event: 'unresponsive', listener: Function): this;
		addListener(event: 'unresponsive', listener: Function): this;
		removeListener(event: 'unresponsive', listener: Function): this;
		constructor(options?: BrowserWindowConstructorOptions);
		/**
		 * 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. If you try to add an extension that has already been
		 * loaded, this method will not return and instead log a warning to the console.
		 * The method will also not return if the extension's manifest is missing or
		 * incomplete. Note: This API cannot be called before the ready event of the app
		 * module is emitted.
		 */
		static addDevToolsExtension(path: string): void;
B
Benjamin Pasero 已提交
1332 1333 1334 1335 1336 1337
		/**
		 * Adds Chrome extension located at path, and returns extension's name. The method
		 * will also not return if the extension's manifest is missing or incomplete. Note:
		 * This API cannot be called before the ready event of the app module is emitted.
		 */
		static addExtension(path: string): void;
1338
		static fromBrowserView(browserView: BrowserView): BrowserWindow | null;
1339 1340 1341
		static fromId(id: number): BrowserWindow;
		static fromWebContents(webContents: WebContents): BrowserWindow;
		static getAllWindows(): BrowserWindow[];
B
Benjamin Pasero 已提交
1342
		/**
1343 1344
		 * To check if a DevTools extension is installed you can run the following: Note:
		 * This API cannot be called before the ready event of the app module is emitted.
B
Benjamin Pasero 已提交
1345
		 */
1346
		static getDevToolsExtensions(): DevToolsExtensions;
B
Benjamin Pasero 已提交
1347
		/**
B
Benjamin Pasero 已提交
1348 1349
		 * Note: This API cannot be called before the ready event of the app module is
		 * emitted.
B
Benjamin Pasero 已提交
1350
		 */
B
Benjamin Pasero 已提交
1351
		static getExtensions(): Extensions;
1352
		static getFocusedWindow(): BrowserWindow | null;
1353
		/**
1354 1355
		 * Remove a DevTools extension by name. Note: This API cannot be called before the
		 * ready event of the app module is emitted.
1356
		 */
1357
		static removeDevToolsExtension(name: string): void;
1358
		/**
B
Benjamin Pasero 已提交
1359 1360
		 * Remove a Chrome extension by name. Note: This API cannot be called before the
		 * ready event of the app module is emitted.
1361
		 */
B
Benjamin Pasero 已提交
1362
		static removeExtension(name: string): void;
1363 1364 1365 1366
		/**
		 * Adds a window as a tab on this window, after the tab for the window instance.
		 */
		addTabbedWindow(browserWindow: BrowserWindow): void;
1367
		/**
1368
		 * Removes focus from the window.
1369
		 */
1370 1371
		blur(): void;
		blurWebView(): void;
1372
		/**
1373
		 * Same as webContents.capturePage([rect, ]callback).
1374
		 */
1375
		capturePage(callback: (image: NativeImage) => void): void;
1376
		/**
1377
		 * Same as webContents.capturePage([rect, ]callback).
1378
		 */
1379
		capturePage(rect: Rectangle, callback: (image: NativeImage) => void): void;
B
Benjamin Pasero 已提交
1380
		/**
1381
		 * Moves window to the center of the screen.
B
Benjamin Pasero 已提交
1382
		 */
1383
		center(): void;
B
Benjamin Pasero 已提交
1384
		/**
1385 1386 1387
		 * Try to close the window. This has the same effect as a user manually clicking
		 * the close button of the window. The web page may cancel the close though. See
		 * the close event.
B
Benjamin Pasero 已提交
1388
		 */
1389
		close(): void;
B
Benjamin Pasero 已提交
1390
		/**
1391
		 * Closes the currently open Quick Look panel.
B
Benjamin Pasero 已提交
1392
		 */
1393
		closeFilePreview(): void;
B
Benjamin Pasero 已提交
1394
		/**
1395 1396 1397
		 * Force closing the window, the unload and beforeunload event won't be emitted for
		 * the web page, and close event will also not be emitted for this window, but it
		 * guarantees the closed event will be emitted.
B
Benjamin Pasero 已提交
1398
		 */
1399
		destroy(): void;
B
Benjamin Pasero 已提交
1400
		/**
1401
		 * Starts or stops flashing the window to attract user's attention.
B
Benjamin Pasero 已提交
1402
		 */
1403
		flashFrame(flag: boolean): void;
B
Benjamin Pasero 已提交
1404
		/**
1405
		 * Focuses on the window.
B
Benjamin Pasero 已提交
1406
		 */
1407 1408 1409
		focus(): void;
		focusOnWebView(): void;
		getBounds(): Rectangle;
1410 1411 1412 1413 1414
		/**
		 * Note: The BrowserView API is currently experimental and may change or be removed
		 * in future Electron releases.
		 */
		getBrowserView(): BrowserView | null;
1415 1416 1417 1418 1419
		getChildWindows(): BrowserWindow[];
		getContentBounds(): Rectangle;
		getContentSize(): number[];
		getMaximumSize(): number[];
		getMinimumSize(): number[];
B
Benjamin Pasero 已提交
1420
		/**
1421 1422
		 * The native type of the handle is HWND on Windows, NSView* on macOS, and Window
		 * (unsigned long) on Linux.
B
Benjamin Pasero 已提交
1423
		 */
1424
		getNativeWindowHandle(): Buffer;
1425
		getOpacity(): number;
1426 1427 1428 1429
		getParentWindow(): BrowserWindow;
		getPosition(): number[];
		getRepresentedFilename(): string;
		getSize(): number[];
B
Benjamin Pasero 已提交
1430
		/**
1431 1432
		 * Note: The title of web page can be different from the title of the native
		 * window.
B
Benjamin Pasero 已提交
1433
		 */
1434
		getTitle(): string;
B
Benjamin Pasero 已提交
1435
		/**
1436
		 * On Windows and Linux always returns true.
B
Benjamin Pasero 已提交
1437
		 */
1438
		hasShadow(): boolean;
B
Benjamin Pasero 已提交
1439
		/**
1440
		 * Hides the window.
B
Benjamin Pasero 已提交
1441
		 */
1442
		hide(): void;
B
Benjamin Pasero 已提交
1443
		/**
1444 1445
		 * Hooks a windows message. The callback is called when the message is received in
		 * the WndProc.
B
Benjamin Pasero 已提交
1446
		 */
1447 1448
		hookWindowMessage(message: number, callback: Function): void;
		isAlwaysOnTop(): boolean;
B
Benjamin Pasero 已提交
1449
		/**
1450
		 * On Linux always returns true.
B
Benjamin Pasero 已提交
1451
		 */
1452 1453 1454 1455 1456 1457 1458
		isClosable(): boolean;
		isDestroyed(): boolean;
		isDocumentEdited(): boolean;
		isFocused(): boolean;
		isFullScreen(): boolean;
		isFullScreenable(): boolean;
		isKiosk(): boolean;
B
Benjamin Pasero 已提交
1459
		/**
1460
		 * On Linux always returns true.
B
Benjamin Pasero 已提交
1461
		 */
1462 1463 1464 1465
		isMaximizable(): boolean;
		isMaximized(): boolean;
		isMenuBarAutoHide(): boolean;
		isMenuBarVisible(): boolean;
B
Benjamin Pasero 已提交
1466
		/**
1467
		 * On Linux always returns true.
B
Benjamin Pasero 已提交
1468
		 */
1469 1470 1471
		isMinimizable(): boolean;
		isMinimized(): boolean;
		isModal(): boolean;
B
Benjamin Pasero 已提交
1472
		/**
1473
		 * On Linux always returns true.
B
Benjamin Pasero 已提交
1474
		 */
1475 1476
		isMovable(): boolean;
		isResizable(): boolean;
1477
		isSimpleFullScreen(): boolean;
1478
		isVisible(): boolean;
B
Benjamin Pasero 已提交
1479
		/**
1480
		 * Note: This API always returns false on Windows.
B
Benjamin Pasero 已提交
1481
		 */
1482 1483
		isVisibleOnAllWorkspaces(): boolean;
		isWindowMessageHooked(message: number): boolean;
1484 1485 1486 1487 1488
		/**
		 * Same as webContents.loadFile, filePath should be a path to an HTML file relative
		 * to the root of your application.  See the webContents docs for more information.
		 */
		loadFile(filePath: string): void;
B
Benjamin Pasero 已提交
1489
		/**
1490 1491 1492 1493 1494
		 * Same as webContents.loadURL(url[, options]). The url can be a remote address
		 * (e.g. http://) or a path to a local HTML file using the file:// protocol. To
		 * ensure that file URLs are properly formatted, it is recommended to use Node's
		 * url.format method: You can load a URL using a POST request with URL-encoded data
		 * by doing the following:
B
Benjamin Pasero 已提交
1495
		 */
1496
		loadURL(url: string, options?: LoadURLOptions): void;
B
Benjamin Pasero 已提交
1497
		/**
1498 1499
		 * Maximizes the window. This will also show (but not focus) the window if it isn't
		 * being displayed already.
B
Benjamin Pasero 已提交
1500
		 */
1501
		maximize(): void;
1502 1503 1504 1505 1506
		/**
		 * Merges all windows into one window with multiple tabs when native tabs are
		 * enabled and there is more than one open window.
		 */
		mergeAllWindows(): void;
B
Benjamin Pasero 已提交
1507
		/**
1508 1509
		 * Minimizes the window. On some platforms the minimized window will be shown in
		 * the Dock.
B
Benjamin Pasero 已提交
1510
		 */
1511
		minimize(): void;
1512 1513 1514 1515 1516
		/**
		 * Moves the current tab into a new window if native tabs are enabled and there is
		 * more than one tab in the current window.
		 */
		moveTabToNewWindow(): void;
1517 1518 1519 1520
		/**
		 * Moves window to top(z-order) regardless of focus
		 */
		moveTop(): void;
B
Benjamin Pasero 已提交
1521
		/**
1522
		 * Uses Quick Look to preview a file at a given path.
B
Benjamin Pasero 已提交
1523
		 */
1524
		previewFile(path: string, displayName?: string): void;
B
Benjamin Pasero 已提交
1525
		/**
1526
		 * Same as webContents.reload.
B
Benjamin Pasero 已提交
1527
		 */
1528
		reload(): void;
B
Benjamin Pasero 已提交
1529
		/**
1530
		 * Restores the window from minimized state to its previous state.
B
Benjamin Pasero 已提交
1531
		 */
1532
		restore(): void;
1533 1534 1535 1536 1537 1538 1539 1540 1541 1542
		/**
		 * Selects the next tab when native tabs are enabled and there are other tabs in
		 * the window.
		 */
		selectNextTab(): void;
		/**
		 * Selects the previous tab when native tabs are enabled and there are other tabs
		 * in the window.
		 */
		selectPreviousTab(): void;
B
Benjamin Pasero 已提交
1543
		/**
1544 1545 1546
		 * 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.
B
Benjamin Pasero 已提交
1547
		 */
1548
		setAlwaysOnTop(flag: boolean, level?: 'normal' | 'floating' | 'torn-off-menu' | 'modal-panel' | 'main-menu' | 'status' | 'pop-up-menu' | 'screen-saver', relativeLevel?: number): void;
1549
		/**
1550 1551 1552
		 * Sets the properties for the window's taskbar button. Note: relaunchCommand and
		 * relaunchDisplayName must always be set together. If one of those properties is
		 * not set, then neither will be used.
1553
		 */
1554
		setAppDetails(options: AppDetailsOptions): void;
B
Benjamin Pasero 已提交
1555
		/**
1556 1557 1558 1559 1560 1561 1562 1563 1564 1565
		 * This will make 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. 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.
1566 1567 1568
		 * Sum any extra width and height areas you have within the overall content view.
		 * Calling this function with a value of 0 will remove any previously set aspect
		 * ratios.
B
Benjamin Pasero 已提交
1569
		 */
1570
		setAspectRatio(aspectRatio: number, extraSize: Size): void;
B
Benjamin Pasero 已提交
1571
		/**
1572
		 * Controls whether to hide cursor when typing.
B
Benjamin Pasero 已提交
1573
		 */
1574
		setAutoHideCursor(autoHide: boolean): void;
B
Benjamin Pasero 已提交
1575
		/**
1576 1577 1578
		 * 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.
B
Benjamin Pasero 已提交
1579
		 */
1580
		setAutoHideMenuBar(hide: boolean): void;
B
Benjamin Pasero 已提交
1581
		/**
1582
		 * Resizes and moves the window to the supplied bounds
B
Benjamin Pasero 已提交
1583
		 */
1584 1585
		setBounds(bounds: Rectangle, animate?: boolean): void;
		setBrowserView(browserView: BrowserView): void;
B
Benjamin Pasero 已提交
1586
		/**
1587
		 * Sets whether the window can be manually closed by user. On Linux does nothing.
B
Benjamin Pasero 已提交
1588
		 */
1589
		setClosable(closable: boolean): void;
B
Benjamin Pasero 已提交
1590
		/**
1591 1592
		 * Resizes and moves the window's client area (e.g. the web page) to the supplied
		 * bounds.
B
Benjamin Pasero 已提交
1593
		 */
1594
		setContentBounds(bounds: Rectangle, animate?: boolean): void;
B
Benjamin Pasero 已提交
1595
		/**
1596 1597 1598
		 * Prevents the window contents from being captured by other apps. On macOS it sets
		 * the NSWindow's sharingType to NSWindowSharingNone. On Windows it calls
		 * SetWindowDisplayAffinity with WDA_MONITOR.
B
Benjamin Pasero 已提交
1599
		 */
1600
		setContentProtection(enable: boolean): void;
1601
		/**
1602
		 * Resizes the window's client area (e.g. the web page) to width and height.
1603
		 */
1604
		setContentSize(width: number, height: number, animate?: boolean): void;
B
Benjamin Pasero 已提交
1605
		/**
1606 1607
		 * Specifies whether the window’s document has been edited, and the icon in title
		 * bar will become gray when set to true.
B
Benjamin Pasero 已提交
1608
		 */
1609
		setDocumentEdited(edited: boolean): void;
1610 1611 1612 1613
		/**
		 * Disable or enable the window.
		 */
		setEnabled(enable: boolean): void;
B
Benjamin Pasero 已提交
1614
		/**
1615
		 * Changes whether the window can be focused.
B
Benjamin Pasero 已提交
1616
		 */
1617
		setFocusable(focusable: boolean): void;
B
Benjamin Pasero 已提交
1618
		/**
1619
		 * Sets whether the window should be in fullscreen mode.
B
Benjamin Pasero 已提交
1620
		 */
1621
		setFullScreen(flag: boolean): void;
B
Benjamin Pasero 已提交
1622
		/**
1623 1624
		 * Sets whether the maximize/zoom window button toggles fullscreen mode or
		 * maximizes the window.
B
Benjamin Pasero 已提交
1625
		 */
1626
		setFullScreenable(fullscreenable: boolean): void;
B
Benjamin Pasero 已提交
1627
		/**
1628
		 * Sets whether the window should have a shadow. On Windows and Linux does nothing.
B
Benjamin Pasero 已提交
1629
		 */
1630
		setHasShadow(hasShadow: boolean): void;
B
Benjamin Pasero 已提交
1631
		/**
1632
		 * Changes window icon.
B
Benjamin Pasero 已提交
1633
		 */
1634
		setIcon(icon: NativeImage): void;
B
Benjamin Pasero 已提交
1635
		/**
1636 1637 1638
		 * Makes the window ignore all mouse events. All mouse events happened in this
		 * window will be passed to the window below this window, but if this window has
		 * focus, it will still receive keyboard events.
B
Benjamin Pasero 已提交
1639
		 */
1640
		setIgnoreMouseEvents(ignore: boolean, options?: IgnoreMouseEventsOptions): void;
B
Benjamin Pasero 已提交
1641
		/**
1642
		 * Enters or leaves the kiosk mode.
B
Benjamin Pasero 已提交
1643
		 */
1644
		setKiosk(flag: boolean): void;
B
Benjamin Pasero 已提交
1645
		/**
1646 1647
		 * Sets whether the window can be manually maximized by user. On Linux does
		 * nothing.
B
Benjamin Pasero 已提交
1648
		 */
1649
		setMaximizable(maximizable: boolean): void;
B
Benjamin Pasero 已提交
1650
		/**
1651
		 * Sets the maximum size of window to width and height.
B
Benjamin Pasero 已提交
1652
		 */
1653
		setMaximumSize(width: number, height: number): void;
B
Benjamin Pasero 已提交
1654
		/**
1655 1656
		 * Sets the menu as the window's menu bar, setting it to null will remove the menu
		 * bar.
B
Benjamin Pasero 已提交
1657
		 */
B
Benjamin Pasero 已提交
1658
		setMenu(menu: Menu | null): void;
B
Benjamin Pasero 已提交
1659
		/**
1660 1661
		 * 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.
B
Benjamin Pasero 已提交
1662
		 */
1663
		setMenuBarVisibility(visible: boolean): void;
B
Benjamin Pasero 已提交
1664
		/**
1665 1666
		 * Sets whether the window can be manually minimized by user. On Linux does
		 * nothing.
B
Benjamin Pasero 已提交
1667
		 */
1668
		setMinimizable(minimizable: boolean): void;
B
Benjamin Pasero 已提交
1669
		/**
1670
		 * Sets the minimum size of window to width and height.
B
Benjamin Pasero 已提交
1671
		 */
1672
		setMinimumSize(width: number, height: number): void;
B
Benjamin Pasero 已提交
1673
		/**
1674
		 * Sets whether the window can be moved by user. On Linux does nothing.
B
Benjamin Pasero 已提交
1675
		 */
1676
		setMovable(movable: boolean): void;
1677 1678 1679 1680
		/**
		 * Sets the opacity of the window. On Linux does nothing.
		 */
		setOpacity(opacity: number): void;
B
Benjamin Pasero 已提交
1681
		/**
1682 1683
		 * Sets a 16 x 16 pixel overlay onto the current taskbar icon, usually used to
		 * convey some sort of application status or to passively notify the user.
B
Benjamin Pasero 已提交
1684
		 */
1685
		setOverlayIcon(overlay: NativeImage | null, description: string): void;
B
Benjamin Pasero 已提交
1686
		/**
1687 1688
		 * Sets parent as current window's parent window, passing null will turn current
		 * window into a top-level window.
B
Benjamin Pasero 已提交
1689
		 */
1690
		setParentWindow(parent: BrowserWindow): void;
B
Benjamin Pasero 已提交
1691
		/**
1692
		 * Moves window to x and y.
B
Benjamin Pasero 已提交
1693
		 */
1694
		setPosition(x: number, y: number, animate?: boolean): void;
B
Benjamin Pasero 已提交
1695
		/**
1696 1697 1698 1699 1700 1701 1702 1703
		 * 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, it will
		 * assume app.getName().desktop. On Windows, a mode can be passed. Accepted values
		 * are none, normal, indeterminate, error, and paused. If you call setProgressBar
		 * without a mode set (but with a value within the valid range), normal will be
		 * assumed.
B
Benjamin Pasero 已提交
1704
		 */
1705
		setProgressBar(progress: number, options?: ProgressBarOptions): void;
B
Benjamin Pasero 已提交
1706
		/**
1707 1708
		 * Sets the pathname of the file the window represents, and the icon of the file
		 * will show in window's title bar.
B
Benjamin Pasero 已提交
1709
		 */
1710
		setRepresentedFilename(filename: string): void;
B
Benjamin Pasero 已提交
1711
		/**
1712
		 * Sets whether the window can be manually resized by user.
B
Benjamin Pasero 已提交
1713
		 */
1714
		setResizable(resizable: boolean): void;
1715 1716 1717 1718 1719 1720 1721 1722
		/**
		 * Setting a window shape determines the area within the window where the system
		 * permits drawing and user interaction. Outside of the given region, no pixels
		 * will be drawn and no mouse events will be registered. Mouse events outside of
		 * the region will not be received by that window, but will fall through to
		 * whatever is behind the window.
		 */
		setShape(rects: Rectangle[]): void;
B
Benjamin Pasero 已提交
1723
		/**
1724 1725 1726
		 * Changes the attachment point for sheets on macOS. By default, sheets are
		 * attached just below the window frame, but you may want to display them beneath a
		 * HTML-rendered toolbar. For example:
B
Benjamin Pasero 已提交
1727
		 */
1728
		setSheetOffset(offsetY: number, offsetX?: number): void;
1729 1730 1731 1732 1733
		/**
		 * Enters or leaves simple fullscreen mode. Simple fullscreen mode emulates the
		 * native fullscreen behavior found in versions of Mac OS X prior to Lion (10.7).
		 */
		setSimpleFullScreen(flag: boolean): void;
B
Benjamin Pasero 已提交
1734
		/**
1735 1736
		 * Resizes the window to width and height. If width or height are below any set
		 * minimum size constraints the window will snap to its minimum size.
B
Benjamin Pasero 已提交
1737
		 */
1738
		setSize(width: number, height: number, animate?: boolean): void;
B
Benjamin Pasero 已提交
1739
		/**
1740
		 * Makes the window not show in the taskbar.
B
Benjamin Pasero 已提交
1741
		 */
1742
		setSkipTaskbar(skip: boolean): void;
B
Benjamin Pasero 已提交
1743
		/**
1744 1745 1746 1747 1748 1749 1750 1751
		 * 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. 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.
		 * The buttons is an array of Button objects: The flags is an array that can
		 * include following Strings:
B
Benjamin Pasero 已提交
1752
		 */
1753
		setThumbarButtons(buttons: ThumbarButton[]): boolean;
B
Benjamin Pasero 已提交
1754
		/**
1755 1756 1757
		 * Sets the region of the window to show as the thumbnail image displayed when
		 * hovering over the window in the taskbar. You can reset the thumbnail to be the
		 * entire window by specifying an empty region: {x: 0, y: 0, width: 0, height: 0}.
B
Benjamin Pasero 已提交
1758
		 */
1759
		setThumbnailClip(region: Rectangle): void;
B
Benjamin Pasero 已提交
1760
		/**
1761 1762
		 * Sets the toolTip that is displayed when hovering over the window thumbnail in
		 * the taskbar.
B
Benjamin Pasero 已提交
1763
		 */
1764
		setThumbnailToolTip(toolTip: string): void;
B
Benjamin Pasero 已提交
1765
		/**
1766
		 * Changes the title of native window to title.
B
Benjamin Pasero 已提交
1767
		 */
1768
		setTitle(title: string): void;
B
Benjamin Pasero 已提交
1769
		/**
1770 1771 1772 1773
		 * Sets the touchBar layout for the current window. Specifying null or undefined
		 * clears the touch bar. This method only has an effect if the machine has a touch
		 * bar and is running on macOS 10.12.1+. Note: The TouchBar API is currently
		 * experimental and may change or be removed in future Electron releases.
B
Benjamin Pasero 已提交
1774
		 */
1775
		setTouchBar(touchBar: TouchBar): void;
B
Benjamin Pasero 已提交
1776
		/**
1777 1778
		 * Adds a vibrancy effect to the browser window. Passing null or an empty string
		 * will remove the vibrancy effect on the window.
B
Benjamin Pasero 已提交
1779
		 */
1780
		setVibrancy(type: 'appearance-based' | 'light' | 'dark' | 'titlebar' | 'selection' | 'menu' | 'popover' | 'sidebar' | 'medium-light' | 'ultra-dark'): void;
J
Joao Moreno 已提交
1781
		/**
1782 1783
		 * Sets whether the window should be visible on all workspaces. Note: This API does
		 * nothing on Windows.
J
Joao Moreno 已提交
1784
		 */
1785
		setVisibleOnAllWorkspaces(visible: boolean): void;
B
Benjamin Pasero 已提交
1786
		/**
1787
		 * Shows and gives focus to the window.
B
Benjamin Pasero 已提交
1788
		 */
1789
		show(): void;
B
Benjamin Pasero 已提交
1790
		/**
1791
		 * Same as webContents.showDefinitionForSelection().
B
Benjamin Pasero 已提交
1792
		 */
1793
		showDefinitionForSelection(): void;
B
Benjamin Pasero 已提交
1794
		/**
1795
		 * Shows the window but doesn't focus on it.
B
Benjamin Pasero 已提交
1796
		 */
1797
		showInactive(): void;
1798 1799 1800 1801 1802
		/**
		 * Toggles the visibility of the tab bar if native tabs are enabled and there is
		 * only one tab in the current window.
		 */
		toggleTabBar(): void;
B
Benjamin Pasero 已提交
1803
		/**
1804
		 * Unhooks all of the window messages.
B
Benjamin Pasero 已提交
1805
		 */
1806
		unhookAllWindowMessages(): void;
B
Benjamin Pasero 已提交
1807
		/**
1808
		 * Unhook the window message.
B
Benjamin Pasero 已提交
1809
		 */
1810
		unhookWindowMessage(message: number): void;
1811
		/**
1812
		 * Unmaximizes the window.
1813
		 */
1814 1815 1816 1817 1818 1819 1820 1821 1822
		unmaximize(): void;
		id: number;
		webContents: WebContents;
	}

	class BrowserWindowProxy extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/browser-window-proxy

B
Benjamin Pasero 已提交
1823
		/**
1824
		 * Removes focus from the child window.
B
Benjamin Pasero 已提交
1825
		 */
1826
		blur(): void;
B
Benjamin Pasero 已提交
1827
		/**
1828
		 * Forcefully closes the child window without calling its unload event.
B
Benjamin Pasero 已提交
1829
		 */
1830
		close(): void;
B
Benjamin Pasero 已提交
1831
		/**
1832
		 * Evaluates the code in the child window.
B
Benjamin Pasero 已提交
1833
		 */
1834
		eval(code: string): void;
B
Benjamin Pasero 已提交
1835
		/**
1836
		 * Focuses the child window (brings the window to front).
B
Benjamin Pasero 已提交
1837
		 */
1838
		focus(): void;
B
Benjamin Pasero 已提交
1839
		/**
1840 1841 1842
		 * Sends a message to the child window with the specified origin or * for no origin
		 * preference. In addition to these methods, the child window implements
		 * window.opener object with no properties and a single method.
B
Benjamin Pasero 已提交
1843
		 */
1844
		postMessage(message: string, targetOrigin: string): void;
B
Benjamin Pasero 已提交
1845
		/**
1846
		 * Invokes the print dialog on the child window.
B
Benjamin Pasero 已提交
1847
		 */
1848 1849 1850 1851 1852 1853 1854 1855
		print(): void;
		closed: boolean;
	}

	interface Certificate {

		// Docs: http://electron.atom.io/docs/api/structures/certificate

B
Benjamin Pasero 已提交
1856
		/**
1857
		 * PEM encoded data
B
Benjamin Pasero 已提交
1858
		 */
1859
		data: string;
B
Benjamin Pasero 已提交
1860
		/**
1861
		 * Fingerprint of the certificate
B
Benjamin Pasero 已提交
1862
		 */
1863
		fingerprint: string;
B
Benjamin Pasero 已提交
1864
		/**
1865
		 * Issuer principal
B
Benjamin Pasero 已提交
1866
		 */
1867
		issuer: CertificatePrincipal;
B
Benjamin Pasero 已提交
1868
		/**
1869
		 * Issuer certificate (if not self-signed)
B
Benjamin Pasero 已提交
1870
		 */
1871
		issuerCert: Certificate;
B
Benjamin Pasero 已提交
1872
		/**
1873
		 * Issuer's Common Name
B
Benjamin Pasero 已提交
1874
		 */
1875
		issuerName: string;
B
Benjamin Pasero 已提交
1876
		/**
1877
		 * Hex value represented string
B
Benjamin Pasero 已提交
1878
		 */
1879
		serialNumber: string;
B
Benjamin Pasero 已提交
1880
		/**
1881
		 * Subject principal
B
Benjamin Pasero 已提交
1882
		 */
1883
		subject: CertificatePrincipal;
B
Benjamin Pasero 已提交
1884
		/**
1885
		 * Subject's Common Name
B
Benjamin Pasero 已提交
1886
		 */
1887
		subjectName: string;
B
Benjamin Pasero 已提交
1888
		/**
1889
		 * End date of the certificate being valid in seconds
B
Benjamin Pasero 已提交
1890
		 */
1891
		validExpiry: number;
B
Benjamin Pasero 已提交
1892
		/**
1893
		 * Start date of the certificate being valid in seconds
B
Benjamin Pasero 已提交
1894
		 */
1895 1896 1897 1898 1899 1900 1901
		validStart: number;
	}

	interface CertificatePrincipal {

		// Docs: http://electron.atom.io/docs/api/structures/certificate-principal

B
Benjamin Pasero 已提交
1902
		/**
1903
		 * Common Name
B
Benjamin Pasero 已提交
1904
		 */
1905
		commonName: string;
B
Benjamin Pasero 已提交
1906
		/**
1907
		 * Country or region
B
Benjamin Pasero 已提交
1908
		 */
1909
		country: string;
B
Benjamin Pasero 已提交
1910
		/**
1911
		 * Locality
B
Benjamin Pasero 已提交
1912
		 */
1913
		locality: string;
B
Benjamin Pasero 已提交
1914
		/**
1915
		 * Organization names
B
Benjamin Pasero 已提交
1916
		 */
1917
		organizations: string[];
B
Benjamin Pasero 已提交
1918
		/**
1919
		 * Organization Unit names
B
Benjamin Pasero 已提交
1920
		 */
1921
		organizationUnits: string[];
B
Benjamin Pasero 已提交
1922
		/**
1923
		 * State or province
B
Benjamin Pasero 已提交
1924
		 */
1925 1926 1927 1928 1929 1930 1931
		state: string;
	}

	class ClientRequest extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/client-request

B
Benjamin Pasero 已提交
1932
		/**
1933 1934
		 * Emitted when the request is aborted. The abort event will not be fired if the
		 * request is already closed.
B
Benjamin Pasero 已提交
1935
		 */
1936 1937 1938 1939
		on(event: 'abort', listener: Function): this;
		once(event: 'abort', listener: Function): this;
		addListener(event: 'abort', listener: Function): this;
		removeListener(event: 'abort', listener: Function): this;
B
Benjamin Pasero 已提交
1940
		/**
1941 1942 1943
		 * Emitted as the last event in the HTTP request-response transaction. The close
		 * event indicates that no more events will be emitted on either the request or
		 * response objects.
B
Benjamin Pasero 已提交
1944
		 */
1945 1946 1947 1948
		on(event: 'close', listener: Function): this;
		once(event: 'close', listener: Function): this;
		addListener(event: 'close', listener: Function): this;
		removeListener(event: 'close', listener: Function): this;
B
Benjamin Pasero 已提交
1949
		/**
1950 1951 1952
		 * Emitted when the net module fails to issue a network request. Typically when the
		 * request object emits an error event, a close event will subsequently follow and
		 * no response object will be provided.
B
Benjamin Pasero 已提交
1953
		 */
1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973
		on(event: 'error', listener: (
			/**
			 * an error object providing some information about the failure.
			 */
			error: Error) => void): this;
		once(event: 'error', listener: (
			/**
			 * an error object providing some information about the failure.
			 */
			error: Error) => void): this;
		addListener(event: 'error', listener: (
			/**
			 * an error object providing some information about the failure.
			 */
			error: Error) => void): this;
		removeListener(event: 'error', listener: (
			/**
			 * an error object providing some information about the failure.
			 */
			error: Error) => void): this;
B
Benjamin Pasero 已提交
1974
		/**
1975 1976
		 * Emitted just after the last chunk of the request's data has been written into
		 * the request object.
B
Benjamin Pasero 已提交
1977
		 */
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035
		on(event: 'finish', listener: Function): this;
		once(event: 'finish', listener: Function): this;
		addListener(event: 'finish', listener: Function): this;
		removeListener(event: 'finish', listener: Function): this;
		/**
		 * Emitted when an authenticating proxy is asking for user credentials. The
		 * callback function is expected to be called back with user credentials: Providing
		 * empty credentials will cancel the request and report an authentication error on
		 * the response object:
		 */
		on(event: 'login', listener: (authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		once(event: 'login', listener: (authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		addListener(event: 'login', listener: (authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		removeListener(event: 'login', listener: (authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		/**
		 * Emitted when there is redirection and the mode is manual. Calling
		 * request.followRedirect will continue with the redirection.
		 */
		on(event: 'redirect', listener: (statusCode: number,
			method: string,
			redirectUrl: string,
			responseHeaders: any) => void): this;
		once(event: 'redirect', listener: (statusCode: number,
			method: string,
			redirectUrl: string,
			responseHeaders: any) => void): this;
		addListener(event: 'redirect', listener: (statusCode: number,
			method: string,
			redirectUrl: string,
			responseHeaders: any) => void): this;
		removeListener(event: 'redirect', listener: (statusCode: number,
			method: string,
			redirectUrl: string,
			responseHeaders: any) => void): this;
		on(event: 'response', listener: (
			/**
			 * An object representing the HTTP response message.
			 */
			response: IncomingMessage) => void): this;
		once(event: 'response', listener: (
			/**
			 * An object representing the HTTP response message.
			 */
			response: IncomingMessage) => void): this;
		addListener(event: 'response', listener: (
			/**
			 * An object representing the HTTP response message.
			 */
			response: IncomingMessage) => void): this;
		removeListener(event: 'response', listener: (
			/**
			 * An object representing the HTTP response message.
			 */
			response: IncomingMessage) => void): this;
2036
		constructor(options: 'method' | 'url' | 'session' | 'partition' | 'protocol' | 'host' | 'hostname' | 'port' | 'path' | 'redirect');
B
Benjamin Pasero 已提交
2037
		/**
2038 2039 2040 2041
		 * Cancels an ongoing HTTP transaction. If the request has already emitted the
		 * close event, the abort operation will have no effect. Otherwise an ongoing event
		 * will emit abort and close events. Additionally, if there is an ongoing response
		 * object,it will emit the aborted event.
B
Benjamin Pasero 已提交
2042
		 */
2043
		abort(): void;
B
Benjamin Pasero 已提交
2044
		/**
2045 2046
		 * Sends the last chunk of the request data. Subsequent write or end operations
		 * will not be allowed. The finish event is emitted just after the end operation.
B
Benjamin Pasero 已提交
2047
		 */
2048
		end(chunk?: string | Buffer, encoding?: string, callback?: Function): void;
B
Benjamin Pasero 已提交
2049
		/**
2050
		 * Continues any deferred redirection request when the redirection mode is manual.
B
Benjamin Pasero 已提交
2051
		 */
2052 2053
		followRedirect(): void;
		getHeader(name: string): Header;
2054 2055 2056 2057 2058
		/**
		 * You can use this method in conjunction with POST requests to get the progress of
		 * a file upload or other data transfer.
		 */
		getUploadProgress(): UploadProgress;
B
Benjamin Pasero 已提交
2059
		/**
2060 2061
		 * Removes a previously set extra header name. This method can be called only
		 * before first write. Trying to call it after the first write will throw an error.
B
Benjamin Pasero 已提交
2062
		 */
2063
		removeHeader(name: string): void;
B
Benjamin Pasero 已提交
2064
		/**
2065 2066 2067 2068
		 * Adds an extra HTTP header. The header name will issued as it is without
		 * lowercasing. It can be called only before first write. Calling this method after
		 * the first write will throw an error. If the passed value is not a String, its
		 * toString() method will be called to obtain the final value.
B
Benjamin Pasero 已提交
2069
		 */
2070
		setHeader(name: string, value: any): void;
B
Benjamin Pasero 已提交
2071
		/**
2072 2073 2074 2075 2076 2077 2078 2079
		 * callback is essentially a dummy function introduced in the purpose of keeping
		 * similarity with the Node.js API. It is called asynchronously in the next tick
		 * after chunk content have been delivered to the Chromium networking layer.
		 * Contrary to the Node.js implementation, it is not guaranteed that chunk content
		 * have been flushed on the wire before callback is called. Adds a chunk of data to
		 * the request body. The first write operation may cause the request headers to be
		 * issued on the wire. After the first write operation, it is not allowed to add or
		 * remove a custom header.
B
Benjamin Pasero 已提交
2080
		 */
2081 2082 2083 2084 2085 2086 2087 2088 2089
		write(chunk: string | Buffer, encoding?: string, callback?: Function): void;
		chunkedEncoding: boolean;
	}

	interface Clipboard extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/clipboard

		availableFormats(type?: string): string[];
B
Benjamin Pasero 已提交
2090
		/**
2091
		 * Clears the clipboard content.
B
Benjamin Pasero 已提交
2092
		 */
2093 2094 2095
		clear(type?: string): void;
		has(format: string, type?: string): boolean;
		read(format: string): string;
B
Benjamin Pasero 已提交
2096
		/**
2097 2098 2099
		 * Returns an Object containing title and url keys representing the bookmark in the
		 * clipboard. The title and url values will be empty strings when the bookmark is
		 * unavailable.
B
Benjamin Pasero 已提交
2100
		 */
2101 2102 2103 2104 2105 2106 2107
		readBookmark(): ReadBookmark;
		readBuffer(format: string): Buffer;
		readFindText(): string;
		readHTML(type?: string): string;
		readImage(type?: string): NativeImage;
		readRTF(type?: string): string;
		readText(type?: string): string;
B
Benjamin Pasero 已提交
2108
		/**
2109
		 * Writes data to the clipboard.
B
Benjamin Pasero 已提交
2110
		 */
2111
		write(data: Data, type?: string): void;
B
Benjamin Pasero 已提交
2112
		/**
2113 2114 2115
		 * Writes the title and url into the clipboard as a bookmark. Note: Most apps on
		 * Windows don't support pasting bookmarks into them so you can use clipboard.write
		 * to write both a bookmark and fallback text to the clipboard.
B
Benjamin Pasero 已提交
2116
		 */
2117
		writeBookmark(title: string, url: string, type?: string): void;
B
Benjamin Pasero 已提交
2118
		/**
2119
		 * Writes the buffer into the clipboard as format.
B
Benjamin Pasero 已提交
2120
		 */
2121
		writeBuffer(format: string, buffer: Buffer, type?: string): void;
B
Benjamin Pasero 已提交
2122
		/**
2123 2124
		 * Writes the text into the find pasteboard as plain text. This method uses
		 * synchronous IPC when called from the renderer process.
B
Benjamin Pasero 已提交
2125
		 */
2126
		writeFindText(text: string): void;
B
Benjamin Pasero 已提交
2127
		/**
2128
		 * Writes markup to the clipboard.
B
Benjamin Pasero 已提交
2129
		 */
2130
		writeHTML(markup: string, type?: string): void;
B
Benjamin Pasero 已提交
2131
		/**
2132
		 * Writes image to the clipboard.
B
Benjamin Pasero 已提交
2133
		 */
2134
		writeImage(image: NativeImage, type?: string): void;
B
Benjamin Pasero 已提交
2135
		/**
2136
		 * Writes the text into the clipboard in RTF.
B
Benjamin Pasero 已提交
2137
		 */
2138
		writeRTF(text: string, type?: string): void;
B
Benjamin Pasero 已提交
2139
		/**
2140
		 * Writes the text into the clipboard as plain text.
B
Benjamin Pasero 已提交
2141
		 */
2142 2143 2144 2145 2146 2147 2148
		writeText(text: string, type?: string): void;
	}

	interface ContentTracing extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/content-tracing

B
Benjamin Pasero 已提交
2149
		/**
2150 2151 2152 2153 2154 2155 2156
		 * Get the current monitoring traced data. Child processes typically cache trace
		 * data and only rarely flush and send trace data back to the main process. This is
		 * because it may be an expensive operation to send the trace data over IPC and we
		 * would like to avoid unneeded runtime overhead from tracing. So, to end tracing,
		 * we must asynchronously ask all child processes to flush any pending trace data.
		 * Once all child processes have acknowledged the captureMonitoringSnapshot request
		 * the callback will be called with a file that contains the traced data.
B
Benjamin Pasero 已提交
2157
		 */
2158
		captureMonitoringSnapshot(resultFilePath: string, callback: (resultFilePath: string) => void): void;
B
Benjamin Pasero 已提交
2159
		/**
2160 2161 2162
		 * Get a set of category groups. The category groups can change as new code paths
		 * are reached. Once all child processes have acknowledged the getCategories
		 * request the callback is invoked with an array of category groups.
B
Benjamin Pasero 已提交
2163
		 */
2164
		getCategories(callback: (categories: string[]) => void): void;
B
Benjamin Pasero 已提交
2165
		/**
2166 2167 2168
		 * Get the maximum usage across processes of trace buffer as a percentage of the
		 * full state. When the TraceBufferUsage value is determined the callback is
		 * called.
B
Benjamin Pasero 已提交
2169
		 */
2170
		getTraceBufferUsage(callback: (value: number, percentage: number) => void): void;
B
Benjamin Pasero 已提交
2171
		/**
2172 2173 2174 2175
		 * Start monitoring on all processes. Monitoring begins immediately locally and
		 * asynchronously on child processes as soon as they receive the startMonitoring
		 * request. Once all child processes have acknowledged the startMonitoring request
		 * the callback will be called.
B
Benjamin Pasero 已提交
2176
		 */
2177
		startMonitoring(options: StartMonitoringOptions, callback: Function): void;
B
Benjamin Pasero 已提交
2178
		/**
2179 2180 2181
		 * Start recording on all processes. Recording begins immediately locally and
		 * asynchronously on child processes as soon as they receive the EnableRecording
		 * request. The callback will be called once all child processes have acknowledged
2182 2183 2184
		 * the startRecording request.
		 */
		startRecording(options: TraceCategoriesAndOptions | TraceConfig, callback: Function): void;
B
Benjamin Pasero 已提交
2185
		/**
2186 2187
		 * Stop monitoring on all processes. Once all child processes have acknowledged the
		 * stopMonitoring request the callback is called.
B
Benjamin Pasero 已提交
2188
		 */
2189
		stopMonitoring(callback: Function): void;
B
Benjamin Pasero 已提交
2190
		/**
2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207
		 * Stop recording on all processes. Child processes typically cache trace data and
		 * only rarely flush and send trace data back to the main process. This helps to
		 * minimize the runtime overhead of tracing since sending trace data over IPC can
		 * be an expensive operation. So, to end tracing, we must asynchronously ask all
		 * child processes to flush any pending trace data. Once all child processes have
		 * acknowledged the stopRecording request, callback will be called with a file that
		 * contains the traced data. Trace data will be written into resultFilePath if it
		 * is not empty or into a temporary file. The actual file path will be passed to
		 * callback if it's not null.
		 */
		stopRecording(resultFilePath: string, callback: (resultFilePath: string) => void): void;
	}

	interface Cookie {

		// Docs: http://electron.atom.io/docs/api/structures/cookie

B
Benjamin Pasero 已提交
2208
		/**
2209
		 * The domain of the cookie.
B
Benjamin Pasero 已提交
2210
		 */
2211
		domain?: string;
B
Benjamin Pasero 已提交
2212
		/**
2213 2214
		 * The expiration date of the cookie as the number of seconds since the UNIX epoch.
		 * Not provided for session cookies.
B
Benjamin Pasero 已提交
2215
		 */
2216
		expirationDate?: number;
2217
		/**
2218
		 * Whether the cookie is a host-only cookie.
2219
		 */
2220
		hostOnly?: boolean;
B
Benjamin Pasero 已提交
2221
		/**
2222
		 * Whether the cookie is marked as HTTP only.
B
Benjamin Pasero 已提交
2223
		 */
2224
		httpOnly?: boolean;
B
Benjamin Pasero 已提交
2225
		/**
2226
		 * The name of the cookie.
B
Benjamin Pasero 已提交
2227
		 */
2228
		name: string;
B
Benjamin Pasero 已提交
2229
		/**
2230
		 * The path of the cookie.
B
Benjamin Pasero 已提交
2231
		 */
2232
		path?: string;
B
Benjamin Pasero 已提交
2233
		/**
2234
		 * Whether the cookie is marked as secure.
B
Benjamin Pasero 已提交
2235
		 */
2236
		secure?: boolean;
B
Benjamin Pasero 已提交
2237
		/**
2238 2239
		 * Whether the cookie is a session cookie or a persistent cookie with an expiration
		 * date.
B
Benjamin Pasero 已提交
2240
		 */
2241
		session?: boolean;
B
Benjamin Pasero 已提交
2242
		/**
2243
		 * The value of the cookie.
B
Benjamin Pasero 已提交
2244
		 */
2245 2246 2247 2248 2249 2250 2251
		value: string;
	}

	class Cookies extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/cookies

B
Benjamin Pasero 已提交
2252
		/**
2253 2254
		 * Emitted when a cookie is changed because it was added, edited, removed, or
		 * expired.
B
Benjamin Pasero 已提交
2255
		 */
2256 2257
		on(event: 'changed', listener: (event: Event,
			/**
2258
			 * The cookie that was changed.
2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270
			 */
			cookie: Cookie,
			/**
			 * The cause of the change with one of the following values:
			 */
			cause: ('explicit' | 'overwrite' | 'expired' | 'evicted' | 'expired-overwrite'),
			/**
			 * `true` if the cookie was removed, `false` otherwise.
			 */
			removed: boolean) => void): this;
		once(event: 'changed', listener: (event: Event,
			/**
2271
			 * The cookie that was changed.
2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283
			 */
			cookie: Cookie,
			/**
			 * The cause of the change with one of the following values:
			 */
			cause: ('explicit' | 'overwrite' | 'expired' | 'evicted' | 'expired-overwrite'),
			/**
			 * `true` if the cookie was removed, `false` otherwise.
			 */
			removed: boolean) => void): this;
		addListener(event: 'changed', listener: (event: Event,
			/**
2284
			 * The cookie that was changed.
2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296
			 */
			cookie: Cookie,
			/**
			 * The cause of the change with one of the following values:
			 */
			cause: ('explicit' | 'overwrite' | 'expired' | 'evicted' | 'expired-overwrite'),
			/**
			 * `true` if the cookie was removed, `false` otherwise.
			 */
			removed: boolean) => void): this;
		removeListener(event: 'changed', listener: (event: Event,
			/**
2297
			 * The cookie that was changed.
2298 2299 2300 2301 2302 2303 2304 2305 2306 2307
			 */
			cookie: Cookie,
			/**
			 * The cause of the change with one of the following values:
			 */
			cause: ('explicit' | 'overwrite' | 'expired' | 'evicted' | 'expired-overwrite'),
			/**
			 * `true` if the cookie was removed, `false` otherwise.
			 */
			removed: boolean) => void): this;
B
Benjamin Pasero 已提交
2308
		/**
2309
		 * Writes any unwritten cookies data to disk.
B
Benjamin Pasero 已提交
2310
		 */
2311
		flushStore(callback: Function): void;
B
Benjamin Pasero 已提交
2312
		/**
2313 2314
		 * Sends a request to get all cookies matching filter, callback will be called with
		 * callback(error, cookies) on complete.
B
Benjamin Pasero 已提交
2315
		 */
2316
		get(filter: Filter, callback: (error: Error, cookies: Cookie[]) => void): void;
B
Benjamin Pasero 已提交
2317
		/**
2318 2319
		 * Removes the cookies matching url and name, callback will called with callback()
		 * on complete.
B
Benjamin Pasero 已提交
2320
		 */
2321
		remove(url: string, name: string, callback: Function): void;
B
Benjamin Pasero 已提交
2322
		/**
2323 2324
		 * Sets a cookie with details, callback will be called with callback(error) on
		 * complete.
B
Benjamin Pasero 已提交
2325
		 */
2326 2327 2328 2329 2330 2331 2332
		set(details: Details, callback: (error: Error) => void): void;
	}

	interface CPUUsage {

		// Docs: http://electron.atom.io/docs/api/structures/cpu-usage

B
Benjamin Pasero 已提交
2333
		/**
2334
		 * The number of average idle cpu wakeups per second since the last call to
2335
		 * getCPUUsage. First call returns 0. Will always return 0 on Windows.
B
Benjamin Pasero 已提交
2336
		 */
2337
		idleWakeupsPerSecond: number;
B
Benjamin Pasero 已提交
2338
		/**
2339
		 * Percentage of CPU used since the last call to getCPUUsage. First call returns 0.
B
Benjamin Pasero 已提交
2340
		 */
2341
		percentCPUUsage: number;
B
Benjamin Pasero 已提交
2342 2343
	}

2344 2345 2346
	interface CrashReport {

		// Docs: http://electron.atom.io/docs/api/structures/crash-report
B
Benjamin Pasero 已提交
2347

2348 2349
		date: Date;
		id: string;
B
Benjamin Pasero 已提交
2350 2351
	}

2352 2353 2354
	interface CrashReporter extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/crash-reporter
B
Benjamin Pasero 已提交
2355

2356 2357 2358 2359 2360 2361 2362 2363
		/**
		 * Set an extra parameter to be sent with the crash report. The values specified
		 * here will be sent in addition to any values set via the extra option when start
		 * was called. This API is only available on macOS, if you need to add/update extra
		 * parameters on Linux and Windows after your first call to start you can call
		 * start again with the updated extra options.
		 */
		addExtraParameter(key: string, value: string): void;
2364
		/**
2365 2366
		 * Returns the date and ID of the last crash report. If no crash reports have been
		 * sent or the crash reporter has not been started, null is returned.
2367
		 */
2368
		getLastCrashReport(): CrashReport;
2369 2370 2371 2372
		/**
		 * See all of the current parameters being passed to the crash reporter.
		 */
		getParameters(): void;
B
Benjamin Pasero 已提交
2373
		/**
2374 2375
		 * Returns all uploaded crash reports. Each report contains the date and uploaded
		 * ID.
B
Benjamin Pasero 已提交
2376
		 */
2377
		getUploadedReports(): CrashReport[];
B
Benjamin Pasero 已提交
2378
		/**
2379 2380 2381 2382
		 * Note: This API can only be called from the main process.
		 */
		getUploadToServer(): boolean;
		/**
2383 2384
		 * Remove a extra parameter from the current set of parameters so that it will not
		 * be sent with the crash report.
2385
		 */
2386
		removeExtraParameter(key: string): void;
2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406
		/**
		 * This would normally be controlled by user preferences. This has no effect if
		 * called before start is called. Note: This API can only be called from the main
		 * process.
		 */
		setUploadToServer(uploadToServer: boolean): void;
		/**
		 * You are required to call this method before using any other crashReporter APIs
		 * and in each process (main/renderer) from which you want to collect crash
		 * reports. You can pass different options to crashReporter.start when calling from
		 * different processes. Note Child processes created via the child_process module
		 * will not have access to the Electron modules. Therefore, to collect crash
		 * reports from them, use process.crashReporter.start instead. Pass the same
		 * options as above along with an additional one called crashesDirectory that
		 * should point to a directory to store the crash reports temporarily. You can test
		 * this out by calling process.crash() to crash the child process. Note: To collect
		 * crash reports from child process in Windows, you need to add this extra code as
		 * well. This will start the process that will monitor and send the crash reports.
		 * Replace submitURL, productName and crashesDirectory with appropriate values.
		 * Note: If you need send additional/updated extra parameters after your first call
2407
		 * start you can call addExtraParameter on macOS or call start again with the
2408 2409 2410 2411 2412 2413 2414 2415
		 * new/updated extra parameters on Linux and Windows. Note: On macOS, Electron uses
		 * a new crashpad client for crash collection and reporting. If you want to enable
		 * crash reporting, initializing crashpad from the main process using
		 * crashReporter.start is required regardless of which process you want to collect
		 * crashes from. Once initialized this way, the crashpad handler collects crashes
		 * from all processes. You still have to call crashReporter.start from the renderer
		 * or child process, otherwise crashes from them will get reported without
		 * companyName, productName or any of the extra information.
B
Benjamin Pasero 已提交
2416
		 */
2417
		start(options: CrashReporterStartOptions): void;
B
Benjamin Pasero 已提交
2418 2419
	}

2420
	class Debugger extends EventEmitter {
B
Benjamin Pasero 已提交
2421

2422
		// Docs: http://electron.atom.io/docs/api/debugger
B
Benjamin Pasero 已提交
2423 2424

		/**
2425 2426
		 * Emitted when debugging session is terminated. This happens either when
		 * webContents is closed or devtools is invoked for the attached webContents.
B
Benjamin Pasero 已提交
2427
		 */
2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447
		on(event: 'detach', listener: (event: Event,
			/**
			 * Reason for detaching debugger.
			 */
			reason: string) => void): this;
		once(event: 'detach', listener: (event: Event,
			/**
			 * Reason for detaching debugger.
			 */
			reason: string) => void): this;
		addListener(event: 'detach', listener: (event: Event,
			/**
			 * Reason for detaching debugger.
			 */
			reason: string) => void): this;
		removeListener(event: 'detach', listener: (event: Event,
			/**
			 * Reason for detaching debugger.
			 */
			reason: string) => void): this;
B
Benjamin Pasero 已提交
2448
		/**
2449
		 * Emitted whenever debugging target issues instrumentation event.
B
Benjamin Pasero 已提交
2450
		 */
2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490
		on(event: 'message', listener: (event: Event,
			/**
			 * Method name.
			 */
			method: string,
			/**
			 * Event parameters defined by the 'parameters' attribute in the remote debugging
			 * protocol.
			 */
			params: any) => void): this;
		once(event: 'message', listener: (event: Event,
			/**
			 * Method name.
			 */
			method: string,
			/**
			 * Event parameters defined by the 'parameters' attribute in the remote debugging
			 * protocol.
			 */
			params: any) => void): this;
		addListener(event: 'message', listener: (event: Event,
			/**
			 * Method name.
			 */
			method: string,
			/**
			 * Event parameters defined by the 'parameters' attribute in the remote debugging
			 * protocol.
			 */
			params: any) => void): this;
		removeListener(event: 'message', listener: (event: Event,
			/**
			 * Method name.
			 */
			method: string,
			/**
			 * Event parameters defined by the 'parameters' attribute in the remote debugging
			 * protocol.
			 */
			params: any) => void): this;
B
Benjamin Pasero 已提交
2491
		/**
2492
		 * Attaches the debugger to the webContents.
B
Benjamin Pasero 已提交
2493
		 */
2494
		attach(protocolVersion?: string): void;
B
Benjamin Pasero 已提交
2495
		/**
2496
		 * Detaches the debugger from the webContents.
B
Benjamin Pasero 已提交
2497
		 */
2498 2499
		detach(): void;
		isAttached(): boolean;
B
Benjamin Pasero 已提交
2500
		/**
2501
		 * Send given command to the debugging target.
B
Benjamin Pasero 已提交
2502
		 */
2503 2504 2505 2506 2507 2508 2509
		sendCommand(method: string, commandParams?: any, callback?: (error: any, result: any) => void): void;
	}

	interface DesktopCapturer extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/desktop-capturer

B
Benjamin Pasero 已提交
2510
		/**
2511 2512 2513 2514
		 * Starts gathering information about all available desktop media sources, and
		 * calls callback(error, sources) when finished. sources is an array of
		 * DesktopCapturerSource objects, each DesktopCapturerSource represents a screen or
		 * an individual window that can be captured.
B
Benjamin Pasero 已提交
2515
		 */
2516 2517 2518 2519 2520 2521 2522
		getSources(options: SourcesOptions, callback: (error: Error, sources: DesktopCapturerSource[]) => void): void;
	}

	interface DesktopCapturerSource {

		// Docs: http://electron.atom.io/docs/api/structures/desktop-capturer-source

2523 2524 2525 2526 2527 2528
		/**
		 * A unique identifier that will correspond to the id of the matching returned by
		 * the . On some platforms, this is equivalent to the XX portion of the id field
		 * above and on others it will differ. It will be an empty string if not available.
		 */
		display_id: string;
B
Benjamin Pasero 已提交
2529
		/**
2530 2531 2532 2533
		 * The identifier of a window or screen that can be used as a chromeMediaSourceId
		 * constraint when calling [navigator.webkitGetUserMedia]. The format of the
		 * identifier will be window:XX or screen:XX, where XX is a random generated
		 * number.
B
Benjamin Pasero 已提交
2534
		 */
2535
		id: string;
B
Benjamin Pasero 已提交
2536
		/**
2537 2538
		 * A screen source will be named either Entire Screen or Screen <index>, while the
		 * name of a window source will match the window title.
B
Benjamin Pasero 已提交
2539
		 */
2540
		name: string;
B
Benjamin Pasero 已提交
2541
		/**
2542 2543 2544 2545
		 * A thumbnail image. There is no guarantee that the size of the thumbnail is the
		 * same as the thumbnailSize specified in the options passed to
		 * desktopCapturer.getSources. The actual size depends on the scale of the screen
		 * or window.
B
Benjamin Pasero 已提交
2546
		 */
2547 2548 2549 2550 2551 2552 2553
		thumbnail: NativeImage;
	}

	interface Dialog extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/dialog

B
Benjamin Pasero 已提交
2554
		/**
2555 2556 2557 2558 2559
		 * On macOS, this displays a modal dialog that shows a message and certificate
		 * information, and gives the user the option of trusting/importing the
		 * certificate. If you provide a browserWindow argument the dialog will be attached
		 * to the parent window, making it modal. On Windows the options are more limited,
		 * due to the Win32 APIs used:
B
Benjamin Pasero 已提交
2560
		 */
2561
		showCertificateTrustDialog(browserWindow: BrowserWindow, options: CertificateTrustDialogOptions, callback: Function): void;
B
Benjamin Pasero 已提交
2562
		/**
2563 2564 2565 2566 2567
		 * On macOS, this displays a modal dialog that shows a message and certificate
		 * information, and gives the user the option of trusting/importing the
		 * certificate. If you provide a browserWindow argument the dialog will be attached
		 * to the parent window, making it modal. On Windows the options are more limited,
		 * due to the Win32 APIs used:
B
Benjamin Pasero 已提交
2568
		 */
2569
		showCertificateTrustDialog(options: CertificateTrustDialogOptions, callback: Function): void;
B
Benjamin Pasero 已提交
2570
		/**
2571 2572 2573 2574 2575
		 * On macOS, this displays a modal dialog that shows a message and certificate
		 * information, and gives the user the option of trusting/importing the
		 * certificate. If you provide a browserWindow argument the dialog will be attached
		 * to the parent window, making it modal. On Windows the options are more limited,
		 * due to the Win32 APIs used:
B
Benjamin Pasero 已提交
2576
		 */
2577
		showCertificateTrustDialog(browserWindow: BrowserWindow, options: CertificateTrustDialogOptions, callback: Function): void;
B
Benjamin Pasero 已提交
2578
		/**
2579 2580
		 * Displays a modal dialog that shows an error message. This API can be called
		 * safely before the ready event the app module emits, it is usually used to report
2581
		 * errors in early stage of startup. If called before the app readyevent on Linux,
2582
		 * the message will be emitted to stderr, and no GUI dialog will appear.
B
Benjamin Pasero 已提交
2583
		 */
2584
		showErrorBox(title: string, content: string): void;
B
Benjamin Pasero 已提交
2585
		/**
2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608
		 * Shows a message box, it will block the process until the message box is closed.
		 * It returns the index of the clicked button. The browserWindow argument allows
		 * the dialog to attach itself to a parent window, making it modal. If a callback
		 * is passed, the dialog will not block the process. The API call will be
		 * asynchronous and the result will be passed via callback(response).
		 */
		showMessageBox(browserWindow: BrowserWindow, options: MessageBoxOptions, callback?: (response: number, checkboxChecked: boolean) => void): number;
		/**
		 * Shows a message box, it will block the process until the message box is closed.
		 * It returns the index of the clicked button. The browserWindow argument allows
		 * the dialog to attach itself to a parent window, making it modal. If a callback
		 * is passed, the dialog will not block the process. The API call will be
		 * asynchronous and the result will be passed via callback(response).
		 */
		showMessageBox(options: MessageBoxOptions, callback?: (response: number, checkboxChecked: boolean) => void): number;
		/**
		 * The browserWindow argument allows the dialog to attach itself to a parent
		 * window, making it modal. The filters specifies an array of file types that can
		 * be displayed or selected when you want to limit the user to a specific type. For
		 * example: The extensions array should contain extensions without wildcards or
		 * dots (e.g. 'png' is good but '.png' and '*.png' are bad). To show all files, use
		 * the '*' wildcard (no other wildcard is supported). If a callback is passed, the
		 * API call will be asynchronous and the result will be passed via
2609
		 * callback(filenames). Note: On Windows and Linux an open dialog can not be both a
2610 2611 2612
		 * file selector and a directory selector, so if you set properties to ['openFile',
		 * 'openDirectory'] on these platforms, a directory selector will be shown.
		 */
2613
		showOpenDialog(browserWindow: BrowserWindow, options: OpenDialogOptions, callback?: (filePaths: string[], bookmarks: string[]) => void): string[];
2614 2615 2616 2617 2618 2619 2620 2621
		/**
		 * The browserWindow argument allows the dialog to attach itself to a parent
		 * window, making it modal. The filters specifies an array of file types that can
		 * be displayed or selected when you want to limit the user to a specific type. For
		 * example: The extensions array should contain extensions without wildcards or
		 * dots (e.g. 'png' is good but '.png' and '*.png' are bad). To show all files, use
		 * the '*' wildcard (no other wildcard is supported). If a callback is passed, the
		 * API call will be asynchronous and the result will be passed via
2622
		 * callback(filenames). Note: On Windows and Linux an open dialog can not be both a
2623 2624 2625
		 * file selector and a directory selector, so if you set properties to ['openFile',
		 * 'openDirectory'] on these platforms, a directory selector will be shown.
		 */
2626
		showOpenDialog(options: OpenDialogOptions, callback?: (filePaths: string[], bookmarks: string[]) => void): string[];
2627 2628 2629 2630 2631
		/**
		 * The browserWindow argument allows the dialog to attach itself to a parent
		 * window, making it modal. The filters specifies an array of file types that can
		 * be displayed, see dialog.showOpenDialog for an example. If a callback is passed,
		 * the API call will be asynchronous and the result will be passed via
2632
		 * callback(filename).
2633
		 */
2634
		showSaveDialog(browserWindow: BrowserWindow, options: SaveDialogOptions, callback?: (filename: string, bookmark: string) => void): string;
2635 2636 2637 2638 2639
		/**
		 * The browserWindow argument allows the dialog to attach itself to a parent
		 * window, making it modal. The filters specifies an array of file types that can
		 * be displayed, see dialog.showOpenDialog for an example. If a callback is passed,
		 * the API call will be asynchronous and the result will be passed via
2640
		 * callback(filename).
2641
		 */
2642
		showSaveDialog(options: SaveDialogOptions, callback?: (filename: string, bookmark: string) => void): string;
2643 2644 2645 2646 2647 2648 2649
	}

	interface Display {

		// Docs: http://electron.atom.io/docs/api/structures/display

		bounds: Rectangle;
B
Benjamin Pasero 已提交
2650
		/**
2651
		 * Unique identifier associated with the display.
B
Benjamin Pasero 已提交
2652
		 */
2653
		id: number;
B
Benjamin Pasero 已提交
2654
		/**
2655
		 * Can be 0, 90, 180, 270, represents screen rotation in clock-wise degrees.
B
Benjamin Pasero 已提交
2656
		 */
2657
		rotation: number;
B
Benjamin Pasero 已提交
2658
		/**
2659
		 * Output device's pixel scale factor.
B
Benjamin Pasero 已提交
2660
		 */
2661 2662
		scaleFactor: number;
		size: Size;
B
Benjamin Pasero 已提交
2663
		/**
2664
		 * Can be available, unavailable, unknown.
B
Benjamin Pasero 已提交
2665
		 */
2666 2667 2668 2669 2670 2671 2672 2673 2674
		touchSupport: ('available' | 'unavailable' | 'unknown');
		workArea: Rectangle;
		workAreaSize: Size;
	}

	class DownloadItem extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/download-item

B
Benjamin Pasero 已提交
2675
		/**
2676 2677 2678
		 * Emitted when the download is in a terminal state. This includes a completed
		 * download, a cancelled download (via downloadItem.cancel()), and interrupted
		 * download that can't be resumed. The state can be one of following:
B
Benjamin Pasero 已提交
2679
		 */
2680
		on(event: 'done', listener: (event: Event,
2681 2682 2683 2684
			/**
			 * Can be `completed`, `cancelled` or `interrupted`.
			 */
			state: ('completed' | 'cancelled' | 'interrupted')) => void): this;
2685
		once(event: 'done', listener: (event: Event,
2686 2687 2688 2689
			/**
			 * Can be `completed`, `cancelled` or `interrupted`.
			 */
			state: ('completed' | 'cancelled' | 'interrupted')) => void): this;
2690
		addListener(event: 'done', listener: (event: Event,
2691 2692 2693 2694
			/**
			 * Can be `completed`, `cancelled` or `interrupted`.
			 */
			state: ('completed' | 'cancelled' | 'interrupted')) => void): this;
2695
		removeListener(event: 'done', listener: (event: Event,
2696 2697 2698 2699
			/**
			 * Can be `completed`, `cancelled` or `interrupted`.
			 */
			state: ('completed' | 'cancelled' | 'interrupted')) => void): this;
B
Benjamin Pasero 已提交
2700
		/**
2701 2702
		 * Emitted when the download has been updated and is not done. The state can be one
		 * of following:
B
Benjamin Pasero 已提交
2703
		 */
2704
		on(event: 'updated', listener: (event: Event,
2705 2706 2707 2708
			/**
			 * Can be `progressing` or `interrupted`.
			 */
			state: ('progressing' | 'interrupted')) => void): this;
2709
		once(event: 'updated', listener: (event: Event,
2710 2711 2712 2713
			/**
			 * Can be `progressing` or `interrupted`.
			 */
			state: ('progressing' | 'interrupted')) => void): this;
2714
		addListener(event: 'updated', listener: (event: Event,
2715 2716 2717 2718
			/**
			 * Can be `progressing` or `interrupted`.
			 */
			state: ('progressing' | 'interrupted')) => void): this;
2719
		removeListener(event: 'updated', listener: (event: Event,
2720 2721 2722 2723
			/**
			 * Can be `progressing` or `interrupted`.
			 */
			state: ('progressing' | 'interrupted')) => void): this;
B
Benjamin Pasero 已提交
2724
		/**
2725
		 * Cancels the download operation.
B
Benjamin Pasero 已提交
2726
		 */
2727
		cancel(): void;
2728
		canResume(): boolean;
2729 2730
		getContentDisposition(): string;
		getETag(): string;
B
Benjamin Pasero 已提交
2731
		/**
2732 2733 2734
		 * Note: The file name is not always the same as the actual one saved in local
		 * disk. If user changes the file name in a prompted download saving dialog, the
		 * actual name of saved file will be different.
B
Benjamin Pasero 已提交
2735
		 */
2736 2737 2738 2739 2740 2741
		getFilename(): string;
		getLastModifiedTime(): string;
		getMimeType(): string;
		getReceivedBytes(): number;
		getSavePath(): string;
		getStartTime(): number;
B
Benjamin Pasero 已提交
2742
		/**
2743 2744
		 * Note: The following methods are useful specifically to resume a cancelled item
		 * when session is restarted.
B
Benjamin Pasero 已提交
2745
		 */
2746
		getState(): ('progressing' | 'completed' | 'cancelled' | 'interrupted');
B
Benjamin Pasero 已提交
2747
		/**
2748
		 * If the size is unknown, it returns 0.
B
Benjamin Pasero 已提交
2749
		 */
2750 2751 2752 2753 2754
		getTotalBytes(): number;
		getURL(): string;
		getURLChain(): string[];
		hasUserGesture(): boolean;
		isPaused(): boolean;
B
Benjamin Pasero 已提交
2755
		/**
2756
		 * Pauses the download.
B
Benjamin Pasero 已提交
2757
		 */
2758
		pause(): void;
2759
		/**
2760 2761 2762 2763
		 * Resumes the download that has been paused. Note: To enable resumable downloads
		 * the server you are downloading from must support range requests and provide both
		 * Last-Modified and ETag header values. Otherwise resume() will dismiss previously
		 * received bytes and restart the download from the beginning.
2764
		 */
2765
		resume(): void;
2766
		/**
2767 2768 2769
		 * The API is only available in session's will-download callback function. If user
		 * doesn't set the save path via the API, Electron will use the original routine to
		 * determine the save path(Usually prompts a save dialog).
2770
		 */
2771
		setSavePath(path: string): void;
B
Benjamin Pasero 已提交
2772 2773
	}

2774 2775 2776 2777 2778 2779
	interface FileFilter {

		// Docs: http://electron.atom.io/docs/api/structures/file-filter

		extensions: string[];
		name: string;
B
Benjamin Pasero 已提交
2780 2781
	}

2782 2783 2784 2785
	interface GlobalShortcut extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/global-shortcut

B
Benjamin Pasero 已提交
2786
		/**
2787 2788 2789
		 * When the accelerator is already taken by other applications, this call will
		 * still return false. This behavior is intended by operating systems, since they
		 * don't want applications to fight for global shortcuts.
B
Benjamin Pasero 已提交
2790
		 */
2791
		isRegistered(accelerator: Accelerator): boolean;
B
Benjamin Pasero 已提交
2792
		/**
2793 2794 2795 2796
		 * Registers a global shortcut of accelerator. The callback is called when the
		 * registered shortcut is pressed by the user. When the accelerator is already
		 * taken by other applications, this call will silently fail. This behavior is
		 * intended by operating systems, since they don't want applications to fight for
B
Benjamin Pasero 已提交
2797 2798 2799
		 * global shortcuts. The following accelerators will not be registered successfully
		 * on macOS 10.14 Mojave unless the app has been authorized as a trusted
		 * accessibility client:
B
Benjamin Pasero 已提交
2800
		 */
2801
		register(accelerator: Accelerator, callback: Function): void;
B
Benjamin Pasero 已提交
2802
		/**
2803
		 * Unregisters the global shortcut of accelerator.
B
Benjamin Pasero 已提交
2804
		 */
2805
		unregister(accelerator: Accelerator): void;
B
Benjamin Pasero 已提交
2806
		/**
2807
		 * Unregisters all of the global shortcuts.
B
Benjamin Pasero 已提交
2808
		 */
2809 2810 2811 2812 2813 2814 2815
		unregisterAll(): void;
	}

	interface GPUFeatureStatus {

		// Docs: http://electron.atom.io/docs/api/structures/gpu-feature-status

B
Benjamin Pasero 已提交
2816
		/**
2817
		 * Canvas
B
Benjamin Pasero 已提交
2818
		 */
2819
		'2d_canvas': string;
B
Benjamin Pasero 已提交
2820
		/**
2821
		 * Flash
B
Benjamin Pasero 已提交
2822
		 */
2823
		flash_3d: string;
B
Benjamin Pasero 已提交
2824
		/**
2825
		 * Flash Stage3D
B
Benjamin Pasero 已提交
2826
		 */
2827
		flash_stage3d: string;
B
Benjamin Pasero 已提交
2828
		/**
2829
		 * Flash Stage3D Baseline profile
B
Benjamin Pasero 已提交
2830
		 */
2831
		flash_stage3d_baseline: string;
B
Benjamin Pasero 已提交
2832
		/**
2833
		 * Compositing
B
Benjamin Pasero 已提交
2834
		 */
2835
		gpu_compositing: string;
B
Benjamin Pasero 已提交
2836
		/**
2837
		 * Multiple Raster Threads
B
Benjamin Pasero 已提交
2838
		 */
2839
		multiple_raster_threads: string;
B
Benjamin Pasero 已提交
2840
		/**
2841
		 * Native GpuMemoryBuffers
B
Benjamin Pasero 已提交
2842
		 */
2843
		native_gpu_memory_buffers: string;
B
Benjamin Pasero 已提交
2844
		/**
2845
		 * Rasterization
B
Benjamin Pasero 已提交
2846
		 */
2847
		rasterization: string;
B
Benjamin Pasero 已提交
2848
		/**
2849
		 * Video Decode
B
Benjamin Pasero 已提交
2850
		 */
2851
		video_decode: string;
B
Benjamin Pasero 已提交
2852
		/**
2853
		 * Video Encode
B
Benjamin Pasero 已提交
2854
		 */
2855
		video_encode: string;
B
Benjamin Pasero 已提交
2856
		/**
2857
		 * VPx Video Decode
B
Benjamin Pasero 已提交
2858
		 */
2859
		vpx_decode: string;
B
Benjamin Pasero 已提交
2860
		/**
2861
		 * WebGL
B
Benjamin Pasero 已提交
2862
		 */
2863
		webgl: string;
B
Benjamin Pasero 已提交
2864
		/**
2865
		 * WebGL2
B
Benjamin Pasero 已提交
2866
		 */
2867 2868 2869
		webgl2: string;
	}

2870 2871 2872 2873 2874 2875 2876 2877 2878
	interface InAppPurchase extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/in-app-purchase

		/**
		 * Emitted when one or more transactions have been updated.
		 */
		on(event: 'transactions-updated', listener: (event: Event,
			/**
2879
			 * Array of objects.
2880 2881 2882 2883
			 */
			transactions: Transaction[]) => void): this;
		once(event: 'transactions-updated', listener: (event: Event,
			/**
2884
			 * Array of objects.
2885 2886 2887 2888
			 */
			transactions: Transaction[]) => void): this;
		addListener(event: 'transactions-updated', listener: (event: Event,
			/**
2889
			 * Array of objects.
2890 2891 2892 2893
			 */
			transactions: Transaction[]) => void): this;
		removeListener(event: 'transactions-updated', listener: (event: Event,
			/**
2894
			 * Array of objects.
2895 2896 2897
			 */
			transactions: Transaction[]) => void): this;
		canMakePayments(): boolean;
2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909
		/**
		 * Completes all pending transactions.
		 */
		finishAllTransactions(): void;
		/**
		 * Completes the pending transactions corresponding to the date.
		 */
		finishTransactionByDate(date: string): void;
		/**
		 * Retrieves the product descriptions.
		 */
		getProducts(productIDs: string[], callback: (products: Product[]) => void): void;
2910
		getReceiptURL(): string;
2911 2912 2913 2914
		/**
		 * You should listen for the transactions-updated event as soon as possible and
		 * certainly before you call purchaseProduct.
		 */
2915 2916 2917
		purchaseProduct(productID: string, quantity?: number, callback?: (isProductValid: boolean) => void): void;
	}

2918 2919 2920 2921
	class IncomingMessage extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/incoming-message

B
Benjamin Pasero 已提交
2922
		/**
2923
		 * Emitted when a request has been canceled during an ongoing HTTP transaction.
B
Benjamin Pasero 已提交
2924
		 */
2925 2926 2927 2928
		on(event: 'aborted', listener: Function): this;
		once(event: 'aborted', listener: Function): this;
		addListener(event: 'aborted', listener: Function): this;
		removeListener(event: 'aborted', listener: Function): this;
B
Benjamin Pasero 已提交
2929
		/**
2930 2931
		 * The data event is the usual method of transferring response data into
		 * applicative code.
B
Benjamin Pasero 已提交
2932
		 */
2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952
		on(event: 'data', listener: (
			/**
			 * A chunk of response body's data.
			 */
			chunk: Buffer) => void): this;
		once(event: 'data', listener: (
			/**
			 * A chunk of response body's data.
			 */
			chunk: Buffer) => void): this;
		addListener(event: 'data', listener: (
			/**
			 * A chunk of response body's data.
			 */
			chunk: Buffer) => void): this;
		removeListener(event: 'data', listener: (
			/**
			 * A chunk of response body's data.
			 */
			chunk: Buffer) => void): this;
B
Benjamin Pasero 已提交
2953
		/**
2954
		 * Indicates that response body has ended.
B
Benjamin Pasero 已提交
2955
		 */
2956 2957 2958 2959
		on(event: 'end', listener: Function): this;
		once(event: 'end', listener: Function): this;
		addListener(event: 'end', listener: Function): this;
		removeListener(event: 'end', listener: Function): this;
B
Benjamin Pasero 已提交
2960
		/**
2961 2962 2963 2964 2965
		 * error Error - Typically holds an error string identifying failure root cause.
		 * Emitted when an error was encountered while streaming response data events. For
		 * instance, if the server closes the underlying while the response is still
		 * streaming, an error event will be emitted on the response object and a close
		 * event will subsequently follow on the request object.
B
Benjamin Pasero 已提交
2966
		 */
2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982
		on(event: 'error', listener: Function): this;
		once(event: 'error', listener: Function): this;
		addListener(event: 'error', listener: Function): this;
		removeListener(event: 'error', listener: Function): this;
		headers: any;
		httpVersion: string;
		httpVersionMajor: number;
		httpVersionMinor: number;
		statusCode: number;
		statusMessage: string;
	}

	interface IOCounters {

		// Docs: http://electron.atom.io/docs/api/structures/io-counters

B
Benjamin Pasero 已提交
2983
		/**
2984
		 * Then number of I/O other operations.
B
Benjamin Pasero 已提交
2985
		 */
2986
		otherOperationCount: number;
B
Benjamin Pasero 已提交
2987
		/**
2988
		 * Then number of I/O other transfers.
B
Benjamin Pasero 已提交
2989
		 */
2990
		otherTransferCount: number;
B
Benjamin Pasero 已提交
2991
		/**
2992
		 * The number of I/O read operations.
B
Benjamin Pasero 已提交
2993
		 */
2994
		readOperationCount: number;
B
Benjamin Pasero 已提交
2995
		/**
2996
		 * The number of I/O read transfers.
B
Benjamin Pasero 已提交
2997
		 */
2998
		readTransferCount: number;
B
Benjamin Pasero 已提交
2999
		/**
3000
		 * The number of I/O write operations.
B
Benjamin Pasero 已提交
3001
		 */
3002
		writeOperationCount: number;
B
Benjamin Pasero 已提交
3003
		/**
3004
		 * The number of I/O write transfers.
B
Benjamin Pasero 已提交
3005
		 */
3006 3007 3008 3009 3010 3011 3012
		writeTransferCount: number;
	}

	interface IpcMain extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/ipc-main

B
Benjamin Pasero 已提交
3013
		/**
3014 3015
		 * Listens to channel, when a new message arrives listener would be called with
		 * listener(event, args...).
B
Benjamin Pasero 已提交
3016
		 */
3017
		on(channel: string, listener: Function): this;
B
Benjamin Pasero 已提交
3018
		/**
3019 3020
		 * Adds a one time listener function for the event. This listener is invoked only
		 * the next time a message is sent to channel, after which it is removed.
B
Benjamin Pasero 已提交
3021
		 */
3022
		once(channel: string, listener: Function): this;
B
Benjamin Pasero 已提交
3023
		/**
3024
		 * Removes listeners of the specified channel.
B
Benjamin Pasero 已提交
3025
		 */
3026
		removeAllListeners(channel: string): this;
B
Benjamin Pasero 已提交
3027
		/**
3028 3029
		 * Removes the specified listener from the listener array for the specified
		 * channel.
B
Benjamin Pasero 已提交
3030
		 */
3031 3032 3033 3034 3035 3036 3037
		removeListener(channel: string, listener: Function): this;
	}

	interface IpcRenderer extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/ipc-renderer

B
Benjamin Pasero 已提交
3038
		/**
3039 3040
		 * Listens to channel, when a new message arrives listener would be called with
		 * listener(event, args...).
B
Benjamin Pasero 已提交
3041
		 */
3042
		on(channel: string, listener: Function): this;
B
Benjamin Pasero 已提交
3043
		/**
3044 3045
		 * Adds a one time listener function for the event. This listener is invoked only
		 * the next time a message is sent to channel, after which it is removed.
B
Benjamin Pasero 已提交
3046
		 */
3047
		once(channel: string, listener: Function): this;
B
Benjamin Pasero 已提交
3048
		/**
3049
		 * Removes all listeners, or those of the specified channel.
B
Benjamin Pasero 已提交
3050
		 */
3051
		removeAllListeners(channel: string): this;
B
Benjamin Pasero 已提交
3052
		/**
3053 3054
		 * Removes the specified listener from the listener array for the specified
		 * channel.
B
Benjamin Pasero 已提交
3055
		 */
3056
		removeListener(channel: string, listener: Function): this;
B
Benjamin Pasero 已提交
3057
		/**
3058 3059 3060 3061
		 * Send a message to the main process asynchronously via channel, you can also send
		 * arbitrary arguments. Arguments will be serialized in JSON internally and hence
		 * no functions or prototype chain will be included. The main process handles it by
		 * listening for channel with ipcMain module.
B
Benjamin Pasero 已提交
3062
		 */
3063
		send(channel: string, ...args: any[]): void;
B
Benjamin Pasero 已提交
3064
		/**
3065 3066 3067 3068 3069 3070
		 * Send a message to the main process synchronously via channel, you can also send
		 * arbitrary arguments. Arguments will be serialized in JSON internally and hence
		 * no functions or prototype chain will be included. The main process handles it by
		 * listening for channel with ipcMain module, and replies by setting
		 * event.returnValue. Note: Sending a synchronous message will block the whole
		 * renderer process, unless you know what you are doing you should never use it.
B
Benjamin Pasero 已提交
3071
		 */
3072
		// sendSync(channel: string, ...args: any[]): any; ### VSCODE CHANGE (we do not want to use sendSync)
3073
		/**
3074
		 * Sends a message to a window with webContentsId via channel.
3075
		 */
3076
		sendTo(webContentsId: number, channel: string, ...args: any[]): void;
3077
		/**
3078 3079
		 * Like ipcRenderer.send but the event will be sent to the <webview> element in the
		 * host page instead of the main process.
3080
		 */
3081
		sendToHost(channel: string, ...args: any[]): void;
B
Benjamin Pasero 已提交
3082 3083
	}

3084
	interface JumpListCategory {
B
Benjamin Pasero 已提交
3085

3086
		// Docs: http://electron.atom.io/docs/api/structures/jump-list-category
B
Benjamin Pasero 已提交
3087 3088

		/**
3089
		 * Array of objects if type is tasks or custom, otherwise it should be omitted.
B
Benjamin Pasero 已提交
3090
		 */
3091
		items?: JumpListItem[];
B
Benjamin Pasero 已提交
3092
		/**
3093
		 * Must be set if type is custom, otherwise it should be omitted.
B
Benjamin Pasero 已提交
3094
		 */
3095
		name?: string;
B
Benjamin Pasero 已提交
3096
		/**
3097
		 * One of the following:
B
Benjamin Pasero 已提交
3098
		 */
3099 3100 3101 3102 3103 3104 3105
		type?: ('tasks' | 'frequent' | 'recent' | 'custom');
	}

	interface JumpListItem {

		// Docs: http://electron.atom.io/docs/api/structures/jump-list-item

B
Benjamin Pasero 已提交
3106
		/**
3107 3108
		 * The command line arguments when program is executed. Should only be set if type
		 * is task.
B
Benjamin Pasero 已提交
3109
		 */
3110
		args?: string;
B
Benjamin Pasero 已提交
3111
		/**
3112 3113
		 * Description of the task (displayed in a tooltip). Should only be set if type is
		 * task.
B
Benjamin Pasero 已提交
3114
		 */
3115
		description?: string;
B
Benjamin Pasero 已提交
3116
		/**
3117 3118 3119 3120
		 * The index of the icon in the resource file. If a resource file contains multiple
		 * icons this value can be used to specify the zero-based index of the icon that
		 * should be displayed for this task. If a resource file contains only one icon,
		 * this property should be set to zero.
B
Benjamin Pasero 已提交
3121
		 */
3122
		iconIndex?: number;
B
Benjamin Pasero 已提交
3123
		/**
3124 3125 3126
		 * The absolute path to an icon to be displayed in a Jump List, which can be an
		 * arbitrary resource file that contains an icon (e.g. .ico, .exe, .dll). You can
		 * usually specify process.execPath to show the program icon.
B
Benjamin Pasero 已提交
3127
		 */
3128
		iconPath?: string;
B
Benjamin Pasero 已提交
3129
		/**
3130
		 * Path of the file to open, should only be set if type is file.
B
Benjamin Pasero 已提交
3131
		 */
3132
		path?: string;
B
Benjamin Pasero 已提交
3133
		/**
3134 3135
		 * Path of the program to execute, usually you should specify process.execPath
		 * which opens the current program. Should only be set if type is task.
B
Benjamin Pasero 已提交
3136
		 */
3137
		program?: string;
B
Benjamin Pasero 已提交
3138
		/**
3139 3140
		 * The text to be displayed for the item in the Jump List. Should only be set if
		 * type is task.
B
Benjamin Pasero 已提交
3141
		 */
3142
		title?: string;
B
Benjamin Pasero 已提交
3143
		/**
3144
		 * One of the following:
B
Benjamin Pasero 已提交
3145
		 */
3146 3147 3148 3149 3150 3151 3152
		type?: ('task' | 'separator' | 'file');
	}

	interface MemoryInfo {

		// Docs: http://electron.atom.io/docs/api/structures/memory-info

B
Benjamin Pasero 已提交
3153
		/**
3154
		 * The maximum amount of memory that has ever been pinned to actual physical RAM.
B
Benjamin Pasero 已提交
3155
		 * On macOS its value will always be 0.
B
Benjamin Pasero 已提交
3156
		 */
3157
		peakWorkingSetSize: number;
B
Benjamin Pasero 已提交
3158
		/**
3159
		 * Process id of the process.
B
Benjamin Pasero 已提交
3160
		 */
3161
		pid: number;
B
Benjamin Pasero 已提交
3162
		/**
3163 3164
		 * The amount of memory not shared by other processes, such as JS heap or HTML
		 * content.
B
Benjamin Pasero 已提交
3165
		 */
3166
		privateBytes: number;
J
Joao Moreno 已提交
3167
		/**
3168 3169
		 * The amount of memory shared between processes, typically memory consumed by the
		 * Electron code itself
J
Joao Moreno 已提交
3170
		 */
3171
		sharedBytes: number;
J
Joao Moreno 已提交
3172
		/**
3173
		 * The amount of memory currently pinned to actual physical RAM.
J
Joao Moreno 已提交
3174
		 */
3175
		workingSetSize: number;
B
Benjamin Pasero 已提交
3176 3177
	}

3178
	interface MemoryUsageDetails {
B
Benjamin Pasero 已提交
3179

3180 3181 3182 3183 3184
		// Docs: http://electron.atom.io/docs/api/structures/memory-usage-details

		count: number;
		liveSize: number;
		size: number;
B
Benjamin Pasero 已提交
3185 3186
	}

3187
	class Menu {
B
Benjamin Pasero 已提交
3188

3189 3190
		// Docs: http://electron.atom.io/docs/api/menu

3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204
		/**
		 * Emitted when a popup is closed either manually or with menu.closePopup().
		 */
		on(event: 'menu-will-close', listener: (event: Event) => void): this;
		once(event: 'menu-will-close', listener: (event: Event) => void): this;
		addListener(event: 'menu-will-close', listener: (event: Event) => void): this;
		removeListener(event: 'menu-will-close', listener: (event: Event) => void): this;
		/**
		 * Emitted when menu.popup() is called.
		 */
		on(event: 'menu-will-show', listener: (event: Event) => void): this;
		once(event: 'menu-will-show', listener: (event: Event) => void): this;
		addListener(event: 'menu-will-show', listener: (event: Event) => void): this;
		removeListener(event: 'menu-will-show', listener: (event: Event) => void): this;
3205
		constructor();
B
Benjamin Pasero 已提交
3206
		/**
3207 3208 3209
		 * Generally, the template is an array of options for constructing a MenuItem. The
		 * usage can be referenced above. You can also attach other fields to the element
		 * of the template and they will become properties of the constructed menu items.
B
Benjamin Pasero 已提交
3210
		 */
3211
		static buildFromTemplate(template: MenuItemConstructorOptions[]): Menu;
B
Benjamin Pasero 已提交
3212
		/**
3213 3214
		 * Note: The returned Menu instance doesn't support dynamic addition or removal of
		 * menu items. Instance properties can still be dynamically modified.
B
Benjamin Pasero 已提交
3215
		 */
3216
		static getApplicationMenu(): Menu | null;
B
Benjamin Pasero 已提交
3217
		/**
3218
		 * Sends the action to the first responder of application. This is used for
3219 3220 3221
		 * emulating default macOS menu behaviors. Usually you would use the role property
		 * of a MenuItem. See the macOS Cocoa Event Handling Guide for more information on
		 * macOS' native actions.
B
Benjamin Pasero 已提交
3222
		 */
3223
		static sendActionToFirstResponder(action: string): void;
B
Benjamin Pasero 已提交
3224
		/**
3225 3226 3227 3228
		 * Sets menu as the application menu on macOS. On Windows and Linux, the menu will
		 * be set as each window's top menu. Passing null will remove the menu bar on
		 * Windows and Linux but has no effect on macOS. Note: This API has to be called
		 * after the ready event of app module.
B
Benjamin Pasero 已提交
3229
		 */
3230
		static setApplicationMenu(menu: Menu | null): void;
B
Benjamin Pasero 已提交
3231
		/**
3232
		 * Appends the menuItem to the menu.
B
Benjamin Pasero 已提交
3233
		 */
3234
		append(menuItem: MenuItem): void;
B
Benjamin Pasero 已提交
3235
		/**
3236
		 * Closes the context menu in the browserWindow.
B
Benjamin Pasero 已提交
3237
		 */
3238
		closePopup(browserWindow?: BrowserWindow): void;
3239
		getMenuItemById(id: string): MenuItem;
B
Benjamin Pasero 已提交
3240
		/**
3241
		 * Inserts the menuItem to the pos position of the menu.
B
Benjamin Pasero 已提交
3242
		 */
3243
		insert(pos: number, menuItem: MenuItem): void;
B
Benjamin Pasero 已提交
3244
		/**
3245
		 * Pops up this menu as a context menu in the BrowserWindow.
B
Benjamin Pasero 已提交
3246
		 */
3247
		popup(options: PopupOptions): void;
3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260
		items: MenuItem[];
	}

	class MenuItem {

		// Docs: http://electron.atom.io/docs/api/menu-item

		constructor(options: MenuItemConstructorOptions);
		checked: boolean;
		click: Function;
		enabled: boolean;
		label: string;
		visible: boolean;
B
Benjamin Pasero 已提交
3261 3262
	}

3263 3264 3265 3266
	interface MimeTypedBuffer {

		// Docs: http://electron.atom.io/docs/api/structures/mime-typed-buffer

B
Benjamin Pasero 已提交
3267
		/**
3268
		 * The actual Buffer content
B
Benjamin Pasero 已提交
3269
		 */
3270
		data: Buffer;
B
Benjamin Pasero 已提交
3271
		/**
3272
		 * The mimeType of the Buffer that you are sending
B
Benjamin Pasero 已提交
3273
		 */
3274
		mimeType: string;
B
Benjamin Pasero 已提交
3275 3276
	}

3277 3278 3279
	class NativeImage {

		// Docs: http://electron.atom.io/docs/api/native-image
B
Benjamin Pasero 已提交
3280 3281

		/**
3282
		 * Creates an empty NativeImage instance.
B
Benjamin Pasero 已提交
3283
		 */
3284
		static createEmpty(): NativeImage;
B
Benjamin Pasero 已提交
3285
		/**
3286
		 * Creates a new NativeImage instance from buffer.
B
Benjamin Pasero 已提交
3287
		 */
3288
		static createFromBuffer(buffer: Buffer, options?: CreateFromBufferOptions): NativeImage;
B
Benjamin Pasero 已提交
3289
		/**
3290
		 * Creates a new NativeImage instance from dataURL.
B
Benjamin Pasero 已提交
3291
		 */
3292
		static createFromDataURL(dataURL: string): NativeImage;
3293 3294 3295 3296 3297 3298 3299
		/**
		 * Creates a new NativeImage instance from the NSImage that maps to the given image
		 * name. See NSImageName for a list of possible values. The hslShift is applied to
		 * the image with the following rules This means that [-1, 0, 1] will make the
		 * image completely white and [-1, 1, 0] will make the image completely black.
		 */
		static createFromNamedImage(imageName: string, hslShift: number[]): NativeImage;
B
Benjamin Pasero 已提交
3300
		/**
3301 3302 3303
		 * Creates a new NativeImage instance from a file located at path. This method
		 * returns an empty image if the path does not exist, cannot be read, or is not a
		 * valid image.
B
Benjamin Pasero 已提交
3304
		 */
3305
		static createFromPath(path: string): NativeImage;
B
Benjamin Pasero 已提交
3306
		/**
3307 3308 3309
		 * Add an image representation for a specific scale factor. This can be used to
		 * explicitly add different scale factor representations to an image. This can be
		 * called on empty images.
B
Benjamin Pasero 已提交
3310
		 */
3311 3312 3313
		addRepresentation(options: AddRepresentationOptions): void;
		crop(rect: Rectangle): NativeImage;
		getAspectRatio(): number;
B
Benjamin Pasero 已提交
3314
		/**
3315 3316 3317
		 * The difference between getBitmap() and toBitmap() is, getBitmap() does not copy
		 * the bitmap data, so you have to use the returned Buffer immediately in current
		 * event loop tick, otherwise the data might be changed or destroyed.
B
Benjamin Pasero 已提交
3318
		 */
3319
		getBitmap(options?: BitmapOptions): Buffer;
B
Benjamin Pasero 已提交
3320
		/**
3321 3322 3323
		 * Notice that the returned pointer is a weak pointer to the underlying native
		 * image instead of a copy, so you must ensure that the associated nativeImage
		 * instance is kept around.
B
Benjamin Pasero 已提交
3324
		 */
3325 3326 3327 3328
		getNativeHandle(): Buffer;
		getSize(): Size;
		isEmpty(): boolean;
		isTemplateImage(): boolean;
B
Benjamin Pasero 已提交
3329
		/**
3330 3331
		 * If only the height or the width are specified then the current aspect ratio will
		 * be preserved in the resized image.
B
Benjamin Pasero 已提交
3332
		 */
3333
		resize(options: ResizeOptions): NativeImage;
3334
		/**
3335
		 * Marks the image as a template image.
3336
		 */
3337 3338 3339 3340 3341
		setTemplateImage(option: boolean): void;
		toBitmap(options?: ToBitmapOptions): Buffer;
		toDataURL(options?: ToDataURLOptions): string;
		toJPEG(quality: number): Buffer;
		toPNG(options?: ToPNGOptions): Buffer;
B
Benjamin Pasero 已提交
3342 3343
	}

3344
	interface Net extends EventEmitter {
B
Benjamin Pasero 已提交
3345

3346
		// Docs: http://electron.atom.io/docs/api/net
B
Benjamin Pasero 已提交
3347 3348

		/**
3349 3350 3351 3352
		 * Creates a ClientRequest instance using the provided options which are directly
		 * forwarded to the ClientRequest constructor. The net.request method would be used
		 * to issue both secure and insecure HTTP requests according to the specified
		 * protocol scheme in the options object.
B
Benjamin Pasero 已提交
3353
		 */
3354
		request(options: any | string): ClientRequest;
B
Benjamin Pasero 已提交
3355 3356
	}

3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379
	interface NetLog extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/net-log

		/**
		 * Starts recording network events to path.
		 */
		startLogging(path: string): void;
		/**
		 * Stops recording network events. If not called, net logging will automatically
		 * end when app quits.
		 */
		stopLogging(callback?: (path: string) => void): void;
		/**
		 * A Boolean property that indicates whether network logs are recorded.
		 */
		currentlyLogging?: boolean;
		/**
		 * A String property that returns the path to the current log file.
		 */
		currentlyLoggingPath?: string;
	}

3380 3381 3382 3383
	class Notification extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/notification

B
Benjamin Pasero 已提交
3384 3385
		on(event: 'action', listener: (event: Event,
			/**
3386
			 * The index of the action that was activated.
B
Benjamin Pasero 已提交
3387 3388 3389 3390
			 */
			index: number) => void): this;
		once(event: 'action', listener: (event: Event,
			/**
3391
			 * The index of the action that was activated.
B
Benjamin Pasero 已提交
3392 3393 3394 3395
			 */
			index: number) => void): this;
		addListener(event: 'action', listener: (event: Event,
			/**
3396
			 * The index of the action that was activated.
B
Benjamin Pasero 已提交
3397 3398 3399 3400
			 */
			index: number) => void): this;
		removeListener(event: 'action', listener: (event: Event,
			/**
3401
			 * The index of the action that was activated.
B
Benjamin Pasero 已提交
3402 3403
			 */
			index: number) => void): this;
B
Benjamin Pasero 已提交
3404
		/**
3405
		 * Emitted when the notification is clicked by the user.
B
Benjamin Pasero 已提交
3406
		 */
3407 3408 3409 3410
		on(event: 'click', listener: (event: Event) => void): this;
		once(event: 'click', listener: (event: Event) => void): this;
		addListener(event: 'click', listener: (event: Event) => void): this;
		removeListener(event: 'click', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
3411
		/**
3412
		 * Emitted when the notification is closed by manual intervention from the user.
3413
		 * This event is not guaranteed to be emitted in all cases where the notification
3414
		 * is closed.
B
Benjamin Pasero 已提交
3415
		 */
3416 3417 3418 3419
		on(event: 'close', listener: (event: Event) => void): this;
		once(event: 'close', listener: (event: Event) => void): this;
		addListener(event: 'close', listener: (event: Event) => void): this;
		removeListener(event: 'close', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
3420
		/**
3421 3422
		 * Emitted when the user clicks the "Reply" button on a notification with hasReply:
		 * true.
B
Benjamin Pasero 已提交
3423
		 */
3424 3425
		on(event: 'reply', listener: (event: Event,
			/**
3426
			 * The string the user entered into the inline reply field.
3427 3428 3429 3430
			 */
			reply: string) => void): this;
		once(event: 'reply', listener: (event: Event,
			/**
3431
			 * The string the user entered into the inline reply field.
3432 3433 3434 3435
			 */
			reply: string) => void): this;
		addListener(event: 'reply', listener: (event: Event,
			/**
3436
			 * The string the user entered into the inline reply field.
3437 3438 3439 3440
			 */
			reply: string) => void): this;
		removeListener(event: 'reply', listener: (event: Event,
			/**
3441
			 * The string the user entered into the inline reply field.
3442 3443
			 */
			reply: string) => void): this;
B
Benjamin Pasero 已提交
3444
		/**
3445 3446 3447
		 * Emitted when the notification is shown to the user, note this could be fired
		 * multiple times as a notification can be shown multiple times through the show()
		 * method.
B
Benjamin Pasero 已提交
3448
		 */
3449 3450 3451 3452 3453 3454
		on(event: 'show', listener: (event: Event) => void): this;
		once(event: 'show', listener: (event: Event) => void): this;
		addListener(event: 'show', listener: (event: Event) => void): this;
		removeListener(event: 'show', listener: (event: Event) => void): this;
		constructor(options: NotificationConstructorOptions);
		static isSupported(): boolean;
3455 3456 3457 3458
		/**
		 * Dismisses the notification.
		 */
		close(): void;
B
Benjamin Pasero 已提交
3459
		/**
3460
		 * Immediately shows the notification to the user, please note this means unlike
3461 3462 3463 3464 3465
		 * the HTML5 Notification implementation, instantiating a new Notification does not
		 * immediately show it to the user, you need to call this method before the OS will
		 * display it. If the notification has been shown before, this method will dismiss
		 * the previously shown notification and create a new one with identical
		 * properties.
B
Benjamin Pasero 已提交
3466
		 */
3467
		show(): void;
B
Benjamin Pasero 已提交
3468 3469
	}

B
Benjamin Pasero 已提交
3470
	interface NotificationAction {
B
Benjamin Pasero 已提交
3471

B
Benjamin Pasero 已提交
3472 3473 3474 3475 3476 3477
		// Docs: http://electron.atom.io/docs/api/structures/notification-action

		/**
		 * The label for the given action.
		 */
		text?: string;
B
Benjamin Pasero 已提交
3478
		/**
B
Benjamin Pasero 已提交
3479
		 * The type of action, can be button.
B
Benjamin Pasero 已提交
3480
		 */
B
Benjamin Pasero 已提交
3481 3482 3483
		type: ('button');
	}

3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494
	interface Point {

		// Docs: http://electron.atom.io/docs/api/structures/point

		x: number;
		y: number;
	}

	interface PowerMonitor extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/power-monitor
B
Benjamin Pasero 已提交
3495

3496 3497 3498 3499 3500 3501 3502
		/**
		 * Emitted when the system is about to lock the screen.
		 */
		on(event: 'lock-screen', listener: Function): this;
		once(event: 'lock-screen', listener: Function): this;
		addListener(event: 'lock-screen', listener: Function): this;
		removeListener(event: 'lock-screen', listener: Function): this;
B
Benjamin Pasero 已提交
3503
		/**
3504
		 * Emitted when the system changes to AC power.
B
Benjamin Pasero 已提交
3505
		 */
3506 3507 3508 3509
		on(event: 'on-ac', listener: Function): this;
		once(event: 'on-ac', listener: Function): this;
		addListener(event: 'on-ac', listener: Function): this;
		removeListener(event: 'on-ac', listener: Function): this;
B
Benjamin Pasero 已提交
3510
		/**
3511
		 * Emitted when system changes to battery power.
B
Benjamin Pasero 已提交
3512
		 */
3513 3514 3515 3516
		on(event: 'on-battery', listener: Function): this;
		once(event: 'on-battery', listener: Function): this;
		addListener(event: 'on-battery', listener: Function): this;
		removeListener(event: 'on-battery', listener: Function): this;
B
Benjamin Pasero 已提交
3517
		/**
3518
		 * Emitted when system is resuming.
B
Benjamin Pasero 已提交
3519
		 */
3520 3521 3522 3523
		on(event: 'resume', listener: Function): this;
		once(event: 'resume', listener: Function): this;
		addListener(event: 'resume', listener: Function): this;
		removeListener(event: 'resume', listener: Function): this;
3524 3525 3526 3527 3528 3529 3530 3531 3532 3533
		/**
		 * Emitted when the system is about to reboot or shut down. If the event handler
		 * invokes e.preventDefault(), Electron will attempt to delay system shutdown in
		 * order for the app to exit cleanly. If e.preventDefault() is called, the app
		 * should exit as soon as possible by calling something like app.quit().
		 */
		on(event: 'shutdown', listener: Function): this;
		once(event: 'shutdown', listener: Function): this;
		addListener(event: 'shutdown', listener: Function): this;
		removeListener(event: 'shutdown', listener: Function): this;
B
Benjamin Pasero 已提交
3534
		/**
3535
		 * Emitted when the system is suspending.
B
Benjamin Pasero 已提交
3536
		 */
3537 3538 3539 3540
		on(event: 'suspend', listener: Function): this;
		once(event: 'suspend', listener: Function): this;
		addListener(event: 'suspend', listener: Function): this;
		removeListener(event: 'suspend', listener: Function): this;
3541 3542 3543 3544 3545 3546 3547
		/**
		 * Emitted as soon as the systems screen is unlocked.
		 */
		on(event: 'unlock-screen', listener: Function): this;
		once(event: 'unlock-screen', listener: Function): this;
		addListener(event: 'unlock-screen', listener: Function): this;
		removeListener(event: 'unlock-screen', listener: Function): this;
3548 3549 3550 3551 3552 3553 3554
	}

	interface PowerSaveBlocker extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/power-save-blocker

		isStarted(id: number): boolean;
B
Benjamin Pasero 已提交
3555
		/**
3556 3557 3558 3559 3560 3561 3562 3563
		 * Starts preventing the system from entering lower-power mode. Returns an integer
		 * identifying the power save blocker. Note: prevent-display-sleep has higher
		 * precedence over prevent-app-suspension. Only the highest precedence type takes
		 * effect. In other words, prevent-display-sleep always takes precedence over
		 * prevent-app-suspension. For example, an API calling A requests for
		 * prevent-app-suspension, and another calling B requests for
		 * prevent-display-sleep. prevent-display-sleep will be used until B stops its
		 * request. After that, prevent-app-suspension is used.
B
Benjamin Pasero 已提交
3564
		 */
3565
		start(type: 'prevent-app-suspension' | 'prevent-display-sleep'): number;
B
Benjamin Pasero 已提交
3566
		/**
3567
		 * Stops the specified power save blocker.
B
Benjamin Pasero 已提交
3568
		 */
3569
		stop(id: number): void;
B
Benjamin Pasero 已提交
3570 3571
	}

3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585
	interface PrinterInfo {

		// Docs: http://electron.atom.io/docs/api/structures/printer-info

		description: string;
		isDefault: boolean;
		name: string;
		status: number;
	}

	interface ProcessMetric {

		// Docs: http://electron.atom.io/docs/api/structures/process-metric

B
Benjamin Pasero 已提交
3586
		/**
3587
		 * CPU usage of the process.
B
Benjamin Pasero 已提交
3588
		 */
3589
		cpu: CPUUsage;
B
Benjamin Pasero 已提交
3590
		/**
3591
		 * Memory information for the process.
B
Benjamin Pasero 已提交
3592
		 */
3593
		memory: MemoryInfo;
B
Benjamin Pasero 已提交
3594
		/**
3595
		 * Process id of the process.
B
Benjamin Pasero 已提交
3596
		 */
3597
		pid: number;
B
Benjamin Pasero 已提交
3598
		/**
3599
		 * Process type (Browser or Tab or GPU etc).
B
Benjamin Pasero 已提交
3600
		 */
3601
		type: string;
B
Benjamin Pasero 已提交
3602 3603
	}

3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642
	interface Product {

		// Docs: http://electron.atom.io/docs/api/structures/product

		/**
		 * The total size of the content, in bytes.
		 */
		contentLengths: number[];
		/**
		 * A string that identifies the version of the content.
		 */
		contentVersion: string;
		/**
		 * A Boolean value that indicates whether the App Store has downloadable content
		 * for this product.
		 */
		downloadable: boolean;
		/**
		 * The locale formatted price of the product.
		 */
		formattedPrice: string;
		/**
		 * A description of the product.
		 */
		localizedDescription: string;
		/**
		 * The name of the product.
		 */
		localizedTitle: string;
		/**
		 * The cost of the product in the local currency.
		 */
		price: number;
		/**
		 * The string that identifies the product to the Apple App Store.
		 */
		productIdentifier: string;
	}

3643 3644 3645 3646
	interface Protocol extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/protocol

B
Benjamin Pasero 已提交
3647
		/**
3648 3649
		 * Intercepts scheme protocol and uses handler as the protocol's new handler which
		 * sends a Buffer as a response.
B
Benjamin Pasero 已提交
3650
		 */
3651
		interceptBufferProtocol(scheme: string, handler: (request: InterceptBufferProtocolRequest, callback: (buffer?: Buffer) => void) => void, completion?: (error: Error) => void): void;
B
Benjamin Pasero 已提交
3652
		/**
3653 3654
		 * Intercepts scheme protocol and uses handler as the protocol's new handler which
		 * sends a file as a response.
B
Benjamin Pasero 已提交
3655
		 */
3656
		interceptFileProtocol(scheme: string, handler: (request: InterceptFileProtocolRequest, callback: (filePath: string) => void) => void, completion?: (error: Error) => void): void;
B
Benjamin Pasero 已提交
3657
		/**
3658 3659
		 * Intercepts scheme protocol and uses handler as the protocol's new handler which
		 * sends a new HTTP request as a response.
B
Benjamin Pasero 已提交
3660
		 */
3661
		interceptHttpProtocol(scheme: string, handler: (request: InterceptHttpProtocolRequest, callback: (redirectRequest: RedirectRequest) => void) => void, completion?: (error: Error) => void): void;
3662 3663 3664 3665 3666
		/**
		 * Same as protocol.registerStreamProtocol, except that it replaces an existing
		 * protocol handler.
		 */
		interceptStreamProtocol(scheme: string, handler: (request: InterceptStreamProtocolRequest, callback: (stream?: ReadableStream | StreamProtocolResponse) => void) => void, completion?: (error: Error) => void): void;
B
Benjamin Pasero 已提交
3667
		/**
3668 3669
		 * Intercepts scheme protocol and uses handler as the protocol's new handler which
		 * sends a String as a response.
B
Benjamin Pasero 已提交
3670
		 */
3671
		interceptStringProtocol(scheme: string, handler: (request: InterceptStringProtocolRequest, callback: (data?: string) => void) => void, completion?: (error: Error) => void): void;
B
Benjamin Pasero 已提交
3672
		/**
3673 3674
		 * The callback will be called with a boolean that indicates whether there is
		 * already a handler for scheme.
B
Benjamin Pasero 已提交
3675
		 */
3676
		isProtocolHandled(scheme: string, callback: (error: Error) => void): void;
B
Benjamin Pasero 已提交
3677
		/**
3678 3679 3680 3681
		 * Registers a protocol of scheme that will send a Buffer as a response. The usage
		 * is the same with registerFileProtocol, except that the callback should be called
		 * with either a Buffer object or an object that has the data, mimeType, and
		 * charset properties. Example:
B
Benjamin Pasero 已提交
3682
		 */
3683
		registerBufferProtocol(scheme: string, handler: (request: RegisterBufferProtocolRequest, callback: (buffer?: Buffer | MimeTypedBuffer) => void) => void, completion?: (error: Error) => void): void;
B
Benjamin Pasero 已提交
3684
		/**
3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697
		 * Registers a protocol of scheme that will send the file as a response. The
		 * handler will be called with handler(request, callback) when a request is going
		 * to be created with scheme. completion will be called with completion(null) when
		 * scheme is successfully registered or completion(error) when failed. To handle
		 * the request, the callback should be called with either the file's path or an
		 * object that has a path property, e.g. callback(filePath) or callback({path:
		 * filePath}). When callback is called with nothing, a number, or an object that
		 * has an error property, the request will fail with the error number you
		 * specified. For the available error numbers you can use, please see the net error
		 * list. By default the scheme is treated like http:, which is parsed differently
		 * than protocols that follow the "generic URI syntax" like file:, so you probably
		 * want to call protocol.registerStandardSchemes to have your scheme treated as a
		 * standard scheme.
B
Benjamin Pasero 已提交
3698
		 */
3699
		registerFileProtocol(scheme: string, handler: (request: RegisterFileProtocolRequest, callback: (filePath?: string) => void) => void, completion?: (error: Error) => void): void;
B
Benjamin Pasero 已提交
3700
		/**
3701 3702 3703 3704 3705 3706
		 * Registers a protocol of scheme that will send an HTTP request as a response. The
		 * usage is the same with registerFileProtocol, except that the callback should be
		 * called with a redirectRequest object that has the url, method, referrer,
		 * uploadData and session properties. By default the HTTP request will reuse the
		 * current session. If you want the request to have a different session you should
		 * set session to null. For POST requests the uploadData object must be provided.
B
Benjamin Pasero 已提交
3707
		 */
3708 3709
		registerHttpProtocol(scheme: string, handler: (request: RegisterHttpProtocolRequest, callback: (redirectRequest: RedirectRequest) => void) => void, completion?: (error: Error) => void): void;
		registerServiceWorkerSchemes(schemes: string[]): void;
B
Benjamin Pasero 已提交
3710
		/**
3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726
		 * A standard scheme adheres to what RFC 3986 calls generic URI syntax. For example
		 * http and https are standard schemes, while file is not. Registering a scheme as
		 * standard, will allow relative and absolute resources to be resolved correctly
		 * when served. Otherwise the scheme will behave like the file protocol, but
		 * without the ability to resolve relative URLs. For example when you load
		 * following page with custom protocol without registering it as standard scheme,
		 * the image will not be loaded because non-standard schemes can not recognize
		 * relative URLs: Registering a scheme as standard will allow access to files
		 * through the FileSystem API. Otherwise the renderer will throw a security error
		 * for the scheme. By default web storage apis (localStorage, sessionStorage,
		 * webSQL, indexedDB, cookies) are disabled for non standard schemes. So in general
		 * if you want to register a custom protocol to replace the http protocol, you have
		 * to register it as a standard scheme: Note: This method can only be used before
		 * the ready event of the app module gets emitted.
		 */
		registerStandardSchemes(schemes: string[], options?: RegisterStandardSchemesOptions): void;
3727 3728 3729 3730 3731 3732 3733 3734 3735
		/**
		 * Registers a protocol of scheme that will send a Readable as a response. The
		 * usage is similar to the other register{Any}Protocol, except that the callback
		 * should be called with either a Readable object or an object that has the data,
		 * statusCode, and headers properties. Example: It is possible to pass any object
		 * that implements the readable stream API (emits data/end/error events). For
		 * example, here's how a file could be returned:
		 */
		registerStreamProtocol(scheme: string, handler: (request: RegisterStreamProtocolRequest, callback: (stream?: ReadableStream | StreamProtocolResponse) => void) => void, completion?: (error: Error) => void): void;
3736 3737 3738 3739 3740 3741 3742
		/**
		 * Registers a protocol of scheme that will send a String as a response. The usage
		 * is the same with registerFileProtocol, except that the callback should be called
		 * with either a String or an object that has the data, mimeType, and charset
		 * properties.
		 */
		registerStringProtocol(scheme: string, handler: (request: RegisterStringProtocolRequest, callback: (data?: string) => void) => void, completion?: (error: Error) => void): void;
B
Benjamin Pasero 已提交
3743
		/**
3744
		 * Remove the interceptor installed for scheme and restore its original handler.
B
Benjamin Pasero 已提交
3745
		 */
3746
		uninterceptProtocol(scheme: string, completion?: (error: Error) => void): void;
B
Benjamin Pasero 已提交
3747
		/**
3748
		 * Unregisters the custom protocol of scheme.
B
Benjamin Pasero 已提交
3749
		 */
3750
		unregisterProtocol(scheme: string, completion?: (error: Error) => void): void;
B
Benjamin Pasero 已提交
3751 3752
	}

3753
	interface Rectangle {
B
Benjamin Pasero 已提交
3754

3755
		// Docs: http://electron.atom.io/docs/api/structures/rectangle
B
Benjamin Pasero 已提交
3756 3757

		/**
B
Benjamin Pasero 已提交
3758
		 * The height of the rectangle (must be an integer)
B
Benjamin Pasero 已提交
3759
		 */
3760
		height: number;
B
Benjamin Pasero 已提交
3761
		/**
B
Benjamin Pasero 已提交
3762
		 * The width of the rectangle (must be an integer)
B
Benjamin Pasero 已提交
3763
		 */
3764
		width: number;
B
Benjamin Pasero 已提交
3765
		/**
B
Benjamin Pasero 已提交
3766
		 * The x coordinate of the origin of the rectangle (must be an integer)
B
Benjamin Pasero 已提交
3767
		 */
3768
		x: number;
B
Benjamin Pasero 已提交
3769
		/**
B
Benjamin Pasero 已提交
3770
		 * The y coordinate of the origin of the rectangle (must be an integer)
B
Benjamin Pasero 已提交
3771
		 */
3772 3773 3774
		y: number;
	}

3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790
	interface Referrer {

		// Docs: http://electron.atom.io/docs/api/structures/referrer

		/**
		 * Can be default, unsafe-url, no-referrer-when-downgrade, no-referrer, origin,
		 * strict-origin-when-cross-origin, same-origin or strict-origin. See the for more
		 * details on the meaning of these values.
		 */
		policy: ('default' | 'unsafe-url' | 'no-referrer-when-downgrade' | 'no-referrer' | 'origin' | 'strict-origin-when-cross-origin' | 'same-origin' | 'strict-origin');
		/**
		 * HTTP Referrer URL.
		 */
		url: string;
	}

3791 3792 3793 3794 3795
	interface Remote extends MainInterface {

		// Docs: http://electron.atom.io/docs/api/remote

		getCurrentWebContents(): WebContents;
3796 3797 3798 3799 3800
		/**
		 * Note: Do not use removeAllListeners on BrowserWindow. Use of this can remove all
		 * blur listeners, disable click events on touch bar buttons, and other unintended
		 * consequences.
		 */
3801 3802
		getCurrentWindow(): BrowserWindow;
		getGlobal(name: string): any;
B
Benjamin Pasero 已提交
3803
		/**
3804
		 * e.g.
B
Benjamin Pasero 已提交
3805
		 */
3806
		require(module: string): any;
B
Benjamin Pasero 已提交
3807
		/**
3808 3809
		 * The process object in the main process. This is the same as
		 * remote.getGlobal('process') but is cached.
B
Benjamin Pasero 已提交
3810
		 */
3811 3812 3813 3814 3815 3816 3817
		process?: any;
	}

	interface RemoveClientCertificate {

		// Docs: http://electron.atom.io/docs/api/structures/remove-client-certificate

B
Benjamin Pasero 已提交
3818
		/**
3819 3820
		 * Origin of the server whose associated client certificate must be removed from
		 * the cache.
B
Benjamin Pasero 已提交
3821
		 */
3822
		origin: string;
B
Benjamin Pasero 已提交
3823
		/**
3824
		 * clientCertificate.
B
Benjamin Pasero 已提交
3825
		 */
3826 3827 3828 3829 3830 3831 3832
		type: string;
	}

	interface RemovePassword {

		// Docs: http://electron.atom.io/docs/api/structures/remove-password

B
Benjamin Pasero 已提交
3833
		/**
3834 3835
		 * When provided, the authentication info related to the origin will only be
		 * removed otherwise the entire cache will be cleared.
B
Benjamin Pasero 已提交
3836
		 */
3837
		origin?: string;
B
Benjamin Pasero 已提交
3838
		/**
3839
		 * Credentials of the authentication. Must be provided if removing by origin.
B
Benjamin Pasero 已提交
3840
		 */
3841
		password?: string;
B
Benjamin Pasero 已提交
3842
		/**
3843
		 * Realm of the authentication. Must be provided if removing by origin.
B
Benjamin Pasero 已提交
3844
		 */
3845
		realm?: string;
B
Benjamin Pasero 已提交
3846
		/**
3847 3848
		 * Scheme of the authentication. Can be basic, digest, ntlm, negotiate. Must be
		 * provided if removing by origin.
B
Benjamin Pasero 已提交
3849
		 */
3850
		scheme?: ('basic' | 'digest' | 'ntlm' | 'negotiate');
B
Benjamin Pasero 已提交
3851
		/**
3852
		 * password.
B
Benjamin Pasero 已提交
3853
		 */
3854
		type: string;
B
Benjamin Pasero 已提交
3855
		/**
3856
		 * Credentials of the authentication. Must be provided if removing by origin.
B
Benjamin Pasero 已提交
3857
		 */
3858 3859 3860 3861 3862 3863 3864
		username?: string;
	}

	interface Screen extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/screen

B
Benjamin Pasero 已提交
3865
		/**
3866
		 * Emitted when newDisplay has been added.
B
Benjamin Pasero 已提交
3867
		 */
3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892
		on(event: 'display-added', listener: (event: Event,
			newDisplay: Display) => void): this;
		once(event: 'display-added', listener: (event: Event,
			newDisplay: Display) => void): this;
		addListener(event: 'display-added', listener: (event: Event,
			newDisplay: Display) => void): this;
		removeListener(event: 'display-added', listener: (event: Event,
			newDisplay: Display) => void): this;
		/**
		 * Emitted when one or more metrics change in a display. The changedMetrics is an
		 * array of strings that describe the changes. Possible changes are bounds,
		 * workArea, scaleFactor and rotation.
		 */
		on(event: 'display-metrics-changed', listener: (event: Event,
			display: Display,
			changedMetrics: string[]) => void): this;
		once(event: 'display-metrics-changed', listener: (event: Event,
			display: Display,
			changedMetrics: string[]) => void): this;
		addListener(event: 'display-metrics-changed', listener: (event: Event,
			display: Display,
			changedMetrics: string[]) => void): this;
		removeListener(event: 'display-metrics-changed', listener: (event: Event,
			display: Display,
			changedMetrics: string[]) => void): this;
B
Benjamin Pasero 已提交
3893
		/**
3894
		 * Emitted when oldDisplay has been removed.
B
Benjamin Pasero 已提交
3895
		 */
3896 3897 3898 3899 3900 3901 3902 3903
		on(event: 'display-removed', listener: (event: Event,
			oldDisplay: Display) => void): this;
		once(event: 'display-removed', listener: (event: Event,
			oldDisplay: Display) => void): this;
		addListener(event: 'display-removed', listener: (event: Event,
			oldDisplay: Display) => void): this;
		removeListener(event: 'display-removed', listener: (event: Event,
			oldDisplay: Display) => void): this;
3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914
		/**
		 * Converts a screen DIP point to a screen physical point. The DPI scale is
		 * performed relative to the display containing the DIP point.
		 */
		dipToScreenPoint(point: Point): Point;
		/**
		 * Converts a screen DIP rect to a screen physical rect. The DPI scale is performed
		 * relative to the display nearest to window. If window is null, scaling will be
		 * performed to the display nearest to rect.
		 */
		dipToScreenRect(window: BrowserWindow | null, rect: Rectangle): Rectangle;
3915
		getAllDisplays(): Display[];
B
Benjamin Pasero 已提交
3916
		/**
3917
		 * The current absolute position of the mouse pointer.
B
Benjamin Pasero 已提交
3918
		 */
3919 3920 3921 3922
		getCursorScreenPoint(): Point;
		getDisplayMatching(rect: Rectangle): Display;
		getDisplayNearestPoint(point: Point): Display;
		getPrimaryDisplay(): Display;
3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933
		/**
		 * Converts a screen physical point to a screen DIP point. The DPI scale is
		 * performed relative to the display containing the physical point.
		 */
		screenToDipPoint(point: Point): Point;
		/**
		 * Converts a screen physical rect to a screen DIP rect. The DPI scale is performed
		 * relative to the display nearest to window. If window is null, scaling will be
		 * performed to the display nearest to rect.
		 */
		screenToDipRect(window: BrowserWindow | null, rect: Rectangle): Rectangle;
B
Benjamin Pasero 已提交
3934 3935
	}

3936 3937 3938
	interface ScrubberItem {

		// Docs: http://electron.atom.io/docs/api/structures/scrubber-item
B
Benjamin Pasero 已提交
3939 3940

		/**
3941
		 * The image to appear in this item
B
Benjamin Pasero 已提交
3942
		 */
3943
		icon?: NativeImage;
B
Benjamin Pasero 已提交
3944
		/**
3945
		 * The text to appear in this item
B
Benjamin Pasero 已提交
3946
		 */
3947
		label?: string;
B
Benjamin Pasero 已提交
3948 3949
	}

3950 3951 3952
	interface SegmentedControlSegment {

		// Docs: http://electron.atom.io/docs/api/structures/segmented-control-segment
B
Benjamin Pasero 已提交
3953 3954

		/**
3955
		 * Whether this segment is selectable. Default: true
B
Benjamin Pasero 已提交
3956
		 */
3957
		enabled?: boolean;
B
Benjamin Pasero 已提交
3958
		/**
3959
		 * The image to appear in this segment
B
Benjamin Pasero 已提交
3960
		 */
3961
		icon?: NativeImage;
B
Benjamin Pasero 已提交
3962
		/**
3963
		 * The text to appear in this segment
B
Benjamin Pasero 已提交
3964
		 */
3965
		label?: string;
B
Benjamin Pasero 已提交
3966 3967
	}

3968
	class Session extends EventEmitter {
B
Benjamin Pasero 已提交
3969

3970
		// Docs: http://electron.atom.io/docs/api/session
B
Benjamin Pasero 已提交
3971 3972

		/**
3973 3974 3975 3976 3977 3978
		 * If partition starts with persist:, the page will use a persistent session
		 * available to all pages in the app with the same partition. if there is no
		 * persist: prefix, the page will use an in-memory session. If the partition is
		 * empty then default session of the app will be returned. To create a Session with
		 * options, you have to ensure the Session with the partition has never been used
		 * before. There is no way to change the options of an existing Session object.
B
Benjamin Pasero 已提交
3979
		 */
3980
		static fromPartition(partition: string, options?: FromPartitionOptions): Session;
B
Benjamin Pasero 已提交
3981
		/**
3982
		 * A Session object, the default session object of the app.
B
Benjamin Pasero 已提交
3983
		 */
3984
		static defaultSession?: Session;
B
Benjamin Pasero 已提交
3985
		/**
3986 3987 3988
		 * Emitted when Electron is about to download item in webContents. Calling
		 * event.preventDefault() will cancel the download and item will not be available
		 * from next tick of the process.
B
Benjamin Pasero 已提交
3989
		 */
3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001
		on(event: 'will-download', listener: (event: Event,
			item: DownloadItem,
			webContents: WebContents) => void): this;
		once(event: 'will-download', listener: (event: Event,
			item: DownloadItem,
			webContents: WebContents) => void): this;
		addListener(event: 'will-download', listener: (event: Event,
			item: DownloadItem,
			webContents: WebContents) => void): this;
		removeListener(event: 'will-download', listener: (event: Event,
			item: DownloadItem,
			webContents: WebContents) => void): this;
B
Benjamin Pasero 已提交
4002
		/**
4003 4004
		 * Dynamically sets whether to always send credentials for HTTP NTLM or Negotiate
		 * authentication.
B
Benjamin Pasero 已提交
4005
		 */
4006
		allowNTLMCredentialsForDomains(domains: string): void;
B
Benjamin Pasero 已提交
4007
		/**
4008
		 * Clears the session’s HTTP authentication cache.
B
Benjamin Pasero 已提交
4009
		 */
4010
		clearAuthCache(options: RemovePassword | RemoveClientCertificate, callback?: Function): void;
B
Benjamin Pasero 已提交
4011
		/**
4012
		 * Clears the session’s HTTP cache.
B
Benjamin Pasero 已提交
4013
		 */
4014
		clearCache(callback: Function): void;
B
Benjamin Pasero 已提交
4015
		/**
4016
		 * Clears the host resolver cache.
B
Benjamin Pasero 已提交
4017
		 */
4018
		clearHostResolverCache(callback?: Function): void;
B
Benjamin Pasero 已提交
4019
		/**
4020
		 * Clears the data of web storages.
B
Benjamin Pasero 已提交
4021
		 */
4022
		clearStorageData(options?: ClearStorageDataOptions, callback?: Function): void;
B
Benjamin Pasero 已提交
4023
		/**
4024 4025 4026 4027 4028
		 * Allows resuming cancelled or interrupted downloads from previous Session. The
		 * API will generate a DownloadItem that can be accessed with the will-download
		 * event. The DownloadItem will not have any WebContents associated with it and the
		 * initial state will be interrupted. The download will start only when the resume
		 * API is called on the DownloadItem.
B
Benjamin Pasero 已提交
4029
		 */
4030
		createInterruptedDownload(options: CreateInterruptedDownloadOptions): void;
B
Benjamin Pasero 已提交
4031
		/**
4032 4033
		 * Disables any network emulation already active for the session. Resets to the
		 * original network configuration.
B
Benjamin Pasero 已提交
4034
		 */
4035
		disableNetworkEmulation(): void;
B
Benjamin Pasero 已提交
4036
		/**
4037
		 * Emulates network with the given configuration for the session.
B
Benjamin Pasero 已提交
4038
		 */
4039
		enableNetworkEmulation(options: EnableNetworkEmulationOptions): void;
B
Benjamin Pasero 已提交
4040
		/**
4041
		 * Writes any unwritten DOMStorage data to disk.
B
Benjamin Pasero 已提交
4042
		 */
4043
		flushStorageData(): void;
4044
		getBlobData(identifier: string, callback: (result: Buffer) => void): void;
4045 4046 4047 4048
		/**
		 * Callback is invoked with the session's current cache size.
		 */
		getCacheSize(callback: (size: number) => void): void;
4049
		getPreloads(): string[];
4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071
		getUserAgent(): string;
		/**
		 * Resolves the proxy information for url. The callback will be called with
		 * callback(proxy) when the request is performed.
		 */
		resolveProxy(url: string, callback: (proxy: string) => void): void;
		/**
		 * Sets the certificate verify proc for session, the proc will be called with
		 * proc(request, callback) whenever a server certificate verification is requested.
		 * Calling callback(0) accepts the certificate, calling callback(-2) rejects it.
		 * Calling setCertificateVerifyProc(null) will revert back to default certificate
		 * verify proc.
		 */
		setCertificateVerifyProc(proc: (request: CertificateVerifyProcRequest, callback: (verificationResult: number) => void) => void): void;
		/**
		 * Sets download saving directory. By default, the download directory will be the
		 * Downloads under the respective app folder.
		 */
		setDownloadPath(path: string): void;
		/**
		 * Sets the handler which can be used to respond to permission requests for the
		 * session. Calling callback(true) will allow the permission and callback(false)
4072 4073 4074 4075 4076 4077
		 * will reject it. To clear the handler, call setPermissionRequestHandler(null).
		 */
		setPermissionRequestHandler(handler: (webContents: WebContents, permission: string, callback: (permissionGranted: boolean) => void, details: PermissionRequestHandlerDetails) => void | null): void;
		/**
		 * Adds scripts that will be executed on ALL web contents that are associated with
		 * this session just before normal preload scripts run.
4078
		 */
4079
		setPreloads(preloads: string[]): void;
4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095
		/**
		 * Sets the proxy settings. When pacScript and proxyRules are provided together,
		 * the proxyRules option is ignored and pacScript configuration is applied. The
		 * proxyRules has to follow the rules below: For example: The proxyBypassRules is a
		 * comma separated list of rules described below:
		 */
		setProxy(config: Config, callback: Function): void;
		/**
		 * Overrides the userAgent and acceptLanguages for this session. The
		 * acceptLanguages must a comma separated ordered list of language codes, for
		 * example "en-US,fr,de,ko,zh-CN,ja". This doesn't affect existing WebContents, and
		 * each WebContents can use webContents.setUserAgent to override the session-wide
		 * user agent.
		 */
		setUserAgent(userAgent: string, acceptLanguages?: string): void;
		cookies: Cookies;
4096
		netLog: NetLog;
4097 4098
		protocol: Protocol;
		webRequest: WebRequest;
B
Benjamin Pasero 已提交
4099 4100
	}

4101 4102 4103
	interface Shell {

		// Docs: http://electron.atom.io/docs/api/shell
B
Benjamin Pasero 已提交
4104 4105

		/**
4106
		 * Play the beep sound.
B
Benjamin Pasero 已提交
4107
		 */
4108
		beep(): void;
B
Benjamin Pasero 已提交
4109
		/**
4110
		 * Move the given file to trash and returns a boolean status for the operation.
B
Benjamin Pasero 已提交
4111
		 */
4112
		moveItemToTrash(fullPath: string): boolean;
B
Benjamin Pasero 已提交
4113
		/**
4114 4115
		 * Open the given external protocol URL in the desktop's default manner. (For
		 * example, mailto: URLs in the user's default mail agent).
B
Benjamin Pasero 已提交
4116
		 */
4117
		openExternal(url: string, options?: OpenExternalOptions, callback?: (error: Error) => void): boolean;
B
Benjamin Pasero 已提交
4118
		/**
4119
		 * Open the given file in the desktop's default manner.
B
Benjamin Pasero 已提交
4120
		 */
4121
		openItem(fullPath: string): boolean;
B
Benjamin Pasero 已提交
4122
		/**
4123 4124
		 * Resolves the shortcut link at shortcutPath. An exception will be thrown when any
		 * error happens.
B
Benjamin Pasero 已提交
4125
		 */
4126
		readShortcutLink(shortcutPath: string): ShortcutDetails;
B
Benjamin Pasero 已提交
4127
		/**
4128
		 * Show the given file in a file manager. If possible, select the file.
B
Benjamin Pasero 已提交
4129
		 */
4130
		showItemInFolder(fullPath: string): boolean;
B
Benjamin Pasero 已提交
4131
		/**
4132
		 * Creates or updates a shortcut link at shortcutPath.
B
Benjamin Pasero 已提交
4133
		 */
4134
		writeShortcutLink(shortcutPath: string, operation: 'create' | 'update' | 'replace', options: ShortcutDetails): boolean;
B
Benjamin Pasero 已提交
4135
		/**
4136
		 * Creates or updates a shortcut link at shortcutPath.
B
Benjamin Pasero 已提交
4137
		 */
4138
		writeShortcutLink(shortcutPath: string, options: ShortcutDetails): boolean;
B
Benjamin Pasero 已提交
4139 4140
	}

4141 4142 4143
	interface ShortcutDetails {

		// Docs: http://electron.atom.io/docs/api/structures/shortcut-details
B
Benjamin Pasero 已提交
4144 4145

		/**
4146
		 * The Application User Model ID. Default is empty.
B
Benjamin Pasero 已提交
4147
		 */
4148 4149 4150 4151 4152 4153
		appUserModelId?: string;
		/**
		 * The arguments to be applied to target when launching from this shortcut. Default
		 * is empty.
		 */
		args?: string;
B
Benjamin Pasero 已提交
4154
		/**
4155
		 * The working directory. Default is empty.
B
Benjamin Pasero 已提交
4156
		 */
4157
		cwd?: string;
B
Benjamin Pasero 已提交
4158
		/**
4159
		 * The description of the shortcut. Default is empty.
B
Benjamin Pasero 已提交
4160
		 */
4161
		description?: string;
B
Benjamin Pasero 已提交
4162
		/**
4163 4164
		 * The path to the icon, can be a DLL or EXE. icon and iconIndex have to be set
		 * together. Default is empty, which uses the target's icon.
B
Benjamin Pasero 已提交
4165
		 */
4166
		icon?: string;
B
Benjamin Pasero 已提交
4167
		/**
4168
		 * The resource ID of icon when icon is a DLL or EXE. Default is 0.
B
Benjamin Pasero 已提交
4169
		 */
4170
		iconIndex?: number;
B
Benjamin Pasero 已提交
4171
		/**
4172
		 * The target to launch from this shortcut.
B
Benjamin Pasero 已提交
4173
		 */
4174
		target: string;
B
Benjamin Pasero 已提交
4175 4176
	}

4177
	interface Size {
B
Benjamin Pasero 已提交
4178

4179 4180 4181 4182
		// Docs: http://electron.atom.io/docs/api/structures/size

		height: number;
		width: number;
B
Benjamin Pasero 已提交
4183 4184
	}

4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202
	interface StreamProtocolResponse {

		// Docs: http://electron.atom.io/docs/api/structures/stream-protocol-response

		/**
		 * A Node.js readable stream representing the response body
		 */
		data: ReadableStream;
		/**
		 * An object containing the response headers
		 */
		headers: Headers;
		/**
		 * The HTTP response code
		 */
		statusCode: number;
	}

4203
	interface SystemPreferences extends EventEmitter {
B
Benjamin Pasero 已提交
4204

4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256
		// Docs: http://electron.atom.io/docs/api/system-preferences

		on(event: 'accent-color-changed', listener: (event: Event,
			/**
			 * The new RGBA color the user assigned to be their system accent color.
			 */
			newColor: string) => void): this;
		once(event: 'accent-color-changed', listener: (event: Event,
			/**
			 * The new RGBA color the user assigned to be their system accent color.
			 */
			newColor: string) => void): this;
		addListener(event: 'accent-color-changed', listener: (event: Event,
			/**
			 * The new RGBA color the user assigned to be their system accent color.
			 */
			newColor: string) => void): this;
		removeListener(event: 'accent-color-changed', listener: (event: Event,
			/**
			 * The new RGBA color the user assigned to be their system accent color.
			 */
			newColor: string) => void): this;
		on(event: 'color-changed', listener: (event: Event) => void): this;
		once(event: 'color-changed', listener: (event: Event) => void): this;
		addListener(event: 'color-changed', listener: (event: Event) => void): this;
		removeListener(event: 'color-changed', listener: (event: Event) => void): this;
		on(event: 'inverted-color-scheme-changed', listener: (event: Event,
			/**
			 * `true` if an inverted color scheme, such as a high contrast theme, is being
			 * used, `false` otherwise.
			 */
			invertedColorScheme: boolean) => void): this;
		once(event: 'inverted-color-scheme-changed', listener: (event: Event,
			/**
			 * `true` if an inverted color scheme, such as a high contrast theme, is being
			 * used, `false` otherwise.
			 */
			invertedColorScheme: boolean) => void): this;
		addListener(event: 'inverted-color-scheme-changed', listener: (event: Event,
			/**
			 * `true` if an inverted color scheme, such as a high contrast theme, is being
			 * used, `false` otherwise.
			 */
			invertedColorScheme: boolean) => void): this;
		removeListener(event: 'inverted-color-scheme-changed', listener: (event: Event,
			/**
			 * `true` if an inverted color scheme, such as a high contrast theme, is being
			 * used, `false` otherwise.
			 */
			invertedColorScheme: boolean) => void): this;
		getAccentColor(): string;
		getColor(color: '3d-dark-shadow' | '3d-face' | '3d-highlight' | '3d-light' | '3d-shadow' | 'active-border' | 'active-caption' | 'active-caption-gradient' | 'app-workspace' | 'button-text' | 'caption-text' | 'desktop' | 'disabled-text' | 'highlight' | 'highlight-text' | 'hotlight' | 'inactive-border' | 'inactive-caption' | 'inactive-caption-gradient' | 'inactive-caption-text' | 'info-background' | 'info-text' | 'menu' | 'menu-highlight' | 'menubar' | 'menu-text' | 'scrollbar' | 'window' | 'window-frame' | 'window-text'): string;
B
Benjamin Pasero 已提交
4257
		/**
4258
		 * Some popular key and types are:
B
Benjamin Pasero 已提交
4259
		 */
4260
		getUserDefault(key: string, type: 'string' | 'boolean' | 'integer' | 'float' | 'double' | 'url' | 'array' | 'dictionary'): any;
B
Benjamin Pasero 已提交
4261
		/**
4262 4263
		 * An example of using it to determine if you should create a transparent window or
		 * not (transparent windows won't work correctly when DWM composition is disabled):
B
Benjamin Pasero 已提交
4264
		 */
4265 4266 4267 4268
		isAeroGlassEnabled(): boolean;
		isDarkMode(): boolean;
		isInvertedColorScheme(): boolean;
		isSwipeTrackingFromScrollEventsEnabled(): boolean;
B
Benjamin Pasero 已提交
4269
		/**
4270 4271
		 * Posts event as native notifications of macOS. The userInfo is an Object that
		 * contains the user information dictionary sent along with the notification.
B
Benjamin Pasero 已提交
4272
		 */
4273
		postLocalNotification(event: string, userInfo: any): void;
B
Benjamin Pasero 已提交
4274
		/**
4275 4276
		 * Posts event as native notifications of macOS. The userInfo is an Object that
		 * contains the user information dictionary sent along with the notification.
B
Benjamin Pasero 已提交
4277
		 */
4278
		postNotification(event: string, userInfo: any): void;
4279 4280 4281 4282 4283
		/**
		 * Posts event as native notifications of macOS. The userInfo is an Object that
		 * contains the user information dictionary sent along with the notification.
		 */
		postWorkspaceNotification(event: string, userInfo: any): void;
B
Benjamin Pasero 已提交
4284
		/**
4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295
		 * Add the specified defaults to your application's NSUserDefaults.
		 */
		registerDefaults(defaults: any): void;
		/**
		 * Removes the key in NSUserDefaults. This can be used to restore the default or
		 * global value of a key previously set with setUserDefault.
		 */
		removeUserDefault(key: string): void;
		/**
		 * Set the value of key in NSUserDefaults. Note that type should match actual type
		 * of value. An exception is thrown if they don't. Some popular key and types are:
B
Benjamin Pasero 已提交
4296
		 */
4297
		setUserDefault(key: string, type: string, value: string): void;
B
Benjamin Pasero 已提交
4298
		/**
4299
		 * Same as subscribeNotification, but uses NSNotificationCenter for local defaults.
4300
		 * This is necessary for events such as NSUserDefaultsDidChangeNotification.
B
Benjamin Pasero 已提交
4301
		 */
4302
		subscribeLocalNotification(event: string, callback: (event: string, userInfo: any) => void): number;
B
Benjamin Pasero 已提交
4303
		/**
4304 4305 4306 4307 4308 4309
		 * Subscribes to native notifications of macOS, callback will be called with
		 * callback(event, userInfo) when the corresponding event happens. The userInfo is
		 * an Object that contains the user information dictionary sent along with the
		 * notification. The id of the subscriber is returned, which can be used to
		 * unsubscribe the event. Under the hood this API subscribes to
		 * NSDistributedNotificationCenter, example values of event are:
B
Benjamin Pasero 已提交
4310
		 */
4311 4312 4313 4314 4315 4316 4317
		subscribeNotification(event: string, callback: (event: string, userInfo: any) => void): number;
		/**
		 * Same as subscribeNotification, but uses
		 * NSWorkspace.sharedWorkspace.notificationCenter. This is necessary for events
		 * such as NSWorkspaceDidActivateApplicationNotification.
		 */
		subscribeWorkspaceNotification(event: string, callback: (event: string, userInfo: any) => void): void;
B
Benjamin Pasero 已提交
4318
		/**
4319 4320
		 * Same as unsubscribeNotification, but removes the subscriber from
		 * NSNotificationCenter.
B
Benjamin Pasero 已提交
4321
		 */
4322
		unsubscribeLocalNotification(id: number): void;
B
Benjamin Pasero 已提交
4323
		/**
4324
		 * Removes the subscriber with id.
B
Benjamin Pasero 已提交
4325
		 */
4326
		unsubscribeNotification(id: number): void;
4327 4328 4329 4330 4331
		/**
		 * Same as unsubscribeNotification, but removes the subscriber from
		 * NSWorkspace.sharedWorkspace.notificationCenter.
		 */
		unsubscribeWorkspaceNotification(id: number): void;
B
Benjamin Pasero 已提交
4332 4333
	}

4334 4335 4336
	interface Task {

		// Docs: http://electron.atom.io/docs/api/structures/task
B
Benjamin Pasero 已提交
4337 4338

		/**
4339
		 * The command line arguments when program is executed.
B
Benjamin Pasero 已提交
4340
		 */
4341
		arguments: string;
B
Benjamin Pasero 已提交
4342
		/**
4343
		 * Description of this task.
B
Benjamin Pasero 已提交
4344
		 */
4345
		description: string;
B
Benjamin Pasero 已提交
4346
		/**
4347 4348 4349
		 * The icon index in the icon file. If an icon file consists of two or more icons,
		 * set this value to identify the icon. If an icon file consists of one icon, this
		 * value is 0.
B
Benjamin Pasero 已提交
4350
		 */
4351
		iconIndex: number;
B
Benjamin Pasero 已提交
4352
		/**
4353 4354 4355
		 * The absolute path to an icon to be displayed in a JumpList, which can be an
		 * arbitrary resource file that contains an icon. You can usually specify
		 * process.execPath to show the icon of the program.
B
Benjamin Pasero 已提交
4356
		 */
4357
		iconPath: string;
B
Benjamin Pasero 已提交
4358
		/**
4359 4360
		 * Path of the program to execute, usually you should specify process.execPath
		 * which opens the current program.
B
Benjamin Pasero 已提交
4361
		 */
4362
		program: string;
B
Benjamin Pasero 已提交
4363
		/**
4364
		 * The string to be displayed in a JumpList.
B
Benjamin Pasero 已提交
4365
		 */
4366 4367 4368 4369 4370 4371 4372 4373
		title: string;
	}

	interface ThumbarButton {

		// Docs: http://electron.atom.io/docs/api/structures/thumbar-button

		click: Function;
B
Benjamin Pasero 已提交
4374
		/**
4375 4376
		 * Control specific states and behaviors of the button. By default, it is
		 * ['enabled'].
B
Benjamin Pasero 已提交
4377
		 */
4378
		flags?: string[];
B
Benjamin Pasero 已提交
4379
		/**
4380
		 * The icon showing in thumbnail toolbar.
B
Benjamin Pasero 已提交
4381
		 */
4382
		icon: NativeImage;
B
Benjamin Pasero 已提交
4383
		/**
4384
		 * The text of the button's tooltip.
B
Benjamin Pasero 已提交
4385
		 */
4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477
		tooltip?: string;
	}

	class TouchBarButton extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/touch-bar-button

		constructor(options: TouchBarButtonConstructorOptions);
		backgroundColor: string;
		icon: NativeImage;
		label: string;
	}

	class TouchBarColorPicker extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/touch-bar-color-picker

		constructor(options: TouchBarColorPickerConstructorOptions);
		availableColors: string[];
		selectedColor: string;
	}

	class TouchBarGroup extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/touch-bar-group

		constructor(options: TouchBarGroupConstructorOptions);
	}

	class TouchBarLabel extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/touch-bar-label

		constructor(options: TouchBarLabelConstructorOptions);
		label: string;
		textColor: string;
	}

	class TouchBarPopover extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/touch-bar-popover

		constructor(options: TouchBarPopoverConstructorOptions);
		icon: NativeImage;
		label: string;
	}

	class TouchBarScrubber extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/touch-bar-scrubber

		constructor(options: TouchBarScrubberConstructorOptions);
		continuous: boolean;
		items: ScrubberItem[];
		mode: string;
		overlayStyle: string;
		selectedStyle: string;
		showArrowButtons: boolean;
	}

	class TouchBarSegmentedControl extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/touch-bar-segmented-control

		constructor(options: TouchBarSegmentedControlConstructorOptions);
		segments: SegmentedControlSegment[];
		segmentStyle: string;
		selectedIndex: number;
	}

	class TouchBarSlider extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/touch-bar-slider

		constructor(options: TouchBarSliderConstructorOptions);
		label: string;
		maxValue: number;
		minValue: number;
		value: number;
	}

	class TouchBarSpacer extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/touch-bar-spacer

		constructor(options: TouchBarSpacerConstructorOptions);
	}

	class TouchBar extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/touch-bar

B
Benjamin Pasero 已提交
4478
		constructor(options: TouchBarConstructorOptions);
4479
		escapeItem: (TouchBarButton | TouchBarColorPicker | TouchBarGroup | TouchBarLabel | TouchBarPopover | TouchBarScrubber | TouchBarSegmentedControl | TouchBarSlider | TouchBarSpacer | null);
4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490
		static TouchBarButton: typeof TouchBarButton;
		static TouchBarColorPicker: typeof TouchBarColorPicker;
		static TouchBarGroup: typeof TouchBarGroup;
		static TouchBarLabel: typeof TouchBarLabel;
		static TouchBarPopover: typeof TouchBarPopover;
		static TouchBarScrubber: typeof TouchBarScrubber;
		static TouchBarSegmentedControl: typeof TouchBarSegmentedControl;
		static TouchBarSlider: typeof TouchBarSlider;
		static TouchBarSpacer: typeof TouchBarSpacer;
	}

4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526
	interface TraceCategoriesAndOptions {

		// Docs: http://electron.atom.io/docs/api/structures/trace-categories-and-options

		/**
		 * – is a filter to control what category groups should be traced. A filter can
		 * have an optional prefix to exclude category groups that contain a matching
		 * category. Having both included and excluded category patterns in the same list
		 * is not supported. Examples: test_MyTest*, test_MyTest*,test_OtherStuff,
		 * -excluded_category1,-excluded_category2.
		 */
		categoryFilter: string;
		/**
		 * Controls what kind of tracing is enabled, it is a comma-delimited sequence of
		 * the following strings: record-until-full, record-continuously, trace-to-console,
		 * enable-sampling, enable-systrace, e.g. 'record-until-full,enable-sampling'. The
		 * first 3 options are trace recording modes and hence mutually exclusive. If more
		 * than one trace recording modes appear in the traceOptions string, the last one
		 * takes precedence. If none of the trace recording modes are specified, recording
		 * mode is record-until-full. The trace option will first be reset to the default
		 * option (record_mode set to record-until-full, enable_sampling and
		 * enable_systrace set to false) before options parsed from traceOptions are
		 * applied on it.
		 */
		traceOptions: string;
	}

	interface TraceConfig {

		// Docs: http://electron.atom.io/docs/api/structures/trace-config

		excluded_categories?: string[];
		included_categories?: string[];
		memory_dump_config?: MemoryDumpConfig;
	}

4527 4528 4529 4530
	interface Transaction {

		// Docs: http://electron.atom.io/docs/api/structures/transaction

4531 4532 4533
		/**
		 * The error code if an error occurred while processing the transaction.
		 */
4534
		errorCode: number;
4535 4536 4537
		/**
		 * The error message if an error occurred while processing the transaction.
		 */
4538
		errorMessage: string;
4539 4540 4541
		/**
		 * The identifier of the restored transaction by the App Store.
		 */
4542 4543
		originalTransactionIdentifier: string;
		payment: Payment;
4544 4545 4546
		/**
		 * The date the transaction was added to the App Store’s payment queue.
		 */
4547
		transactionDate: string;
4548 4549 4550
		/**
		 * A string that uniquely identifies a successful payment transaction.
		 */
4551 4552
		transactionIdentifier: string;
		/**
4553 4554
		 * The transaction state, can be purchasing, purchased, failed, restored or
		 * deferred.
4555
		 */
4556
		transactionState: ('purchasing' | 'purchased' | 'failed' | 'restored' | 'deferred');
4557 4558
	}

4559 4560 4561 4562
	class Tray extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/tray

B
Benjamin Pasero 已提交
4563
		/**
4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577
		 * Emitted when the tray balloon is clicked.
		 */
		on(event: 'balloon-click', listener: Function): this;
		once(event: 'balloon-click', listener: Function): this;
		addListener(event: 'balloon-click', listener: Function): this;
		removeListener(event: 'balloon-click', listener: Function): this;
		/**
		 * Emitted when the tray balloon is closed because of timeout or user manually
		 * closes it.
		 */
		on(event: 'balloon-closed', listener: Function): this;
		once(event: 'balloon-closed', listener: Function): this;
		addListener(event: 'balloon-closed', listener: Function): this;
		removeListener(event: 'balloon-closed', listener: Function): this;
B
Benjamin Pasero 已提交
4578
		/**
4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589
		 * Emitted when the tray balloon shows.
		 */
		on(event: 'balloon-show', listener: Function): this;
		once(event: 'balloon-show', listener: Function): this;
		addListener(event: 'balloon-show', listener: Function): this;
		removeListener(event: 'balloon-show', listener: Function): this;
		/**
		 * Emitted when the tray icon is clicked.
		 */
		on(event: 'click', listener: (event: Event,
			/**
4590
			 * The bounds of tray icon.
B
Benjamin Pasero 已提交
4591
			 */
4592 4593 4594 4595 4596
			bounds: Rectangle,
			/**
			 * The position of the event.
			 */
			position: Point) => void): this;
4597 4598
		once(event: 'click', listener: (event: Event,
			/**
4599
			 * The bounds of tray icon.
B
Benjamin Pasero 已提交
4600
			 */
4601 4602 4603 4604 4605
			bounds: Rectangle,
			/**
			 * The position of the event.
			 */
			position: Point) => void): this;
4606 4607
		addListener(event: 'click', listener: (event: Event,
			/**
4608
			 * The bounds of tray icon.
B
Benjamin Pasero 已提交
4609
			 */
4610 4611 4612 4613 4614
			bounds: Rectangle,
			/**
			 * The position of the event.
			 */
			position: Point) => void): this;
4615 4616
		removeListener(event: 'click', listener: (event: Event,
			/**
4617
			 * The bounds of tray icon.
B
Benjamin Pasero 已提交
4618
			 */
4619 4620 4621 4622 4623
			bounds: Rectangle,
			/**
			 * The position of the event.
			 */
			position: Point) => void): this;
4624 4625 4626 4627 4628
		/**
		 * Emitted when the tray icon is double clicked.
		 */
		on(event: 'double-click', listener: (event: Event,
			/**
4629
			 * The bounds of tray icon.
4630 4631 4632 4633
			 */
			bounds: Rectangle) => void): this;
		once(event: 'double-click', listener: (event: Event,
			/**
4634
			 * The bounds of tray icon.
4635 4636 4637 4638
			 */
			bounds: Rectangle) => void): this;
		addListener(event: 'double-click', listener: (event: Event,
			/**
4639
			 * The bounds of tray icon.
4640 4641 4642 4643
			 */
			bounds: Rectangle) => void): this;
		removeListener(event: 'double-click', listener: (event: Event,
			/**
4644
			 * The bounds of tray icon.
4645 4646 4647 4648 4649 4650 4651 4652 4653 4654 4655 4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 4692 4693 4694 4695 4696 4697 4698 4699 4700 4701 4702
			 */
			bounds: Rectangle) => void): this;
		/**
		 * Emitted when a drag operation ends on the tray or ends at another location.
		 */
		on(event: 'drag-end', listener: Function): this;
		once(event: 'drag-end', listener: Function): this;
		addListener(event: 'drag-end', listener: Function): this;
		removeListener(event: 'drag-end', listener: Function): this;
		/**
		 * Emitted when a drag operation enters the tray icon.
		 */
		on(event: 'drag-enter', listener: Function): this;
		once(event: 'drag-enter', listener: Function): this;
		addListener(event: 'drag-enter', listener: Function): this;
		removeListener(event: 'drag-enter', listener: Function): this;
		/**
		 * Emitted when a drag operation exits the tray icon.
		 */
		on(event: 'drag-leave', listener: Function): this;
		once(event: 'drag-leave', listener: Function): this;
		addListener(event: 'drag-leave', listener: Function): this;
		removeListener(event: 'drag-leave', listener: Function): this;
		/**
		 * Emitted when any dragged items are dropped on the tray icon.
		 */
		on(event: 'drop', listener: Function): this;
		once(event: 'drop', listener: Function): this;
		addListener(event: 'drop', listener: Function): this;
		removeListener(event: 'drop', listener: Function): this;
		/**
		 * Emitted when dragged files are dropped in the tray icon.
		 */
		on(event: 'drop-files', listener: (event: Event,
			/**
			 * The paths of the dropped files.
			 */
			files: string[]) => void): this;
		once(event: 'drop-files', listener: (event: Event,
			/**
			 * The paths of the dropped files.
			 */
			files: string[]) => void): this;
		addListener(event: 'drop-files', listener: (event: Event,
			/**
			 * The paths of the dropped files.
			 */
			files: string[]) => void): this;
		removeListener(event: 'drop-files', listener: (event: Event,
			/**
			 * The paths of the dropped files.
			 */
			files: string[]) => void): this;
		/**
		 * Emitted when dragged text is dropped in the tray icon.
		 */
		on(event: 'drop-text', listener: (event: Event,
			/**
4703
			 * the dropped text string.
4704 4705 4706 4707
			 */
			text: string) => void): this;
		once(event: 'drop-text', listener: (event: Event,
			/**
4708
			 * the dropped text string.
4709 4710 4711 4712
			 */
			text: string) => void): this;
		addListener(event: 'drop-text', listener: (event: Event,
			/**
4713
			 * the dropped text string.
4714 4715 4716 4717
			 */
			text: string) => void): this;
		removeListener(event: 'drop-text', listener: (event: Event,
			/**
4718
			 * the dropped text string.
4719 4720
			 */
			text: string) => void): this;
B
Benjamin Pasero 已提交
4721 4722 4723 4724 4725
		/**
		 * Emitted when the mouse enters the tray icon.
		 */
		on(event: 'mouse-enter', listener: (event: Event,
			/**
4726
			 * The position of the event.
B
Benjamin Pasero 已提交
4727 4728 4729 4730
			 */
			position: Point) => void): this;
		once(event: 'mouse-enter', listener: (event: Event,
			/**
4731
			 * The position of the event.
B
Benjamin Pasero 已提交
4732 4733 4734 4735
			 */
			position: Point) => void): this;
		addListener(event: 'mouse-enter', listener: (event: Event,
			/**
4736
			 * The position of the event.
B
Benjamin Pasero 已提交
4737 4738 4739 4740
			 */
			position: Point) => void): this;
		removeListener(event: 'mouse-enter', listener: (event: Event,
			/**
4741
			 * The position of the event.
B
Benjamin Pasero 已提交
4742 4743 4744 4745 4746 4747 4748
			 */
			position: Point) => void): this;
		/**
		 * Emitted when the mouse exits the tray icon.
		 */
		on(event: 'mouse-leave', listener: (event: Event,
			/**
4749
			 * The position of the event.
B
Benjamin Pasero 已提交
4750 4751 4752 4753
			 */
			position: Point) => void): this;
		once(event: 'mouse-leave', listener: (event: Event,
			/**
4754
			 * The position of the event.
B
Benjamin Pasero 已提交
4755 4756 4757 4758
			 */
			position: Point) => void): this;
		addListener(event: 'mouse-leave', listener: (event: Event,
			/**
4759
			 * The position of the event.
B
Benjamin Pasero 已提交
4760 4761 4762 4763
			 */
			position: Point) => void): this;
		removeListener(event: 'mouse-leave', listener: (event: Event,
			/**
4764 4765 4766 4767 4768 4769 4770 4771 4772 4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787
			 * The position of the event.
			 */
			position: Point) => void): this;
		/**
		 * Emitted when the mouse moves in the tray icon.
		 */
		on(event: 'mouse-move', listener: (event: Event,
			/**
			 * The position of the event.
			 */
			position: Point) => void): this;
		once(event: 'mouse-move', listener: (event: Event,
			/**
			 * The position of the event.
			 */
			position: Point) => void): this;
		addListener(event: 'mouse-move', listener: (event: Event,
			/**
			 * The position of the event.
			 */
			position: Point) => void): this;
		removeListener(event: 'mouse-move', listener: (event: Event,
			/**
			 * The position of the event.
B
Benjamin Pasero 已提交
4788 4789
			 */
			position: Point) => void): this;
4790 4791 4792 4793 4794
		/**
		 * Emitted when the tray icon is right clicked.
		 */
		on(event: 'right-click', listener: (event: Event,
			/**
4795
			 * The bounds of tray icon.
4796 4797 4798 4799
			 */
			bounds: Rectangle) => void): this;
		once(event: 'right-click', listener: (event: Event,
			/**
4800
			 * The bounds of tray icon.
4801 4802 4803 4804
			 */
			bounds: Rectangle) => void): this;
		addListener(event: 'right-click', listener: (event: Event,
			/**
4805
			 * The bounds of tray icon.
4806 4807 4808 4809
			 */
			bounds: Rectangle) => void): this;
		removeListener(event: 'right-click', listener: (event: Event,
			/**
4810
			 * The bounds of tray icon.
4811 4812 4813 4814 4815 4816 4817 4818 4819 4820 4821 4822 4823 4824 4825
			 */
			bounds: Rectangle) => void): this;
		constructor(image: NativeImage | string);
		/**
		 * Destroys the tray icon immediately.
		 */
		destroy(): void;
		/**
		 * Displays a tray balloon.
		 */
		displayBalloon(options: DisplayBalloonOptions): void;
		/**
		 * The bounds of this tray icon as Object.
		 */
		getBounds(): Rectangle;
4826
		getIgnoreDoubleClickEvents(): boolean;
4827 4828 4829 4830 4831 4832 4833 4834 4835 4836
		isDestroyed(): boolean;
		/**
		 * Pops up the context menu of the tray icon. When menu is passed, the menu will be
		 * shown instead of the tray icon's context menu. The position is only available on
		 * Windows, and it is (0, 0) by default.
		 */
		popUpContextMenu(menu?: Menu, position?: Point): void;
		/**
		 * Sets the context menu for this icon.
		 */
4837
		setContextMenu(menu: Menu | null): void;
4838 4839 4840 4841 4842 4843
		/**
		 * Sets when the tray's icon background becomes highlighted (in blue). Note: You
		 * can use highlightMode with a BrowserWindow by toggling between 'never' and
		 * 'always' modes when the window visibility changes.
		 */
		setHighlightMode(mode: 'selection' | 'always' | 'never'): void;
4844 4845 4846 4847 4848 4849
		/**
		 * Sets the option to ignore double click events. Ignoring these events allows you
		 * to detect every individual click of the tray icon. This value is set to false by
		 * default.
		 */
		setIgnoreDoubleClickEvents(ignore: boolean): void;
4850 4851 4852 4853 4854 4855 4856
		/**
		 * Sets the image associated with this tray icon.
		 */
		setImage(image: NativeImage | string): void;
		/**
		 * Sets the image associated with this tray icon when pressed on macOS.
		 */
4857
		setPressedImage(image: NativeImage | string): void;
4858
		/**
4859 4860
		 * Sets the title displayed aside of the tray icon in the status bar (Support ANSI
		 * colors).
4861 4862 4863 4864 4865 4866 4867 4868 4869 4870 4871 4872 4873 4874 4875 4876 4877 4878 4879 4880 4881 4882 4883 4884 4885 4886 4887 4888 4889 4890 4891 4892 4893 4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913
		 */
		setTitle(title: string): void;
		/**
		 * Sets the hover text for this tray icon.
		 */
		setToolTip(toolTip: string): void;
	}

	interface UploadBlob {

		// Docs: http://electron.atom.io/docs/api/structures/upload-blob

		/**
		 * UUID of blob data to upload.
		 */
		blobUUID: string;
		/**
		 * blob.
		 */
		type: string;
	}

	interface UploadData {

		// Docs: http://electron.atom.io/docs/api/structures/upload-data

		/**
		 * UUID of blob data. Use method to retrieve the data.
		 */
		blobUUID: string;
		/**
		 * Content being sent.
		 */
		bytes: Buffer;
		/**
		 * Path of file being uploaded.
		 */
		file: string;
	}

	interface UploadFile {

		// Docs: http://electron.atom.io/docs/api/structures/upload-file

		/**
		 * Path of file to be uploaded.
		 */
		filePath: string;
		/**
		 * Number of bytes to read from offset. Defaults to 0.
		 */
		length: number;
		/**
4914
		 * Last Modification time in number of seconds since the UNIX epoch.
4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 4930 4931 4932 4933 4934 4935 4936 4937 4938 4939 4940 4941 4942 4943 4944 4945 4946 4947 4948 4949
		 */
		modificationTime: number;
		/**
		 * Defaults to 0.
		 */
		offset: number;
		/**
		 * file.
		 */
		type: string;
	}

	interface UploadRawData {

		// Docs: http://electron.atom.io/docs/api/structures/upload-raw-data

		/**
		 * Data to be uploaded.
		 */
		bytes: Buffer;
		/**
		 * rawData.
		 */
		type: string;
	}

	class WebContents extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/web-contents

		static fromId(id: number): WebContents;
		static getAllWebContents(): WebContents[];
		static getFocusedWebContents(): WebContents;
		/**
		 * Emitted before dispatching the keydown and keyup events in the page. Calling
B
Benjamin Pasero 已提交
4950 4951
		 * event.preventDefault will prevent the page keydown/keyup events and the menu
		 * shortcuts. To only prevent the menu shortcuts, use setIgnoreMenuShortcuts:
4952 4953 4954
		 */
		on(event: 'before-input-event', listener: (event: Event,
			/**
4955
			 * Input properties.
4956 4957 4958 4959
			 */
			input: Input) => void): this;
		once(event: 'before-input-event', listener: (event: Event,
			/**
4960
			 * Input properties.
4961 4962 4963 4964
			 */
			input: Input) => void): this;
		addListener(event: 'before-input-event', listener: (event: Event,
			/**
4965
			 * Input properties.
4966 4967 4968 4969
			 */
			input: Input) => void): this;
		removeListener(event: 'before-input-event', listener: (event: Event,
			/**
4970
			 * Input properties.
4971 4972 4973 4974 4975 4976 4977 4978 4979
			 */
			input: Input) => void): this;
		/**
		 * Emitted when failed to verify the certificate for url. The usage is the same
		 * with the certificate-error event of app.
		 */
		on(event: 'certificate-error', listener: (event: Event,
			url: string,
			/**
4980
			 * The error code.
4981 4982 4983 4984 4985 4986 4987
			 */
			error: string,
			certificate: Certificate,
			callback: (isTrusted: boolean) => void) => void): this;
		once(event: 'certificate-error', listener: (event: Event,
			url: string,
			/**
4988
			 * The error code.
4989 4990 4991 4992 4993 4994 4995
			 */
			error: string,
			certificate: Certificate,
			callback: (isTrusted: boolean) => void) => void): this;
		addListener(event: 'certificate-error', listener: (event: Event,
			url: string,
			/**
4996
			 * The error code.
4997 4998 4999 5000 5001 5002 5003
			 */
			error: string,
			certificate: Certificate,
			callback: (isTrusted: boolean) => void) => void): this;
		removeListener(event: 'certificate-error', listener: (event: Event,
			url: string,
			/**
5004
			 * The error code.
5005 5006 5007 5008
			 */
			error: string,
			certificate: Certificate,
			callback: (isTrusted: boolean) => void) => void): this;
5009 5010 5011 5012
		/**
		 * Emitted when the associated window logs a console message. Will not be emitted
		 * for windows with offscreen rendering enabled.
		 */
5013 5014
		on(event: 'console-message', listener: (event: Event,
			level: number,
5015 5016 5017
			message: string,
			line: number,
			sourceId: string) => void): this;
5018 5019
		once(event: 'console-message', listener: (event: Event,
			level: number,
5020 5021 5022
			message: string,
			line: number,
			sourceId: string) => void): this;
5023 5024
		addListener(event: 'console-message', listener: (event: Event,
			level: number,
5025 5026 5027
			message: string,
			line: number,
			sourceId: string) => void): this;
5028 5029
		removeListener(event: 'console-message', listener: (event: Event,
			level: number,
5030 5031 5032
			message: string,
			line: number,
			sourceId: string) => void): this;
5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 5048 5049 5050 5051 5052 5053 5054 5055 5056 5057 5058 5059 5060 5061
		/**
		 * Emitted when there is a new context menu that needs to be handled.
		 */
		on(event: 'context-menu', listener: (event: Event,
			params: ContextMenuParams) => void): this;
		once(event: 'context-menu', listener: (event: Event,
			params: ContextMenuParams) => void): this;
		addListener(event: 'context-menu', listener: (event: Event,
			params: ContextMenuParams) => void): this;
		removeListener(event: 'context-menu', listener: (event: Event,
			params: ContextMenuParams) => void): this;
		/**
		 * Emitted when the renderer process crashes or is killed.
		 */
		on(event: 'crashed', listener: (event: Event,
			killed: boolean) => void): this;
		once(event: 'crashed', listener: (event: Event,
			killed: boolean) => void): this;
		addListener(event: 'crashed', listener: (event: Event,
			killed: boolean) => void): this;
		removeListener(event: 'crashed', listener: (event: Event,
			killed: boolean) => void): this;
		/**
		 * Emitted when the cursor's type changes. The type parameter can be default,
		 * crosshair, pointer, text, wait, help, e-resize, n-resize, ne-resize, nw-resize,
		 * s-resize, se-resize, sw-resize, w-resize, ns-resize, ew-resize, nesw-resize,
		 * nwse-resize, col-resize, row-resize, m-panning, e-panning, n-panning,
		 * ne-panning, nw-panning, s-panning, se-panning, sw-panning, w-panning, move,
		 * vertical-text, cell, context-menu, alias, progress, nodrop, copy, none,
5062 5063 5064 5065
		 * not-allowed, zoom-in, zoom-out, grab, grabbing or custom. If the type parameter
		 * is custom, the image parameter will hold the custom cursor image in a
		 * NativeImage, and scale, size and hotspot will hold additional information about
		 * the custom cursor.
5066 5067 5068 5069 5070
		 */
		on(event: 'cursor-changed', listener: (event: Event,
			type: string,
			image?: NativeImage,
			/**
5071
			 * scaling factor for the custom cursor.
5072 5073 5074
			 */
			scale?: number,
			/**
5075
			 * the size of the `image`.
5076 5077 5078
			 */
			size?: Size,
			/**
5079
			 * coordinates of the custom cursor's hotspot.
5080 5081 5082 5083 5084 5085
			 */
			hotspot?: Point) => void): this;
		once(event: 'cursor-changed', listener: (event: Event,
			type: string,
			image?: NativeImage,
			/**
5086
			 * scaling factor for the custom cursor.
5087 5088 5089
			 */
			scale?: number,
			/**
5090
			 * the size of the `image`.
5091 5092 5093
			 */
			size?: Size,
			/**
5094
			 * coordinates of the custom cursor's hotspot.
5095 5096 5097 5098 5099 5100
			 */
			hotspot?: Point) => void): this;
		addListener(event: 'cursor-changed', listener: (event: Event,
			type: string,
			image?: NativeImage,
			/**
5101
			 * scaling factor for the custom cursor.
5102 5103 5104
			 */
			scale?: number,
			/**
5105
			 * the size of the `image`.
5106 5107 5108
			 */
			size?: Size,
			/**
5109
			 * coordinates of the custom cursor's hotspot.
5110 5111 5112 5113 5114 5115
			 */
			hotspot?: Point) => void): this;
		removeListener(event: 'cursor-changed', listener: (event: Event,
			type: string,
			image?: NativeImage,
			/**
5116
			 * scaling factor for the custom cursor.
5117 5118 5119
			 */
			scale?: number,
			/**
5120
			 * the size of the `image`.
5121 5122 5123
			 */
			size?: Size,
			/**
5124
			 * coordinates of the custom cursor's hotspot.
5125 5126 5127 5128 5129 5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161
			 */
			hotspot?: Point) => void): this;
		/**
		 * Emitted when webContents is destroyed.
		 */
		on(event: 'destroyed', listener: Function): this;
		once(event: 'destroyed', listener: Function): this;
		addListener(event: 'destroyed', listener: Function): this;
		removeListener(event: 'destroyed', listener: Function): this;
		/**
		 * Emitted when DevTools is closed.
		 */
		on(event: 'devtools-closed', listener: Function): this;
		once(event: 'devtools-closed', listener: Function): this;
		addListener(event: 'devtools-closed', listener: Function): this;
		removeListener(event: 'devtools-closed', listener: Function): this;
		/**
		 * Emitted when DevTools is focused / opened.
		 */
		on(event: 'devtools-focused', listener: Function): this;
		once(event: 'devtools-focused', listener: Function): this;
		addListener(event: 'devtools-focused', listener: Function): this;
		removeListener(event: 'devtools-focused', listener: Function): this;
		/**
		 * Emitted when DevTools is opened.
		 */
		on(event: 'devtools-opened', listener: Function): this;
		once(event: 'devtools-opened', listener: Function): this;
		addListener(event: 'devtools-opened', listener: Function): this;
		removeListener(event: 'devtools-opened', listener: Function): this;
		/**
		 * Emitted when the devtools window instructs the webContents to reload
		 */
		on(event: 'devtools-reload-page', listener: Function): this;
		once(event: 'devtools-reload-page', listener: Function): this;
		addListener(event: 'devtools-reload-page', listener: Function): this;
		removeListener(event: 'devtools-reload-page', listener: Function): this;
5162 5163 5164 5165 5166 5167 5168 5169 5170 5171 5172 5173 5174 5175 5176 5177 5178 5179 5180 5181 5182 5183 5184
		/**
		 * Emitted when a <webview> has been attached to this web contents.
		 */
		on(event: 'did-attach-webview', listener: (event: Event,
			/**
			 * The guest web contents that is used by the `<webview>`.
			 */
			webContents: WebContents) => void): this;
		once(event: 'did-attach-webview', listener: (event: Event,
			/**
			 * The guest web contents that is used by the `<webview>`.
			 */
			webContents: WebContents) => void): this;
		addListener(event: 'did-attach-webview', listener: (event: Event,
			/**
			 * The guest web contents that is used by the `<webview>`.
			 */
			webContents: WebContents) => void): this;
		removeListener(event: 'did-attach-webview', listener: (event: Event,
			/**
			 * The guest web contents that is used by the `<webview>`.
			 */
			webContents: WebContents) => void): this;
5185 5186 5187 5188
		/**
		 * Emitted when a page's theme color changes. This is usually due to encountering a
		 * meta tag:
		 */
5189 5190 5191 5192 5193 5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208
		on(event: 'did-change-theme-color', listener: (event: Event,
			/**
			 * Theme color is in format of '#rrggbb'. It is `null` when no theme color is set.
			 */
			color: string | null) => void): this;
		once(event: 'did-change-theme-color', listener: (event: Event,
			/**
			 * Theme color is in format of '#rrggbb'. It is `null` when no theme color is set.
			 */
			color: string | null) => void): this;
		addListener(event: 'did-change-theme-color', listener: (event: Event,
			/**
			 * Theme color is in format of '#rrggbb'. It is `null` when no theme color is set.
			 */
			color: string | null) => void): this;
		removeListener(event: 'did-change-theme-color', listener: (event: Event,
			/**
			 * Theme color is in format of '#rrggbb'. It is `null` when no theme color is set.
			 */
			color: string | null) => void): this;
5209 5210 5211 5212 5213 5214 5215 5216 5217
		/**
		 * This event is like did-finish-load but emitted when the load failed or was
		 * cancelled, e.g. window.stop() is invoked. The full list of error codes and their
		 * meaning is available here.
		 */
		on(event: 'did-fail-load', listener: (event: Event,
			errorCode: number,
			errorDescription: string,
			validatedURL: string,
5218 5219 5220
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5221 5222 5223 5224
		once(event: 'did-fail-load', listener: (event: Event,
			errorCode: number,
			errorDescription: string,
			validatedURL: string,
5225 5226 5227
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5228 5229 5230 5231
		addListener(event: 'did-fail-load', listener: (event: Event,
			errorCode: number,
			errorDescription: string,
			validatedURL: string,
5232 5233 5234
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5235 5236 5237 5238
		removeListener(event: 'did-fail-load', listener: (event: Event,
			errorCode: number,
			errorDescription: string,
			validatedURL: string,
5239 5240 5241
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5242 5243 5244 5245 5246 5247 5248 5249 5250 5251 5252 5253
		/**
		 * Emitted when the navigation is done, i.e. the spinner of the tab has stopped
		 * spinning, and the onload event was dispatched.
		 */
		on(event: 'did-finish-load', listener: Function): this;
		once(event: 'did-finish-load', listener: Function): this;
		addListener(event: 'did-finish-load', listener: Function): this;
		removeListener(event: 'did-finish-load', listener: Function): this;
		/**
		 * Emitted when a frame has done navigation.
		 */
		on(event: 'did-frame-finish-load', listener: (event: Event,
5254 5255 5256
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5257
		once(event: 'did-frame-finish-load', listener: (event: Event,
5258 5259 5260
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5261
		addListener(event: 'did-frame-finish-load', listener: (event: Event,
5262 5263 5264
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5265
		removeListener(event: 'did-frame-finish-load', listener: (event: Event,
5266 5267 5268
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5269
		/**
5270 5271 5272
		 * Emitted when any frame navigation is done. This event is not emitted for in-page
		 * navigations, such as clicking anchor links or updating the window.location.hash.
		 * Use did-navigate-in-page event for this purpose.
5273
		 */
5274 5275 5276 5277 5278
		on(event: 'did-frame-navigate', listener: (event: Event,
			url: string,
			/**
			 * -1 for non HTTP navigations
			 */
5279
			httpResponseCode: number,
5280 5281 5282 5283
			/**
			 * empty for non HTTP navigations,
			 */
			httpStatusText: string,
5284
			isMainFrame: boolean,
5285 5286 5287 5288 5289 5290 5291
			frameProcessId: number,
			frameRoutingId: number) => void): this;
		once(event: 'did-frame-navigate', listener: (event: Event,
			url: string,
			/**
			 * -1 for non HTTP navigations
			 */
5292
			httpResponseCode: number,
5293 5294 5295 5296
			/**
			 * empty for non HTTP navigations,
			 */
			httpStatusText: string,
5297
			isMainFrame: boolean,
5298 5299 5300 5301 5302 5303 5304
			frameProcessId: number,
			frameRoutingId: number) => void): this;
		addListener(event: 'did-frame-navigate', listener: (event: Event,
			url: string,
			/**
			 * -1 for non HTTP navigations
			 */
5305
			httpResponseCode: number,
5306 5307 5308 5309
			/**
			 * empty for non HTTP navigations,
			 */
			httpStatusText: string,
5310
			isMainFrame: boolean,
5311 5312 5313 5314 5315 5316 5317
			frameProcessId: number,
			frameRoutingId: number) => void): this;
		removeListener(event: 'did-frame-navigate', listener: (event: Event,
			url: string,
			/**
			 * -1 for non HTTP navigations
			 */
5318
			httpResponseCode: number,
5319 5320 5321 5322 5323 5324 5325
			/**
			 * empty for non HTTP navigations,
			 */
			httpStatusText: string,
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5326
		/**
5327 5328 5329
		 * Emitted when a main frame navigation is done. This event is not emitted for
		 * in-page navigations, such as clicking anchor links or updating the
		 * window.location.hash. Use did-navigate-in-page event for this purpose.
5330 5331
		 */
		on(event: 'did-navigate', listener: (event: Event,
5332 5333 5334 5335 5336 5337 5338 5339 5340
			url: string,
			/**
			 * -1 for non HTTP navigations
			 */
			httpResponseCode: number,
			/**
			 * empty for non HTTP navigations
			 */
			httpStatusText: string) => void): this;
5341
		once(event: 'did-navigate', listener: (event: Event,
5342 5343 5344 5345 5346 5347 5348 5349 5350
			url: string,
			/**
			 * -1 for non HTTP navigations
			 */
			httpResponseCode: number,
			/**
			 * empty for non HTTP navigations
			 */
			httpStatusText: string) => void): this;
5351
		addListener(event: 'did-navigate', listener: (event: Event,
5352 5353 5354 5355 5356 5357 5358 5359 5360
			url: string,
			/**
			 * -1 for non HTTP navigations
			 */
			httpResponseCode: number,
			/**
			 * empty for non HTTP navigations
			 */
			httpStatusText: string) => void): this;
5361
		removeListener(event: 'did-navigate', listener: (event: Event,
5362 5363 5364 5365 5366 5367 5368 5369 5370
			url: string,
			/**
			 * -1 for non HTTP navigations
			 */
			httpResponseCode: number,
			/**
			 * empty for non HTTP navigations
			 */
			httpStatusText: string) => void): this;
5371
		/**
5372 5373 5374 5375
		 * Emitted when an in-page navigation happened in any frame. When in-page
		 * navigation happens, the page URL changes but does not cause navigation outside
		 * of the page. Examples of this occurring are when anchor links are clicked or
		 * when the DOM hashchange event is triggered.
5376 5377 5378
		 */
		on(event: 'did-navigate-in-page', listener: (event: Event,
			url: string,
5379 5380 5381
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5382 5383
		once(event: 'did-navigate-in-page', listener: (event: Event,
			url: string,
5384 5385 5386
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5387 5388
		addListener(event: 'did-navigate-in-page', listener: (event: Event,
			url: string,
5389 5390 5391
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5392 5393
		removeListener(event: 'did-navigate-in-page', listener: (event: Event,
			url: string,
5394 5395 5396
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5397 5398 5399 5400 5401 5402 5403
		/**
		 * Corresponds to the points in time when the spinner of the tab started spinning.
		 */
		on(event: 'did-start-loading', listener: Function): this;
		once(event: 'did-start-loading', listener: Function): this;
		addListener(event: 'did-start-loading', listener: Function): this;
		removeListener(event: 'did-start-loading', listener: Function): this;
5404 5405 5406 5407 5408 5409 5410 5411 5412 5413 5414 5415 5416 5417 5418 5419 5420 5421 5422 5423 5424 5425 5426 5427
		/**
		 * Emitted when any frame (including main) starts navigating. isInplace will be
		 * true for in-page navigations.
		 */
		on(event: 'did-start-navigation', listener: (url: string,
			isInPlace: boolean,
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
		once(event: 'did-start-navigation', listener: (url: string,
			isInPlace: boolean,
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
		addListener(event: 'did-start-navigation', listener: (url: string,
			isInPlace: boolean,
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
		removeListener(event: 'did-start-navigation', listener: (url: string,
			isInPlace: boolean,
			isMainFrame: boolean,
			frameProcessId: number,
			frameRoutingId: number) => void): this;
5428 5429 5430 5431 5432 5433 5434 5435 5436 5437 5438 5439 5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 5476 5477 5478 5479 5480 5481 5482 5483 5484 5485 5486 5487 5488 5489 5490 5491 5492 5493 5494 5495 5496 5497 5498 5499 5500 5501 5502 5503 5504 5505
		/**
		 * Corresponds to the points in time when the spinner of the tab stopped spinning.
		 */
		on(event: 'did-stop-loading', listener: Function): this;
		once(event: 'did-stop-loading', listener: Function): this;
		addListener(event: 'did-stop-loading', listener: Function): this;
		removeListener(event: 'did-stop-loading', listener: Function): this;
		/**
		 * Emitted when the document in the given frame is loaded.
		 */
		on(event: 'dom-ready', listener: (event: Event) => void): this;
		once(event: 'dom-ready', listener: (event: Event) => void): this;
		addListener(event: 'dom-ready', listener: (event: Event) => void): this;
		removeListener(event: 'dom-ready', listener: (event: Event) => void): this;
		/**
		 * Emitted when a result is available for [webContents.findInPage] request.
		 */
		on(event: 'found-in-page', listener: (event: Event,
			result: Result) => void): this;
		once(event: 'found-in-page', listener: (event: Event,
			result: Result) => void): this;
		addListener(event: 'found-in-page', listener: (event: Event,
			result: Result) => void): this;
		removeListener(event: 'found-in-page', listener: (event: Event,
			result: Result) => void): this;
		/**
		 * Emitted when webContents wants to do basic auth. The usage is the same with the
		 * login event of app.
		 */
		on(event: 'login', listener: (event: Event,
			request: Request,
			authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		once(event: 'login', listener: (event: Event,
			request: Request,
			authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		addListener(event: 'login', listener: (event: Event,
			request: Request,
			authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		removeListener(event: 'login', listener: (event: Event,
			request: Request,
			authInfo: AuthInfo,
			callback: (username: string, password: string) => void) => void): this;
		/**
		 * Emitted when media is paused or done playing.
		 */
		on(event: 'media-paused', listener: Function): this;
		once(event: 'media-paused', listener: Function): this;
		addListener(event: 'media-paused', listener: Function): this;
		removeListener(event: 'media-paused', listener: Function): this;
		/**
		 * Emitted when media starts playing.
		 */
		on(event: 'media-started-playing', listener: Function): this;
		once(event: 'media-started-playing', listener: Function): this;
		addListener(event: 'media-started-playing', listener: Function): this;
		removeListener(event: 'media-started-playing', listener: Function): this;
		/**
		 * Emitted when the page requests to open a new window for a url. It could be
		 * requested by window.open or an external link like <a target='_blank'>. By
		 * default a new BrowserWindow will be created for the url. Calling
		 * event.preventDefault() will prevent Electron from automatically creating a new
		 * BrowserWindow. If you call event.preventDefault() and manually create a new
		 * BrowserWindow then you must set event.newGuest to reference the new
		 * BrowserWindow instance, failing to do so may result in unexpected behavior. For
		 * example:
		 */
		on(event: 'new-window', listener: (event: Event,
			url: string,
			frameName: string,
			/**
			 * Can be `default`, `foreground-tab`, `background-tab`, `new-window`,
			 * `save-to-disk` and `other`.
			 */
			disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
			/**
5506
			 * The options which will be used for creating the new .
5507 5508 5509 5510 5511 5512
			 */
			options: any,
			/**
			 * The non-standard features (features not handled by Chromium or Electron) given
			 * to `window.open()`.
			 */
5513 5514 5515 5516 5517 5518
			additionalFeatures: string[],
			/**
			 * The referrer that will be passed to the new window. May or may not result in the
			 * `Referer` header being sent, depending on the referrer policy.
			 */
			referrer: Referrer) => void): this;
5519 5520 5521 5522 5523 5524 5525 5526 5527
		once(event: 'new-window', listener: (event: Event,
			url: string,
			frameName: string,
			/**
			 * Can be `default`, `foreground-tab`, `background-tab`, `new-window`,
			 * `save-to-disk` and `other`.
			 */
			disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
			/**
5528
			 * The options which will be used for creating the new .
5529 5530 5531 5532 5533 5534
			 */
			options: any,
			/**
			 * The non-standard features (features not handled by Chromium or Electron) given
			 * to `window.open()`.
			 */
5535 5536 5537 5538 5539 5540
			additionalFeatures: string[],
			/**
			 * The referrer that will be passed to the new window. May or may not result in the
			 * `Referer` header being sent, depending on the referrer policy.
			 */
			referrer: Referrer) => void): this;
5541 5542 5543 5544 5545 5546 5547 5548 5549
		addListener(event: 'new-window', listener: (event: Event,
			url: string,
			frameName: string,
			/**
			 * Can be `default`, `foreground-tab`, `background-tab`, `new-window`,
			 * `save-to-disk` and `other`.
			 */
			disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
			/**
5550
			 * The options which will be used for creating the new .
5551 5552 5553 5554 5555 5556
			 */
			options: any,
			/**
			 * The non-standard features (features not handled by Chromium or Electron) given
			 * to `window.open()`.
			 */
5557 5558 5559 5560 5561 5562
			additionalFeatures: string[],
			/**
			 * The referrer that will be passed to the new window. May or may not result in the
			 * `Referer` header being sent, depending on the referrer policy.
			 */
			referrer: Referrer) => void): this;
5563 5564 5565 5566 5567 5568 5569 5570 5571
		removeListener(event: 'new-window', listener: (event: Event,
			url: string,
			frameName: string,
			/**
			 * Can be `default`, `foreground-tab`, `background-tab`, `new-window`,
			 * `save-to-disk` and `other`.
			 */
			disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other'),
			/**
5572
			 * The options which will be used for creating the new .
5573 5574 5575 5576 5577 5578
			 */
			options: any,
			/**
			 * The non-standard features (features not handled by Chromium or Electron) given
			 * to `window.open()`.
			 */
5579 5580 5581 5582 5583 5584
			additionalFeatures: string[],
			/**
			 * The referrer that will be passed to the new window. May or may not result in the
			 * `Referer` header being sent, depending on the referrer policy.
			 */
			referrer: Referrer) => void): this;
5585 5586 5587 5588 5589
		/**
		 * Emitted when page receives favicon urls.
		 */
		on(event: 'page-favicon-updated', listener: (event: Event,
			/**
5590
			 * Array of URLs.
5591 5592 5593 5594
			 */
			favicons: string[]) => void): this;
		once(event: 'page-favicon-updated', listener: (event: Event,
			/**
5595
			 * Array of URLs.
5596 5597 5598 5599
			 */
			favicons: string[]) => void): this;
		addListener(event: 'page-favicon-updated', listener: (event: Event,
			/**
5600
			 * Array of URLs.
5601 5602 5603 5604
			 */
			favicons: string[]) => void): this;
		removeListener(event: 'page-favicon-updated', listener: (event: Event,
			/**
5605
			 * Array of URLs.
5606 5607 5608 5609 5610 5611 5612 5613 5614 5615 5616 5617 5618 5619 5620 5621 5622 5623 5624 5625 5626 5627 5628 5629 5630 5631 5632 5633 5634 5635 5636 5637
			 */
			favicons: string[]) => void): this;
		/**
		 * Emitted when a new frame is generated. Only the dirty area is passed in the
		 * buffer.
		 */
		on(event: 'paint', listener: (event: Event,
			dirtyRect: Rectangle,
			/**
			 * The image data of the whole frame.
			 */
			image: NativeImage) => void): this;
		once(event: 'paint', listener: (event: Event,
			dirtyRect: Rectangle,
			/**
			 * The image data of the whole frame.
			 */
			image: NativeImage) => void): this;
		addListener(event: 'paint', listener: (event: Event,
			dirtyRect: Rectangle,
			/**
			 * The image data of the whole frame.
			 */
			image: NativeImage) => void): this;
		removeListener(event: 'paint', listener: (event: Event,
			dirtyRect: Rectangle,
			/**
			 * The image data of the whole frame.
			 */
			image: NativeImage) => void): this;
		/**
		 * Emitted when a plugin process has crashed.
B
Benjamin Pasero 已提交
5638
		 */
5639 5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650
		on(event: 'plugin-crashed', listener: (event: Event,
			name: string,
			version: string) => void): this;
		once(event: 'plugin-crashed', listener: (event: Event,
			name: string,
			version: string) => void): this;
		addListener(event: 'plugin-crashed', listener: (event: Event,
			name: string,
			version: string) => void): this;
		removeListener(event: 'plugin-crashed', listener: (event: Event,
			name: string,
			version: string) => void): this;
5651 5652 5653 5654 5655 5656 5657
		/**
		 * Emitted when the unresponsive web page becomes responsive again.
		 */
		on(event: 'responsive', listener: Function): this;
		once(event: 'responsive', listener: Function): this;
		addListener(event: 'responsive', listener: Function): this;
		removeListener(event: 'responsive', listener: Function): this;
5658 5659 5660
		/**
		 * Emitted when bluetooth device needs to be selected on call to
		 * navigator.bluetooth.requestDevice. To use navigator.bluetooth api webBluetooth
5661 5662
		 * should be enabled. If event.preventDefault is not called, first available device
		 * will be selected. callback should be called with deviceId to be selected,
5663
		 * passing empty string to callback will cancel the request.
B
Benjamin Pasero 已提交
5664
		 */
5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 5677 5678 5679
		on(event: 'select-bluetooth-device', listener: (event: Event,
			devices: BluetoothDevice[],
			callback: (deviceId: string) => void) => void): this;
		once(event: 'select-bluetooth-device', listener: (event: Event,
			devices: BluetoothDevice[],
			callback: (deviceId: string) => void) => void): this;
		addListener(event: 'select-bluetooth-device', listener: (event: Event,
			devices: BluetoothDevice[],
			callback: (deviceId: string) => void) => void): this;
		removeListener(event: 'select-bluetooth-device', listener: (event: Event,
			devices: BluetoothDevice[],
			callback: (deviceId: string) => void) => void): this;
		/**
		 * Emitted when a client certificate is requested. The usage is the same with the
		 * select-client-certificate event of app.
B
Benjamin Pasero 已提交
5680
		 */
5681 5682 5683 5684 5685 5686 5687 5688 5689 5690 5691 5692 5693 5694 5695 5696
		on(event: 'select-client-certificate', listener: (event: Event,
			url: string,
			certificateList: Certificate[],
			callback: (certificate: Certificate) => void) => void): this;
		once(event: 'select-client-certificate', listener: (event: Event,
			url: string,
			certificateList: Certificate[],
			callback: (certificate: Certificate) => void) => void): this;
		addListener(event: 'select-client-certificate', listener: (event: Event,
			url: string,
			certificateList: Certificate[],
			callback: (certificate: Certificate) => void) => void): this;
		removeListener(event: 'select-client-certificate', listener: (event: Event,
			url: string,
			certificateList: Certificate[],
			callback: (certificate: Certificate) => void) => void): this;
5697 5698 5699 5700 5701 5702 5703
		/**
		 * Emitted when the web page becomes unresponsive.
		 */
		on(event: 'unresponsive', listener: Function): this;
		once(event: 'unresponsive', listener: Function): this;
		addListener(event: 'unresponsive', listener: Function): this;
		removeListener(event: 'unresponsive', listener: Function): this;
B
Benjamin Pasero 已提交
5704
		/**
5705
		 * Emitted when mouse moves over a link or the keyboard moves the focus to a link.
B
Benjamin Pasero 已提交
5706
		 */
5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 5737 5738 5739 5740 5741 5742 5743 5744 5745 5746 5747 5748 5749 5750 5751 5752 5753 5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795
		on(event: 'update-target-url', listener: (event: Event,
			url: string) => void): this;
		once(event: 'update-target-url', listener: (event: Event,
			url: string) => void): this;
		addListener(event: 'update-target-url', listener: (event: Event,
			url: string) => void): this;
		removeListener(event: 'update-target-url', listener: (event: Event,
			url: string) => void): this;
		/**
		 * Emitted when a <webview>'s web contents is being attached to this web contents.
		 * Calling event.preventDefault() will destroy the guest page. This event can be
		 * used to configure webPreferences for the webContents of a <webview> before it's
		 * loaded, and provides the ability to set settings that can't be set via <webview>
		 * attributes. Note: The specified preload script option will be appear as
		 * preloadURL (not preload) in the webPreferences object emitted with this event.
		 */
		on(event: 'will-attach-webview', listener: (event: Event,
			/**
			 * The web preferences that will be used by the guest page. This object can be
			 * modified to adjust the preferences for the guest page.
			 */
			webPreferences: any,
			/**
			 * The other `<webview>` parameters such as the `src` URL. This object can be
			 * modified to adjust the parameters of the guest page.
			 */
			params: any) => void): this;
		once(event: 'will-attach-webview', listener: (event: Event,
			/**
			 * The web preferences that will be used by the guest page. This object can be
			 * modified to adjust the preferences for the guest page.
			 */
			webPreferences: any,
			/**
			 * The other `<webview>` parameters such as the `src` URL. This object can be
			 * modified to adjust the parameters of the guest page.
			 */
			params: any) => void): this;
		addListener(event: 'will-attach-webview', listener: (event: Event,
			/**
			 * The web preferences that will be used by the guest page. This object can be
			 * modified to adjust the preferences for the guest page.
			 */
			webPreferences: any,
			/**
			 * The other `<webview>` parameters such as the `src` URL. This object can be
			 * modified to adjust the parameters of the guest page.
			 */
			params: any) => void): this;
		removeListener(event: 'will-attach-webview', listener: (event: Event,
			/**
			 * The web preferences that will be used by the guest page. This object can be
			 * modified to adjust the preferences for the guest page.
			 */
			webPreferences: any,
			/**
			 * The other `<webview>` parameters such as the `src` URL. This object can be
			 * modified to adjust the parameters of the guest page.
			 */
			params: any) => void): this;
		/**
		 * Emitted when a user or the page wants to start navigation. It can happen when
		 * the window.location object is changed or a user clicks a link in the page. This
		 * event will not emit when the navigation is started programmatically with APIs
		 * like webContents.loadURL and webContents.back. It is also not emitted for
		 * in-page navigations, such as clicking anchor links or updating the
		 * window.location.hash. Use did-navigate-in-page event for this purpose. Calling
		 * event.preventDefault() will prevent the navigation.
		 */
		on(event: 'will-navigate', listener: (event: Event,
			url: string) => void): this;
		once(event: 'will-navigate', listener: (event: Event,
			url: string) => void): this;
		addListener(event: 'will-navigate', listener: (event: Event,
			url: string) => void): this;
		removeListener(event: 'will-navigate', listener: (event: Event,
			url: string) => void): this;
		/**
		 * Emitted when a beforeunload event handler is attempting to cancel a page unload.
		 * Calling event.preventDefault() will ignore the beforeunload event handler and
		 * allow the page to be unloaded.
		 */
		on(event: 'will-prevent-unload', listener: (event: Event) => void): this;
		once(event: 'will-prevent-unload', listener: (event: Event) => void): this;
		addListener(event: 'will-prevent-unload', listener: (event: Event) => void): this;
		removeListener(event: 'will-prevent-unload', listener: (event: Event) => void): this;
		/**
		 * Adds the specified path to DevTools workspace. Must be used after DevTools
		 * creation:
B
Benjamin Pasero 已提交
5796
		 */
5797
		addWorkSpace(path: string): void;
B
Benjamin Pasero 已提交
5798
		/**
5799
		 * Begin subscribing for presentation events and captured frames, the callback will
5800 5801 5802 5803 5804 5805 5806
		 * be called with callback(image, dirtyRect) when there is a presentation event.
		 * The image is an instance of NativeImage that stores the captured frame. The
		 * dirtyRect is an object with x, y, width, height properties that describes which
		 * part of the page was repainted. If onlyDirty is set to true, image will only
		 * contain the repainted area. onlyDirty defaults to false.
		 */
		beginFrameSubscription(callback: (image: NativeImage, dirtyRect: Rectangle) => void): void;
5807 5808
		/**
		 * Begin subscribing for presentation events and captured frames, the callback will
5809 5810 5811 5812 5813 5814 5815
		 * be called with callback(image, dirtyRect) when there is a presentation event.
		 * The image is an instance of NativeImage that stores the captured frame. The
		 * dirtyRect is an object with x, y, width, height properties that describes which
		 * part of the page was repainted. If onlyDirty is set to true, image will only
		 * contain the repainted area. onlyDirty defaults to false.
		 */
		beginFrameSubscription(onlyDirty: boolean, callback: (image: NativeImage, dirtyRect: Rectangle) => void): void;
5816 5817 5818
		canGoBack(): boolean;
		canGoForward(): boolean;
		canGoToOffset(offset: number): boolean;
B
Benjamin Pasero 已提交
5819
		/**
5820 5821 5822
		 * Captures a snapshot of the page within rect. Upon completion callback will be
		 * called with callback(image). The image is an instance of NativeImage that stores
		 * data of the snapshot. Omitting rect will capture the whole visible page.
B
Benjamin Pasero 已提交
5823
		 */
5824
		capturePage(rect: Rectangle, callback: (image: NativeImage) => void): void;
B
Benjamin Pasero 已提交
5825
		/**
5826 5827 5828
		 * Captures a snapshot of the page within rect. Upon completion callback will be
		 * called with callback(image). The image is an instance of NativeImage that stores
		 * data of the snapshot. Omitting rect will capture the whole visible page.
B
Benjamin Pasero 已提交
5829
		 */
5830
		capturePage(callback: (image: NativeImage) => void): void;
B
Benjamin Pasero 已提交
5831
		/**
5832
		 * Clears the navigation history.
B
Benjamin Pasero 已提交
5833
		 */
5834
		clearHistory(): void;
B
Benjamin Pasero 已提交
5835
		/**
5836
		 * Closes the devtools.
B
Benjamin Pasero 已提交
5837
		 */
5838
		closeDevTools(): void;
B
Benjamin Pasero 已提交
5839
		/**
5840
		 * Executes the editing command copy in web page.
B
Benjamin Pasero 已提交
5841
		 */
5842
		copy(): void;
B
Benjamin Pasero 已提交
5843
		/**
5844
		 * Copy the image at the given position to the clipboard.
B
Benjamin Pasero 已提交
5845
		 */
5846
		copyImageAt(x: number, y: number): void;
B
Benjamin Pasero 已提交
5847
		/**
5848
		 * Executes the editing command cut in web page.
B
Benjamin Pasero 已提交
5849
		 */
5850
		cut(): void;
B
Benjamin Pasero 已提交
5851
		/**
5852
		 * Executes the editing command delete in web page.
B
Benjamin Pasero 已提交
5853
		 */
5854
		delete(): void;
B
Benjamin Pasero 已提交
5855
		/**
5856
		 * Disable device emulation enabled by webContents.enableDeviceEmulation.
B
Benjamin Pasero 已提交
5857
		 */
5858
		disableDeviceEmulation(): void;
B
Benjamin Pasero 已提交
5859
		/**
5860 5861
		 * Initiates a download of the resource at url without navigating. The
		 * will-download event of session will be triggered.
B
Benjamin Pasero 已提交
5862
		 */
5863
		downloadURL(url: string): void;
B
Benjamin Pasero 已提交
5864
		/**
5865
		 * Enable device emulation with the given parameters.
B
Benjamin Pasero 已提交
5866
		 */
5867
		enableDeviceEmulation(parameters: Parameters): void;
B
Benjamin Pasero 已提交
5868
		/**
5869
		 * End subscribing for frame presentation events.
B
Benjamin Pasero 已提交
5870
		 */
5871
		endFrameSubscription(): void;
B
Benjamin Pasero 已提交
5872
		/**
5873 5874 5875 5876
		 * Evaluates code in page. In the browser window some HTML APIs like
		 * requestFullScreen can only be invoked by a gesture from the user. Setting
		 * userGesture to true will remove this limitation. If the result of the executed
		 * code is a promise the callback result will be the resolved value of the promise.
5877
		 * We recommend that you use the returned Promise to handle code that results in a
5878
		 * Promise.
B
Benjamin Pasero 已提交
5879
		 */
5880
		executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): Promise<any>;
B
Benjamin Pasero 已提交
5881
		/**
5882 5883
		 * Starts a request to find all matches for the text in the web page. The result of
		 * the request can be obtained by subscribing to found-in-page event.
B
Benjamin Pasero 已提交
5884
		 */
5885
		findInPage(text: string, options?: FindInPageOptions): number;
5886
		/**
B
Benjamin Pasero 已提交
5887
		 * Focuses the web page.
5888
		 */
B
Benjamin Pasero 已提交
5889
		focus(): void;
5890 5891
		getFrameRate(): number;
		getOSProcessId(): number;
5892
		/**
5893
		 * Get the system printer list.
5894
		 */
5895
		getPrinters(): PrinterInfo[];
5896
		getProcessId(): number;
5897 5898 5899 5900
		getTitle(): string;
		getURL(): string;
		getUserAgent(): string;
		getWebRTCIPHandlingPolicy(): string;
5901
		/**
5902 5903
		 * Sends a request to get current zoom factor, the callback will be called with
		 * callback(zoomFactor).
5904
		 */
5905
		getZoomFactor(callback: (zoomFactor: number) => void): void;
J
Joao Moreno 已提交
5906
		/**
5907 5908
		 * Sends a request to get current zoom level, the callback will be called with
		 * callback(zoomLevel).
J
Joao Moreno 已提交
5909
		 */
5910
		getZoomLevel(callback: (zoomLevel: number) => void): void;
J
Joao Moreno 已提交
5911
		/**
5912
		 * Makes the browser go back a web page.
J
Joao Moreno 已提交
5913
		 */
5914
		goBack(): void;
J
Joao Moreno 已提交
5915
		/**
5916
		 * Makes the browser go forward a web page.
J
Joao Moreno 已提交
5917
		 */
5918
		goForward(): void;
J
Joao Moreno 已提交
5919
		/**
5920
		 * Navigates browser to the specified absolute web page index.
J
Joao Moreno 已提交
5921
		 */
5922
		goToIndex(index: number): void;
J
Joao Moreno 已提交
5923
		/**
5924
		 * Navigates to the specified offset from the "current entry".
J
Joao Moreno 已提交
5925
		 */
5926
		goToOffset(offset: number): void;
J
Joao Moreno 已提交
5927
		/**
5928 5929
		 * Checks if any ServiceWorker is registered and returns a boolean as response to
		 * callback.
J
Joao Moreno 已提交
5930
		 */
5931
		hasServiceWorker(callback: (hasWorker: boolean) => void): void;
J
Joao Moreno 已提交
5932
		/**
5933
		 * Injects CSS into the current web page.
J
Joao Moreno 已提交
5934
		 */
5935
		insertCSS(css: string): void;
J
Joao Moreno 已提交
5936
		/**
5937
		 * Inserts text to the focused element.
J
Joao Moreno 已提交
5938
		 */
5939
		insertText(text: string): void;
J
Joao Moreno 已提交
5940
		/**
5941
		 * Starts inspecting element at position (x, y).
J
Joao Moreno 已提交
5942
		 */
5943
		inspectElement(x: number, y: number): void;
J
Joao Moreno 已提交
5944
		/**
5945
		 * Opens the developer tools for the service worker context.
J
Joao Moreno 已提交
5946
		 */
5947
		inspectServiceWorker(): void;
J
Joao Moreno 已提交
5948
		/**
5949 5950 5951
		 * Schedules a full repaint of the window this web contents is in. If offscreen
		 * rendering is enabled invalidates the frame and generates a new one through the
		 * 'paint' event.
J
Joao Moreno 已提交
5952
		 */
5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964
		invalidate(): void;
		isAudioMuted(): boolean;
		isCrashed(): boolean;
		isDestroyed(): boolean;
		isDevToolsFocused(): boolean;
		isDevToolsOpened(): boolean;
		isFocused(): boolean;
		isLoading(): boolean;
		isLoadingMainFrame(): boolean;
		isOffscreen(): boolean;
		isPainting(): boolean;
		isWaitingForResponse(): boolean;
5965 5966 5967 5968 5969 5970
		/**
		 * Loads the given file in the window, filePath should be a path to an HTML file
		 * relative to the root of your application.  For instance an app structure like
		 * this: Would require code like this
		 */
		loadFile(filePath: string): void;
J
Joao Moreno 已提交
5971
		/**
5972 5973 5974
		 * Loads the url in the window. The url must contain the protocol prefix, e.g. the
		 * http:// or file://. If the load should bypass http cache then use the pragma
		 * header to achieve it.
J
Joao Moreno 已提交
5975
		 */
5976
		loadURL(url: string, options?: LoadURLOptions): void;
J
Joao Moreno 已提交
5977
		/**
5978 5979 5980
		 * Opens the devtools. When contents is a <webview> tag, the mode would be detach
		 * by default, explicitly passing an empty mode can force using last used dock
		 * state.
J
Joao Moreno 已提交
5981
		 */
5982
		openDevTools(options?: OpenDevToolsOptions): void;
J
Joao Moreno 已提交
5983
		/**
5984
		 * Executes the editing command paste in web page.
J
Joao Moreno 已提交
5985
		 */
5986
		paste(): void;
J
Joao Moreno 已提交
5987
		/**
5988
		 * Executes the editing command pasteAndMatchStyle in web page.
J
Joao Moreno 已提交
5989
		 */
5990
		pasteAndMatchStyle(): void;
J
Joao Moreno 已提交
5991
		/**
5992 5993 5994 5995 5996
		 * Prints window's web page. When silent is set to true, Electron will pick the
		 * system's default printer if deviceName is empty and the default settings for
		 * printing. Calling window.print() in web page is equivalent to calling
		 * webContents.print({silent: false, printBackground: false, deviceName: ''}). Use
		 * page-break-before: always; CSS style to force to print to a new page.
J
Joao Moreno 已提交
5997
		 */
5998
		print(options?: PrintOptions, callback?: (success: boolean) => void): void;
J
Joao Moreno 已提交
5999
		/**
6000 6001 6002 6003 6004 6005
		 * Prints window's web page as PDF with Chromium's preview printing custom
		 * settings. The callback will be called with callback(error, data) on completion.
		 * The data is a Buffer that contains the generated PDF data. The landscape will be
		 * ignored if @page CSS at-rule is used in the web page. By default, an empty
		 * options will be regarded as: Use page-break-before: always; CSS style to force
		 * to print to a new page. An example of webContents.printToPDF:
J
Joao Moreno 已提交
6006
		 */
6007
		printToPDF(options: PrintToPDFOptions, callback: (error: Error, data: Buffer) => void): void;
J
Joao Moreno 已提交
6008
		/**
6009
		 * Executes the editing command redo in web page.
J
Joao Moreno 已提交
6010
		 */
6011
		redo(): void;
J
Joao Moreno 已提交
6012
		/**
6013
		 * Reloads the current web page.
J
Joao Moreno 已提交
6014
		 */
6015
		reload(): void;
J
Joao Moreno 已提交
6016
		/**
6017
		 * Reloads current page and ignores cache.
J
Joao Moreno 已提交
6018
		 */
6019
		reloadIgnoringCache(): void;
J
Joao Moreno 已提交
6020
		/**
6021
		 * Removes the specified path from DevTools workspace.
J
Joao Moreno 已提交
6022
		 */
6023
		removeWorkSpace(path: string): void;
J
Joao Moreno 已提交
6024
		/**
6025
		 * Executes the editing command replace in web page.
J
Joao Moreno 已提交
6026
		 */
6027
		replace(text: string): void;
J
Joao Moreno 已提交
6028
		/**
6029
		 * Executes the editing command replaceMisspelling in web page.
J
Joao Moreno 已提交
6030
		 */
6031 6032
		replaceMisspelling(text: string): void;
		savePage(fullPath: string, saveType: 'HTMLOnly' | 'HTMLComplete' | 'MHTML', callback: (error: Error) => void): boolean;
J
Joao Moreno 已提交
6033
		/**
6034
		 * Executes the editing command selectAll in web page.
J
Joao Moreno 已提交
6035
		 */
6036
		selectAll(): void;
J
Joao Moreno 已提交
6037
		/**
6038 6039 6040 6041 6042
		 * Send an asynchronous message to renderer process via channel, you can also send
		 * arbitrary arguments. Arguments will be serialized in JSON internally and hence
		 * no functions or prototype chain will be included. The renderer process can
		 * handle the message by listening to channel with the ipcRenderer module. An
		 * example of sending messages from the main process to the renderer process:
J
Joao Moreno 已提交
6043
		 */
6044
		send(channel: string, ...args: any[]): void;
J
Joao Moreno 已提交
6045
		/**
6046 6047 6048 6049 6050
		 * Sends an input event to the page. Note: The BrowserWindow containing the
		 * contents needs to be focused for sendInputEvent() to work. For keyboard events,
		 * the event object also have following properties: For mouse events, the event
		 * object also have following properties: For the mouseWheel event, the event
		 * object also have following properties:
J
Joao Moreno 已提交
6051
		 */
6052
		sendInputEvent(event: Event): void;
J
Joao Moreno 已提交
6053
		/**
6054
		 * Mute the audio on the current web page.
J
Joao Moreno 已提交
6055
		 */
6056
		setAudioMuted(muted: boolean): void;
6057 6058 6059 6060 6061 6062 6063 6064 6065 6066 6067 6068 6069
		/**
		 * Uses the devToolsWebContents as the target WebContents to show devtools. The
		 * devToolsWebContents must not have done any navigation, and it should not be used
		 * for other purposes after the call. By default Electron manages the devtools by
		 * creating an internal WebContents with native view, which developers have very
		 * limited control of. With the setDevToolsWebContents method, developers can use
		 * any WebContents to show the devtools in it, including BrowserWindow, BrowserView
		 * and <webview> tag. Note that closing the devtools does not destroy the
		 * devToolsWebContents, it is caller's responsibility to destroy
		 * devToolsWebContents. An example of showing devtools in a <webview> tag: An
		 * example of showing devtools in a BrowserWindow:
		 */
		setDevToolsWebContents(devToolsWebContents: WebContents): void;
J
Joao Moreno 已提交
6070
		/**
6071 6072
		 * If offscreen rendering is enabled sets the frame rate to the specified number.
		 * Only values between 1 and 60 are accepted.
J
Joao Moreno 已提交
6073
		 */
6074
		setFrameRate(fps: number): void;
J
Joao Moreno 已提交
6075
		/**
B
Benjamin Pasero 已提交
6076
		 * Ignore application menu shortcuts while this web contents is focused.
J
Joao Moreno 已提交
6077
		 */
B
Benjamin Pasero 已提交
6078
		setIgnoreMenuShortcuts(ignore: boolean): void;
J
Joao Moreno 已提交
6079
		/**
6080
		 * Sets the maximum and minimum layout-based (i.e. non-visual) zoom level.
J
Joao Moreno 已提交
6081
		 */
6082
		setLayoutZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
J
Joao Moreno 已提交
6083
		/**
6084
		 * Overrides the user agent for this web page.
J
Joao Moreno 已提交
6085
		 */
6086
		setUserAgent(userAgent: string): void;
B
Benjamin Pasero 已提交
6087
		/**
6088
		 * Sets the maximum and minimum pinch-to-zoom level.
B
Benjamin Pasero 已提交
6089
		 */
6090
		setVisualZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
B
Benjamin Pasero 已提交
6091
		/**
6092
		 * Setting the WebRTC IP handling policy allows you to control which IPs are
6093
		 * exposed via WebRTC. See BrowserLeaks for more details.
B
Benjamin Pasero 已提交
6094
		 */
6095
		setWebRTCIPHandlingPolicy(policy: 'default' | 'default_public_interface_only' | 'default_public_and_private_interfaces' | 'disable_non_proxied_udp'): void;
B
Benjamin Pasero 已提交
6096
		/**
6097 6098
		 * Changes the zoom factor to the specified factor. Zoom factor is zoom percent
		 * divided by 100, so 300% = 3.0.
B
Benjamin Pasero 已提交
6099
		 */
6100
		setZoomFactor(factor: number): void;
B
Benjamin Pasero 已提交
6101
		/**
6102 6103
		 * Changes the zoom level to the specified level. The original size is 0 and each
		 * increment above or below represents zooming 20% larger or smaller to default
6104 6105
		 * limits of 300% and 50% of original size, respectively. The formula for this is
		 * scale := 1.2 ^ level.
B
Benjamin Pasero 已提交
6106
		 */
6107
		setZoomLevel(level: number): void;
B
Benjamin Pasero 已提交
6108
		/**
6109
		 * Shows pop-up dictionary that searches the selected word on the page.
B
Benjamin Pasero 已提交
6110
		 */
6111
		showDefinitionForSelection(): void;
B
Benjamin Pasero 已提交
6112
		/**
6113 6114 6115
		 * Sets the item as dragging item for current drag-drop operation, file is the
		 * absolute path of the file to be dragged, and icon is the image showing under the
		 * cursor when dragging.
B
Benjamin Pasero 已提交
6116
		 */
6117
		startDrag(item: Item): void;
B
Benjamin Pasero 已提交
6118
		/**
6119
		 * If offscreen rendering is enabled and not painting, start painting.
B
Benjamin Pasero 已提交
6120
		 */
6121
		startPainting(): void;
B
Benjamin Pasero 已提交
6122
		/**
6123
		 * Stops any pending navigation.
B
Benjamin Pasero 已提交
6124
		 */
6125
		stop(): void;
B
Benjamin Pasero 已提交
6126
		/**
6127
		 * Stops any findInPage request for the webContents with the provided action.
B
Benjamin Pasero 已提交
6128
		 */
6129
		stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): void;
B
Benjamin Pasero 已提交
6130
		/**
6131
		 * If offscreen rendering is enabled and painting, stop painting.
B
Benjamin Pasero 已提交
6132
		 */
6133
		stopPainting(): void;
B
Benjamin Pasero 已提交
6134
		/**
6135
		 * Toggles the developer tools.
B
Benjamin Pasero 已提交
6136
		 */
6137
		toggleDevTools(): void;
B
Benjamin Pasero 已提交
6138
		/**
6139
		 * Executes the editing command undo in web page.
B
Benjamin Pasero 已提交
6140
		 */
6141
		undo(): void;
B
Benjamin Pasero 已提交
6142
		/**
6143 6144 6145
		 * Unregisters any ServiceWorker if present and returns a boolean as response to
		 * callback when the JS promise is fulfilled or false when the JS promise is
		 * rejected.
B
Benjamin Pasero 已提交
6146
		 */
6147
		unregisterServiceWorker(callback: (success: boolean) => void): void;
B
Benjamin Pasero 已提交
6148
		/**
6149
		 * Executes the editing command unselect in web page.
B
Benjamin Pasero 已提交
6150
		 */
6151 6152 6153 6154 6155 6156
		unselect(): void;
		debugger: Debugger;
		devToolsWebContents: WebContents;
		hostWebContents: WebContents;
		id: number;
		session: Session;
B
Benjamin Pasero 已提交
6157 6158
	}

6159 6160 6161
	interface WebFrame extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/web-frame
B
Benjamin Pasero 已提交
6162 6163

		/**
6164 6165 6166 6167 6168 6169
		 * Attempts to free memory that is no longer being used (like images from a
		 * previous navigation). Note that blindly calling this method probably makes
		 * Electron slower since it will have to refill these emptied caches, you should
		 * only call it if an event in your app has occurred that makes you think your page
		 * is actually using less memory (i.e. you have navigated from a super heavy page
		 * to a mostly empty one, and intend to stay there).
B
Benjamin Pasero 已提交
6170
		 */
6171
		clearCache(): void;
B
Benjamin Pasero 已提交
6172
		/**
6173 6174 6175
		 * Evaluates code in page. In the browser window some HTML APIs like
		 * requestFullScreen can only be invoked by a gesture from the user. Setting
		 * userGesture to true will remove this limitation.
B
Benjamin Pasero 已提交
6176
		 */
6177
		executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): Promise<any>;
6178 6179 6180 6181
		/**
		 * Work like executeJavaScript but evaluates scripts in isolated context.
		 */
		executeJavaScriptInIsolatedWorld(worldId: number, scripts: WebSource[], userGesture?: boolean, callback?: (result: any) => void): void;
6182 6183 6184
		findFrameByName(name: string): WebFrame;
		findFrameByRoutingId(routingId: number): WebFrame;
		getFrameForSelector(selector: string): WebFrame;
B
Benjamin Pasero 已提交
6185
		/**
6186 6187
		 * Returns an object describing usage information of Blink's internal memory
		 * caches. This will generate:
B
Benjamin Pasero 已提交
6188
		 */
6189 6190 6191
		getResourceUsage(): ResourceUsage;
		getZoomFactor(): number;
		getZoomLevel(): number;
B
Benjamin Pasero 已提交
6192
		/**
6193
		 * Inserts text to the focused element.
B
Benjamin Pasero 已提交
6194
		 */
6195
		insertText(text: string): void;
B
Benjamin Pasero 已提交
6196
		/**
6197 6198
		 * Resources will be loaded from this scheme regardless of the current page's
		 * Content Security Policy.
B
Benjamin Pasero 已提交
6199
		 */
6200
		registerURLSchemeAsBypassingCSP(scheme: string): void;
B
Benjamin Pasero 已提交
6201
		/**
6202 6203 6204 6205
		 * Registers the scheme as secure, bypasses content security policy for resources,
		 * allows registering ServiceWorker and supports fetch API. Specify an option with
		 * the value of false to omit it from the registration. An example of registering a
		 * privileged scheme, without bypassing Content Security Policy:
B
Benjamin Pasero 已提交
6206
		 */
6207
		registerURLSchemeAsPrivileged(scheme: string, options?: RegisterURLSchemeAsPrivilegedOptions): void;
6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219
		/**
		 * Set the content security policy of the isolated world.
		 */
		setIsolatedWorldContentSecurityPolicy(worldId: number, csp: string): void;
		/**
		 * Set the name of the isolated world. Useful in devtools.
		 */
		setIsolatedWorldHumanReadableName(worldId: number, name: string): void;
		/**
		 * Set the security origin of the isolated world.
		 */
		setIsolatedWorldSecurityOrigin(worldId: number, securityOrigin: string): void;
B
Benjamin Pasero 已提交
6220
		/**
6221
		 * Sets the maximum and minimum layout-based (i.e. non-visual) zoom level.
B
Benjamin Pasero 已提交
6222
		 */
6223
		setLayoutZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
B
Benjamin Pasero 已提交
6224
		/**
6225 6226 6227
		 * Sets a provider for spell checking in input fields and text areas. The provider
		 * must be an object that has a spellCheck method that returns whether the word
		 * passed is correctly spelled. An example of using node-spellchecker as provider:
B
Benjamin Pasero 已提交
6228
		 */
6229
		setSpellCheckProvider(language: string, autoCorrectWord: boolean, provider: Provider): void;
B
Benjamin Pasero 已提交
6230
		/**
6231
		 * Sets the maximum and minimum pinch-to-zoom level.
B
Benjamin Pasero 已提交
6232
		 */
6233
		setVisualZoomLevelLimits(minimumLevel: number, maximumLevel: number): void;
B
Benjamin Pasero 已提交
6234
		/**
6235 6236
		 * Changes the zoom factor to the specified factor. Zoom factor is zoom percent
		 * divided by 100, so 300% = 3.0.
B
Benjamin Pasero 已提交
6237
		 */
6238
		setZoomFactor(factor: number): void;
B
Benjamin Pasero 已提交
6239
		/**
6240 6241 6242
		 * Changes the zoom level to the specified level. The original size is 0 and each
		 * increment above or below represents zooming 20% larger or smaller to default
		 * limits of 300% and 50% of original size, respectively.
B
Benjamin Pasero 已提交
6243
		 */
6244
		setZoomLevel(level: number): void;
6245 6246 6247 6248 6249 6250 6251 6252 6253 6254 6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277
		/**
		 * A WebFrame representing the first child frame of webFrame, the property would be
		 * null if webFrame has no children or if first child is not in the current
		 * renderer process.
		 */
		firstChild?: WebFrame;
		/**
		 * A WebFrame representing next sibling frame, the property would be null if
		 * webFrame is the last frame in its parent or if the next sibling is not in the
		 * current renderer process.
		 */
		nextSibling?: WebFrame;
		/**
		 * A WebFrame representing the frame which opened webFrame, the property would be
		 * null if there's no opener or opener is not in the current renderer process.
		 */
		opener?: WebFrame;
		/**
		 * A WebFrame representing parent frame of webFrame, the property would be null if
		 * webFrame is top or parent is not in the current renderer process.
		 */
		parent?: WebFrame;
		/**
		 * An Integer representing the unique frame id in the current renderer process.
		 * Distinct WebFrame instances that refer to the same underlying frame will have
		 * the same routingId.
		 */
		routingId?: number;
		/**
		 * A WebFrame representing top frame in frame hierarchy to which webFrame belongs,
		 * the property would be null if top frame is not in the current renderer process.
		 */
		top?: WebFrame;
B
Benjamin Pasero 已提交
6278 6279
	}

6280 6281 6282
	class WebRequest extends EventEmitter {

		// Docs: http://electron.atom.io/docs/api/web-request
B
Benjamin Pasero 已提交
6283

6284 6285 6286 6287 6288
		/**
		 * The listener will be called with listener(details) when a server initiated
		 * redirect is about to occur.
		 */
		onBeforeRedirect(listener: (details: OnBeforeRedirectDetails) => void): void;
B
Benjamin Pasero 已提交
6289
		/**
6290 6291
		 * The listener will be called with listener(details) when a server initiated
		 * redirect is about to occur.
B
Benjamin Pasero 已提交
6292
		 */
6293
		onBeforeRedirect(filter: OnBeforeRedirectFilter, listener: (details: OnBeforeRedirectDetails) => void): void;
6294 6295 6296 6297 6298 6299
		/**
		 * The listener will be called with listener(details, callback) when a request is
		 * about to occur. The uploadData is an array of UploadData objects. The callback
		 * has to be called with an response object.
		 */
		onBeforeRequest(listener: (details: OnBeforeRequestDetails, callback: (response: Response) => void) => void): void;
B
Benjamin Pasero 已提交
6300
		/**
6301 6302 6303
		 * The listener will be called with listener(details, callback) when a request is
		 * about to occur. The uploadData is an array of UploadData objects. The callback
		 * has to be called with an response object.
B
Benjamin Pasero 已提交
6304
		 */
6305
		onBeforeRequest(filter: OnBeforeRequestFilter, listener: (details: OnBeforeRequestDetails, callback: (response: Response) => void) => void): void;
B
Benjamin Pasero 已提交
6306
		/**
6307 6308 6309 6310
		 * The listener will be called with listener(details, callback) before sending an
		 * HTTP request, once the request headers are available. This may occur after a TCP
		 * connection is made to the server, but before any http data is sent. The callback
		 * has to be called with an response object.
B
Benjamin Pasero 已提交
6311
		 */
B
Benjamin Pasero 已提交
6312
		onBeforeSendHeaders(filter: OnBeforeSendHeadersFilter, listener: (details: OnBeforeSendHeadersDetails, callback: (response: OnBeforeSendHeadersResponse) => void) => void): void;
6313 6314 6315 6316 6317 6318
		/**
		 * The listener will be called with listener(details, callback) before sending an
		 * HTTP request, once the request headers are available. This may occur after a TCP
		 * connection is made to the server, but before any http data is sent. The callback
		 * has to be called with an response object.
		 */
B
Benjamin Pasero 已提交
6319
		onBeforeSendHeaders(listener: (details: OnBeforeSendHeadersDetails, callback: (response: OnBeforeSendHeadersResponse) => void) => void): void;
B
Benjamin Pasero 已提交
6320
		/**
6321
		 * The listener will be called with listener(details) when a request is completed.
B
Benjamin Pasero 已提交
6322
		 */
6323
		onCompleted(filter: OnCompletedFilter, listener: (details: OnCompletedDetails) => void): void;
6324 6325 6326 6327 6328 6329 6330 6331
		/**
		 * The listener will be called with listener(details) when a request is completed.
		 */
		onCompleted(listener: (details: OnCompletedDetails) => void): void;
		/**
		 * The listener will be called with listener(details) when an error occurs.
		 */
		onErrorOccurred(listener: (details: OnErrorOccurredDetails) => void): void;
B
Benjamin Pasero 已提交
6332
		/**
6333
		 * The listener will be called with listener(details) when an error occurs.
B
Benjamin Pasero 已提交
6334
		 */
6335
		onErrorOccurred(filter: OnErrorOccurredFilter, listener: (details: OnErrorOccurredDetails) => void): void;
B
Benjamin Pasero 已提交
6336
		/**
6337 6338 6339
		 * The listener will be called with listener(details, callback) when HTTP response
		 * headers of a request have been received. The callback has to be called with an
		 * response object.
B
Benjamin Pasero 已提交
6340
		 */
B
Benjamin Pasero 已提交
6341
		onHeadersReceived(filter: OnHeadersReceivedFilter, listener: (details: OnHeadersReceivedDetails, callback: (response: OnHeadersReceivedResponse) => void) => void): void;
6342 6343 6344 6345 6346
		/**
		 * The listener will be called with listener(details, callback) when HTTP response
		 * headers of a request have been received. The callback has to be called with an
		 * response object.
		 */
B
Benjamin Pasero 已提交
6347
		onHeadersReceived(listener: (details: OnHeadersReceivedDetails, callback: (response: OnHeadersReceivedResponse) => void) => void): void;
6348 6349 6350 6351 6352 6353
		/**
		 * The listener will be called with listener(details) when first byte of the
		 * response body is received. For HTTP requests, this means that the status line
		 * and response headers are available.
		 */
		onResponseStarted(listener: (details: OnResponseStartedDetails) => void): void;
B
Benjamin Pasero 已提交
6354
		/**
6355 6356 6357
		 * The listener will be called with listener(details) when first byte of the
		 * response body is received. For HTTP requests, this means that the status line
		 * and response headers are available.
B
Benjamin Pasero 已提交
6358
		 */
6359
		onResponseStarted(filter: OnResponseStartedFilter, listener: (details: OnResponseStartedDetails) => void): void;
B
Benjamin Pasero 已提交
6360
		/**
6361 6362 6363
		 * The listener will be called with listener(details) just before a request is
		 * going to be sent to the server, modifications of previous onBeforeSendHeaders
		 * response are visible by the time this listener is fired.
B
Benjamin Pasero 已提交
6364
		 */
6365
		onSendHeaders(filter: OnSendHeadersFilter, listener: (details: OnSendHeadersDetails) => void): void;
6366 6367 6368 6369 6370 6371 6372 6373 6374 6375 6376 6377 6378 6379 6380 6381 6382 6383
		/**
		 * The listener will be called with listener(details) just before a request is
		 * going to be sent to the server, modifications of previous onBeforeSendHeaders
		 * response are visible by the time this listener is fired.
		 */
		onSendHeaders(listener: (details: OnSendHeadersDetails) => void): void;
	}

	interface WebSource {

		// Docs: http://electron.atom.io/docs/api/structures/web-source

		code: string;
		/**
		 * Default is 1.
		 */
		startLine?: number;
		url?: string;
B
Benjamin Pasero 已提交
6384 6385
	}

6386 6387 6388
	interface WebviewTag extends HTMLElement {

		// Docs: http://electron.atom.io/docs/api/webview-tag
B
Benjamin Pasero 已提交
6389 6390

		/**
6391 6392 6393
		 * Fired when a load has committed. This includes navigation within the current
		 * document as well as subframe document-level loads, but does not include
		 * asynchronous resource loads.
B
Benjamin Pasero 已提交
6394
		 */
6395 6396
		addEventListener(event: 'load-commit', listener: (event: LoadCommitEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'load-commit', listener: (event: LoadCommitEvent) => void): this;
B
Benjamin Pasero 已提交
6397
		/**
6398 6399
		 * Fired when the navigation is done, i.e. the spinner of the tab will stop
		 * spinning, and the onload event is dispatched.
B
Benjamin Pasero 已提交
6400
		 */
6401 6402
		addEventListener(event: 'did-finish-load', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'did-finish-load', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6403
		/**
6404 6405
		 * This event is like did-finish-load, but fired when the load failed or was
		 * cancelled, e.g. window.stop() is invoked.
B
Benjamin Pasero 已提交
6406
		 */
6407 6408
		addEventListener(event: 'did-fail-load', listener: (event: DidFailLoadEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'did-fail-load', listener: (event: DidFailLoadEvent) => void): this;
B
Benjamin Pasero 已提交
6409
		/**
6410
		 * Fired when a frame has done navigation.
B
Benjamin Pasero 已提交
6411
		 */
6412 6413
		addEventListener(event: 'did-frame-finish-load', listener: (event: DidFrameFinishLoadEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'did-frame-finish-load', listener: (event: DidFrameFinishLoadEvent) => void): this;
B
Benjamin Pasero 已提交
6414
		/**
6415
		 * Corresponds to the points in time when the spinner of the tab starts spinning.
B
Benjamin Pasero 已提交
6416
		 */
6417 6418
		addEventListener(event: 'did-start-loading', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'did-start-loading', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6419
		/**
6420
		 * Corresponds to the points in time when the spinner of the tab stops spinning.
B
Benjamin Pasero 已提交
6421
		 */
6422 6423
		addEventListener(event: 'did-stop-loading', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'did-stop-loading', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6424
		/**
6425
		 * Fired when document in the given frame is loaded.
B
Benjamin Pasero 已提交
6426
		 */
6427 6428
		addEventListener(event: 'dom-ready', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'dom-ready', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6429
		/**
6430 6431
		 * Fired when page title is set during navigation. explicitSet is false when title
		 * is synthesized from file url.
B
Benjamin Pasero 已提交
6432
		 */
6433 6434
		addEventListener(event: 'page-title-updated', listener: (event: PageTitleUpdatedEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'page-title-updated', listener: (event: PageTitleUpdatedEvent) => void): this;
B
Benjamin Pasero 已提交
6435
		/**
6436
		 * Fired when page receives favicon urls.
B
Benjamin Pasero 已提交
6437
		 */
6438 6439
		addEventListener(event: 'page-favicon-updated', listener: (event: PageFaviconUpdatedEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'page-favicon-updated', listener: (event: PageFaviconUpdatedEvent) => void): this;
B
Benjamin Pasero 已提交
6440
		/**
6441
		 * Fired when page enters fullscreen triggered by HTML API.
B
Benjamin Pasero 已提交
6442
		 */
6443 6444
		addEventListener(event: 'enter-html-full-screen', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'enter-html-full-screen', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6445
		/**
6446
		 * Fired when page leaves fullscreen triggered by HTML API.
B
Benjamin Pasero 已提交
6447
		 */
6448 6449
		addEventListener(event: 'leave-html-full-screen', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'leave-html-full-screen', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6450
		/**
6451 6452 6453
		 * Fired when the guest window logs a console message. The following example code
		 * forwards all log messages to the embedder's console without regard for log level
		 * or other properties.
B
Benjamin Pasero 已提交
6454
		 */
6455 6456
		addEventListener(event: 'console-message', listener: (event: ConsoleMessageEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'console-message', listener: (event: ConsoleMessageEvent) => void): this;
B
Benjamin Pasero 已提交
6457
		/**
6458
		 * Fired when a result is available for webview.findInPage request.
B
Benjamin Pasero 已提交
6459
		 */
6460 6461
		addEventListener(event: 'found-in-page', listener: (event: FoundInPageEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'found-in-page', listener: (event: FoundInPageEvent) => void): this;
B
Benjamin Pasero 已提交
6462
		/**
6463 6464
		 * Fired when the guest page attempts to open a new browser window. The following
		 * example code opens the new url in system's default browser.
B
Benjamin Pasero 已提交
6465
		 */
6466 6467
		addEventListener(event: 'new-window', listener: (event: NewWindowEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'new-window', listener: (event: NewWindowEvent) => void): this;
B
Benjamin Pasero 已提交
6468
		/**
6469 6470 6471 6472 6473 6474 6475
		 * Emitted when a user or the page wants to start navigation. It can happen when
		 * the window.location object is changed or a user clicks a link in the page. This
		 * event will not emit when the navigation is started programmatically with APIs
		 * like <webview>.loadURL and <webview>.back. It is also not emitted during in-page
		 * navigation, such as clicking anchor links or updating the window.location.hash.
		 * Use did-navigate-in-page event for this purpose. Calling event.preventDefault()
		 * does NOT have any effect.
B
Benjamin Pasero 已提交
6476
		 */
6477 6478
		addEventListener(event: 'will-navigate', listener: (event: WillNavigateEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'will-navigate', listener: (event: WillNavigateEvent) => void): this;
B
Benjamin Pasero 已提交
6479
		/**
6480 6481 6482
		 * Emitted when a navigation is done. This event is not emitted for in-page
		 * navigations, such as clicking anchor links or updating the window.location.hash.
		 * Use did-navigate-in-page event for this purpose.
B
Benjamin Pasero 已提交
6483
		 */
6484 6485
		addEventListener(event: 'did-navigate', listener: (event: DidNavigateEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'did-navigate', listener: (event: DidNavigateEvent) => void): this;
B
Benjamin Pasero 已提交
6486
		/**
6487 6488 6489 6490
		 * Emitted when an in-page navigation happened. When in-page navigation happens,
		 * the page URL changes but does not cause navigation outside of the page. Examples
		 * of this occurring are when anchor links are clicked or when the DOM hashchange
		 * event is triggered.
B
Benjamin Pasero 已提交
6491
		 */
6492 6493
		addEventListener(event: 'did-navigate-in-page', listener: (event: DidNavigateInPageEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'did-navigate-in-page', listener: (event: DidNavigateInPageEvent) => void): this;
B
Benjamin Pasero 已提交
6494
		/**
6495 6496
		 * Fired when the guest page attempts to close itself. The following example code
		 * navigates the webview to about:blank when the guest attempts to close itself.
B
Benjamin Pasero 已提交
6497
		 */
6498 6499
		addEventListener(event: 'close', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'close', listener: (event: Event) => void): this;
6500
		/**
6501
		 * Fired when the guest page has sent an asynchronous message to embedder page.
6502 6503
		 * With sendToHost method and ipc-message event you can communicate between guest
		 * page and embedder page:
6504
		 */
6505 6506
		addEventListener(event: 'ipc-message', listener: (event: IpcMessageEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'ipc-message', listener: (event: IpcMessageEvent) => void): this;
B
Benjamin Pasero 已提交
6507
		/**
6508
		 * Fired when the renderer process is crashed.
B
Benjamin Pasero 已提交
6509
		 */
6510 6511
		addEventListener(event: 'crashed', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'crashed', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6512
		/**
6513
		 * Fired when the gpu process is crashed.
B
Benjamin Pasero 已提交
6514
		 */
6515 6516
		addEventListener(event: 'gpu-crashed', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'gpu-crashed', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6517
		/**
6518
		 * Fired when a plugin process is crashed.
B
Benjamin Pasero 已提交
6519
		 */
6520 6521
		addEventListener(event: 'plugin-crashed', listener: (event: PluginCrashedEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'plugin-crashed', listener: (event: PluginCrashedEvent) => void): this;
B
Benjamin Pasero 已提交
6522
		/**
6523
		 * Fired when the WebContents is destroyed.
B
Benjamin Pasero 已提交
6524
		 */
6525 6526
		addEventListener(event: 'destroyed', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'destroyed', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6527
		/**
6528
		 * Emitted when media starts playing.
B
Benjamin Pasero 已提交
6529
		 */
6530 6531
		addEventListener(event: 'media-started-playing', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'media-started-playing', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6532
		/**
6533
		 * Emitted when media is paused or done playing.
B
Benjamin Pasero 已提交
6534
		 */
6535 6536
		addEventListener(event: 'media-paused', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'media-paused', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6537
		/**
6538 6539
		 * Emitted when a page's theme color changes. This is usually due to encountering a
		 * meta tag:
B
Benjamin Pasero 已提交
6540
		 */
6541 6542
		addEventListener(event: 'did-change-theme-color', listener: (event: DidChangeThemeColorEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'did-change-theme-color', listener: (event: DidChangeThemeColorEvent) => void): this;
B
Benjamin Pasero 已提交
6543
		/**
6544
		 * Emitted when mouse moves over a link or the keyboard moves the focus to a link.
B
Benjamin Pasero 已提交
6545
		 */
6546 6547
		addEventListener(event: 'update-target-url', listener: (event: UpdateTargetUrlEvent) => void, useCapture?: boolean): this;
		removeEventListener(event: 'update-target-url', listener: (event: UpdateTargetUrlEvent) => void): this;
B
Benjamin Pasero 已提交
6548
		/**
6549
		 * Emitted when DevTools is opened.
B
Benjamin Pasero 已提交
6550
		 */
6551 6552
		addEventListener(event: 'devtools-opened', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'devtools-opened', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6553
		/**
6554
		 * Emitted when DevTools is closed.
B
Benjamin Pasero 已提交
6555
		 */
6556 6557
		addEventListener(event: 'devtools-closed', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'devtools-closed', listener: (event: Event) => void): this;
B
Benjamin Pasero 已提交
6558
		/**
6559
		 * Emitted when DevTools is focused / opened.
B
Benjamin Pasero 已提交
6560
		 */
6561 6562
		addEventListener(event: 'devtools-focused', listener: (event: Event) => void, useCapture?: boolean): this;
		removeEventListener(event: 'devtools-focused', listener: (event: Event) => void): this;
6563 6564 6565 6566
		addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, useCapture?: boolean): void;
		addEventListener(type: string, listener: EventListenerOrEventListenerObject, useCapture?: boolean): void;
		removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, useCapture?: boolean): void;
		removeEventListener(type: string, listener: EventListenerOrEventListenerObject, useCapture?: boolean): void;
6567 6568 6569
		canGoBack(): boolean;
		canGoForward(): boolean;
		canGoToOffset(offset: number): boolean;
B
Benjamin Pasero 已提交
6570
		/**
6571 6572
		 * Captures a snapshot of the webview's page. Same as
		 * webContents.capturePage([rect, ]callback).
B
Benjamin Pasero 已提交
6573
		 */
6574
		capturePage(callback: (image: NativeImage) => void): void;
B
Benjamin Pasero 已提交
6575
		/**
6576 6577
		 * Captures a snapshot of the webview's page. Same as
		 * webContents.capturePage([rect, ]callback).
B
Benjamin Pasero 已提交
6578
		 */
6579
		capturePage(rect: Rectangle, callback: (image: NativeImage) => void): void;
B
Benjamin Pasero 已提交
6580
		/**
6581
		 * Clears the navigation history.
B
Benjamin Pasero 已提交
6582
		 */
6583
		clearHistory(): void;
B
Benjamin Pasero 已提交
6584
		/**
6585
		 * Closes the DevTools window of guest page.
B
Benjamin Pasero 已提交
6586
		 */
6587
		closeDevTools(): void;
B
Benjamin Pasero 已提交
6588
		/**
6589
		 * Executes editing command copy in page.
B
Benjamin Pasero 已提交
6590
		 */
6591
		copy(): void;
B
Benjamin Pasero 已提交
6592
		/**
6593
		 * Executes editing command cut in page.
B
Benjamin Pasero 已提交
6594
		 */
6595
		cut(): void;
B
Benjamin Pasero 已提交
6596
		/**
6597
		 * Executes editing command delete in page.
B
Benjamin Pasero 已提交
6598
		 */
6599
		delete(): void;
B
Benjamin Pasero 已提交
6600
		/**
6601 6602 6603
		 * Evaluates code in page. If userGesture is set, it will create the user gesture
		 * context in the page. HTML APIs like requestFullScreen, which require user
		 * action, can take advantage of this option for automation.
B
Benjamin Pasero 已提交
6604
		 */
6605
		executeJavaScript(code: string, userGesture?: boolean, callback?: (result: any) => void): void;
6606
		/**
6607 6608
		 * Starts a request to find all matches for the text in the web page. The result of
		 * the request can be obtained by subscribing to found-in-page event.
6609
		 */
6610
		findInPage(text: string, options?: FindInPageOptions): number;
6611 6612 6613 6614
		getTitle(): string;
		getURL(): string;
		getUserAgent(): string;
		getWebContents(): WebContents;
B
Benjamin Pasero 已提交
6615
		/**
6616
		 * Makes the guest page go back.
B
Benjamin Pasero 已提交
6617
		 */
6618
		goBack(): void;
B
Benjamin Pasero 已提交
6619
		/**
6620
		 * Makes the guest page go forward.
B
Benjamin Pasero 已提交
6621
		 */
6622
		goForward(): void;
B
Benjamin Pasero 已提交
6623
		/**
6624
		 * Navigates to the specified absolute index.
B
Benjamin Pasero 已提交
6625
		 */
6626
		goToIndex(index: number): void;
B
Benjamin Pasero 已提交
6627
		/**
6628
		 * Navigates to the specified offset from the "current entry".
B
Benjamin Pasero 已提交
6629
		 */
6630
		goToOffset(offset: number): void;
B
Benjamin Pasero 已提交
6631
		/**
6632
		 * Injects CSS into the guest page.
B
Benjamin Pasero 已提交
6633
		 */
6634
		insertCSS(css: string): void;
B
Benjamin Pasero 已提交
6635
		/**
6636
		 * Inserts text to the focused element.
B
Benjamin Pasero 已提交
6637
		 */
6638
		insertText(text: string): void;
B
Benjamin Pasero 已提交
6639
		/**
6640
		 * Starts inspecting element at position (x, y) of guest page.
B
Benjamin Pasero 已提交
6641
		 */
6642
		inspectElement(x: number, y: number): void;
B
Benjamin Pasero 已提交
6643
		/**
6644
		 * Opens the DevTools for the service worker context present in the guest page.
B
Benjamin Pasero 已提交
6645
		 */
6646 6647 6648 6649 6650 6651 6652
		inspectServiceWorker(): void;
		isAudioMuted(): boolean;
		isCrashed(): boolean;
		isDevToolsFocused(): boolean;
		isDevToolsOpened(): boolean;
		isLoading(): boolean;
		isWaitingForResponse(): boolean;
B
Benjamin Pasero 已提交
6653
		/**
6654 6655
		 * Loads the url in the webview, the url must contain the protocol prefix, e.g. the
		 * http:// or file://.
B
Benjamin Pasero 已提交
6656
		 */
6657
		loadURL(url: string, options?: LoadURLOptions): void;
B
Benjamin Pasero 已提交
6658
		/**
6659
		 * Opens a DevTools window for guest page.
B
Benjamin Pasero 已提交
6660
		 */
6661
		openDevTools(): void;
B
Benjamin Pasero 已提交
6662
		/**
6663
		 * Executes editing command paste in page.
B
Benjamin Pasero 已提交
6664
		 */
6665
		paste(): void;
B
Benjamin Pasero 已提交
6666
		/**
6667
		 * Executes editing command pasteAndMatchStyle in page.
B
Benjamin Pasero 已提交
6668
		 */
6669
		pasteAndMatchStyle(): void;
B
Benjamin Pasero 已提交
6670
		/**
6671
		 * Prints webview's web page. Same as webContents.print([options]).
B
Benjamin Pasero 已提交
6672
		 */
6673
		print(options?: PrintOptions): void;
B
Benjamin Pasero 已提交
6674
		/**
6675 6676
		 * Prints webview's web page as PDF, Same as webContents.printToPDF(options,
		 * callback).
B
Benjamin Pasero 已提交
6677
		 */
6678
		printToPDF(options: PrintToPDFOptions, callback: (error: Error, data: Buffer) => void): void;
B
Benjamin Pasero 已提交
6679
		/**
6680
		 * Executes editing command redo in page.
B
Benjamin Pasero 已提交
6681
		 */
6682
		redo(): void;
B
Benjamin Pasero 已提交
6683
		/**
6684
		 * Reloads the guest page.
B
Benjamin Pasero 已提交
6685
		 */
6686
		reload(): void;
B
Benjamin Pasero 已提交
6687
		/**
6688
		 * Reloads the guest page and ignores cache.
B
Benjamin Pasero 已提交
6689
		 */
6690
		reloadIgnoringCache(): void;
B
Benjamin Pasero 已提交
6691
		/**
6692
		 * Executes editing command replace in page.
B
Benjamin Pasero 已提交
6693
		 */
6694
		replace(text: string): void;
B
Benjamin Pasero 已提交
6695
		/**
6696
		 * Executes editing command replaceMisspelling in page.
B
Benjamin Pasero 已提交
6697
		 */
6698
		replaceMisspelling(text: string): void;
B
Benjamin Pasero 已提交
6699
		/**
6700
		 * Executes editing command selectAll in page.
B
Benjamin Pasero 已提交
6701
		 */
6702
		selectAll(): void;
B
Benjamin Pasero 已提交
6703
		/**
6704 6705 6706 6707
		 * Send an asynchronous message to renderer process via channel, you can also send
		 * arbitrary arguments. The renderer process can handle the message by listening to
		 * the channel event with the ipcRenderer module. See webContents.send for
		 * examples.
B
Benjamin Pasero 已提交
6708
		 */
6709
		send(channel: string, ...args: any[]): void;
B
Benjamin Pasero 已提交
6710
		/**
6711 6712
		 * Sends an input event to the page. See webContents.sendInputEvent for detailed
		 * description of event object.
B
Benjamin Pasero 已提交
6713
		 */
6714
		sendInputEvent(event: any): void;
B
Benjamin Pasero 已提交
6715
		/**
6716
		 * Set guest page muted.
B
Benjamin Pasero 已提交
6717
		 */
6718
		setAudioMuted(muted: boolean): void;
B
Benjamin Pasero 已提交
6719
		/**
6720
		 * Overrides the user agent for the guest page.
B
Benjamin Pasero 已提交
6721
		 */
6722
		setUserAgent(userAgent: string): void;
B
Benjamin Pasero 已提交
6723
		/**
6724 6725
		 * Changes the zoom factor to the specified factor. Zoom factor is zoom percent
		 * divided by 100, so 300% = 3.0.
B
Benjamin Pasero 已提交
6726
		 */
6727
		setZoomFactor(factor: number): void;
B
Benjamin Pasero 已提交
6728
		/**
6729 6730 6731
		 * Changes the zoom level to the specified level. The original size is 0 and each
		 * increment above or below represents zooming 20% larger or smaller to default
		 * limits of 300% and 50% of original size, respectively.
B
Benjamin Pasero 已提交
6732
		 */
6733
		setZoomLevel(level: number): void;
B
Benjamin Pasero 已提交
6734
		/**
6735
		 * Shows pop-up dictionary that searches the selected word on the page.
B
Benjamin Pasero 已提交
6736
		 */
6737
		showDefinitionForSelection(): void;
B
Benjamin Pasero 已提交
6738
		/**
6739
		 * Stops any pending navigation.
B
Benjamin Pasero 已提交
6740
		 */
6741
		stop(): void;
B
Benjamin Pasero 已提交
6742
		/**
6743
		 * Stops any findInPage request for the webview with the provided action.
B
Benjamin Pasero 已提交
6744
		 */
6745
		stopFindInPage(action: 'clearSelection' | 'keepSelection' | 'activateSelection'): void;
B
Benjamin Pasero 已提交
6746
		/**
6747
		 * Executes editing command undo in page.
B
Benjamin Pasero 已提交
6748
		 */
6749
		undo(): void;
B
Benjamin Pasero 已提交
6750
		/**
6751
		 * Executes editing command unselect in page.
B
Benjamin Pasero 已提交
6752
		 */
6753
		unselect(): void;
B
Benjamin Pasero 已提交
6754
		/**
6755 6756
		 * When this attribute is present the guest page will be allowed to open new
		 * windows. Popups are disabled by default.
B
Benjamin Pasero 已提交
6757
		 */
6758
		// allowpopups?: string; ### VSCODE CHANGE (https://github.com/electron/electron/blob/master/docs/tutorial/security.md) ###
B
Benjamin Pasero 已提交
6759
		/**
6760 6761 6762 6763 6764
		 * When this attribute is present the webview container will automatically resize
		 * within the bounds specified by the attributes minwidth, minheight, maxwidth, and
		 * maxheight. These constraints do not impact the webview unless autosize is
		 * enabled. When autosize is enabled, the webview container size cannot be less
		 * than the minimum values or greater than the maximum.
B
Benjamin Pasero 已提交
6765
		 */
6766
		autosize?: string;
B
Benjamin Pasero 已提交
6767
		/**
6768 6769 6770
		 * A list of strings which specifies the blink features to be disabled separated by
		 * ,. The full list of supported feature strings can be found in the
		 * RuntimeEnabledFeatures.json5 file.
B
Benjamin Pasero 已提交
6771
		 */
6772
		disableblinkfeatures?: string;
B
Benjamin Pasero 已提交
6773
		/**
6774 6775
		 * When this attribute is present the guest page will have web security disabled.
		 * Web security is enabled by default.
B
Benjamin Pasero 已提交
6776
		 */
6777
		// disablewebsecurity?: string; ### VSCODE CHANGE(https://github.com/electron/electron/blob/master/docs/tutorial/security.md) ###
B
Benjamin Pasero 已提交
6778
		/**
6779 6780 6781
		 * A list of strings which specifies the blink features to be enabled separated by
		 * ,. The full list of supported feature strings can be found in the
		 * RuntimeEnabledFeatures.json5 file.
B
Benjamin Pasero 已提交
6782
		 */
6783
		enableblinkfeatures?: string;
B
Benjamin Pasero 已提交
6784
		/**
6785
		 * Sets the referrer URL for the guest page.
B
Benjamin Pasero 已提交
6786
		 */
6787
		httpreferrer?: string;
B
Benjamin Pasero 已提交
6788
		/**
6789 6790 6791
		 * When this attribute is present the guest page in webview will have node
		 * integration and can use node APIs like require and process to access low level
		 * system resources. Node integration is disabled by default in the guest page.
B
Benjamin Pasero 已提交
6792
		 */
6793
		nodeintegration?: string;
B
Benjamin Pasero 已提交
6794
		/**
6795 6796 6797 6798 6799 6800 6801 6802
		 * Sets the session used by the page. If partition starts with persist:, the page
		 * will use a persistent session available to all pages in the app with the same
		 * partition. if there is no persist: prefix, the page will use an in-memory
		 * session. By assigning the same partition, multiple pages can share the same
		 * session. If the partition is unset then default session of the app will be used.
		 * This value can only be modified before the first navigation, since the session
		 * of an active renderer process cannot change. Subsequent attempts to modify the
		 * value will fail with a DOM exception.
B
Benjamin Pasero 已提交
6803
		 */
6804
		partition?: string;
B
Benjamin Pasero 已提交
6805
		/**
6806 6807
		 * When this attribute is present the guest page in webview will be able to use
		 * browser plugins. Plugins are disabled by default.
B
Benjamin Pasero 已提交
6808
		 */
6809
		plugins?: string;
B
Benjamin Pasero 已提交
6810
		/**
6811 6812 6813 6814 6815 6816 6817
		 * Specifies a script that will be loaded before other scripts run in the guest
		 * page. The protocol of script's URL must be either file: or asar:, because it
		 * will be loaded by require in guest page under the hood. When the guest page
		 * doesn't have node integration this script will still have access to all Node
		 * APIs, but global objects injected by Node will be deleted after this script has
		 * finished executing. Note: This option will be appear as preloadURL (not preload)
		 * in the webPreferences specified to the will-attach-webview event.
B
Benjamin Pasero 已提交
6818
		 */
6819
		preload?: string;
B
Benjamin Pasero 已提交
6820
		/**
6821 6822 6823
		 * Returns the visible URL. Writing to this attribute initiates top-level
		 * navigation. Assigning src its own value will reload the current page. The src
		 * attribute can also accept data URLs, such as data:text/plain,Hello, world!.
B
Benjamin Pasero 已提交
6824
		 */
6825
		src?: string;
B
Benjamin Pasero 已提交
6826
		/**
6827 6828
		 * Sets the user agent for the guest page before the page is navigated to. Once the
		 * page is loaded, use the setUserAgent method to change the user agent.
B
Benjamin Pasero 已提交
6829
		 */
6830
		useragent?: string;
B
Benjamin Pasero 已提交
6831
		/**
6832 6833 6834 6835 6836 6837
		 * A list of strings which specifies the web preferences to be set on the webview,
		 * separated by ,. The full list of supported preference strings can be found in
		 * BrowserWindow. The string follows the same format as the features string in
		 * window.open. A name by itself is given a true boolean value. A preference can be
		 * set to another value by including an =, followed by the value. Special values
		 * yes and 1 are interpreted as true, while no and 0 are interpreted as false.
B
Benjamin Pasero 已提交
6838
		 */
6839
		webpreferences?: string;
B
Benjamin Pasero 已提交
6840 6841
	}

6842
	interface AboutPanelOptionsOptions {
B
Benjamin Pasero 已提交
6843
		/**
6844
		 * The app's name.
B
Benjamin Pasero 已提交
6845
		 */
6846
		applicationName?: string;
B
Benjamin Pasero 已提交
6847
		/**
6848
		 * The app's version.
B
Benjamin Pasero 已提交
6849
		 */
6850
		applicationVersion?: string;
B
Benjamin Pasero 已提交
6851
		/**
6852
		 * Copyright information.
B
Benjamin Pasero 已提交
6853
		 */
6854
		copyright?: string;
B
Benjamin Pasero 已提交
6855
		/**
6856
		 * Credit information.
B
Benjamin Pasero 已提交
6857
		 */
6858
		credits?: string;
B
Benjamin Pasero 已提交
6859
		/**
6860
		 * The app's build version number.
B
Benjamin Pasero 已提交
6861
		 */
6862 6863 6864 6865
		version?: string;
	}

	interface AddRepresentationOptions {
B
Benjamin Pasero 已提交
6866
		/**
6867
		 * The scale factor to add the image representation for.
B
Benjamin Pasero 已提交
6868
		 */
6869
		scaleFactor: number;
B
Benjamin Pasero 已提交
6870
		/**
6871
		 * Defaults to 0. Required if a bitmap buffer is specified as buffer.
B
Benjamin Pasero 已提交
6872
		 */
6873
		width?: number;
B
Benjamin Pasero 已提交
6874
		/**
6875
		 * Defaults to 0. Required if a bitmap buffer is specified as buffer.
B
Benjamin Pasero 已提交
6876
		 */
6877
		height?: number;
B
Benjamin Pasero 已提交
6878
		/**
6879
		 * The buffer containing the raw image data.
B
Benjamin Pasero 已提交
6880
		 */
6881
		buffer?: Buffer;
B
Benjamin Pasero 已提交
6882
		/**
6883
		 * The data URL containing either a base 64 encoded PNG or JPEG image.
B
Benjamin Pasero 已提交
6884
		 */
6885
		dataURL?: string;
B
Benjamin Pasero 已提交
6886 6887
	}

6888
	interface AppDetailsOptions {
B
Benjamin Pasero 已提交
6889
		/**
6890
		 * Window's . It has to be set, otherwise the other options will have no effect.
6891
		 */
6892
		appId?: string;
6893
		/**
6894
		 * Window's .
6895
		 */
6896
		appIconPath?: string;
6897
		/**
6898 6899
		 * Index of the icon in appIconPath. Ignored when appIconPath is not set. Default
		 * is 0.
6900
		 */
6901
		appIconIndex?: number;
6902
		/**
6903
		 * Window's .
B
Benjamin Pasero 已提交
6904
		 */
6905
		relaunchCommand?: string;
B
Benjamin Pasero 已提交
6906
		/**
6907
		 * Window's .
B
Benjamin Pasero 已提交
6908
		 */
6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920
		relaunchDisplayName?: string;
	}

	interface AuthInfo {
		isProxy: boolean;
		scheme: string;
		host: string;
		port: number;
		realm: string;
	}

	interface AutoResizeOptions {
B
Benjamin Pasero 已提交
6921
		/**
6922 6923
		 * If true, the view's width will grow and shrink together with the window. false
		 * by default.
B
Benjamin Pasero 已提交
6924
		 */
6925
		width: boolean;
B
Benjamin Pasero 已提交
6926
		/**
6927 6928
		 * If true, the view's height will grow and shrink together with the window. false
		 * by default.
B
Benjamin Pasero 已提交
6929
		 */
6930
		height: boolean;
B
Benjamin Pasero 已提交
6931 6932
	}

6933
	interface BitmapOptions {
B
Benjamin Pasero 已提交
6934
		/**
6935
		 * Defaults to 1.0.
B
Benjamin Pasero 已提交
6936
		 */
6937 6938
		scaleFactor?: number;
	}
B
Benjamin Pasero 已提交
6939

6940
	interface BrowserViewConstructorOptions {
B
Benjamin Pasero 已提交
6941
		/**
6942
		 * See .
B
Benjamin Pasero 已提交
6943
		 */
6944 6945 6946 6947
		webPreferences?: WebPreferences;
	}

	interface BrowserWindowConstructorOptions {
B
Benjamin Pasero 已提交
6948
		/**
6949
		 * Window's width in pixels. Default is 800.
B
Benjamin Pasero 已提交
6950
		 */
6951
		width?: number;
B
Benjamin Pasero 已提交
6952
		/**
6953
		 * Window's height in pixels. Default is 600.
B
Benjamin Pasero 已提交
6954
		 */
6955
		height?: number;
B
Benjamin Pasero 已提交
6956
		/**
6957 6958
		 * ( if y is used) Window's left offset from screen. Default is to center the
		 * window.
B
Benjamin Pasero 已提交
6959
		 */
6960
		x?: number;
B
Benjamin Pasero 已提交
6961
		/**
6962 6963
		 * ( if x is used) Window's top offset from screen. Default is to center the
		 * window.
B
Benjamin Pasero 已提交
6964
		 */
6965
		y?: number;
6966
		/**
6967 6968 6969
		 * 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. Default
		 * is false.
6970
		 */
6971
		useContentSize?: boolean;
6972
		/**
6973
		 * Show window in the center of the screen.
6974
		 */
6975
		center?: boolean;
6976
		/**
6977
		 * Window's minimum width. Default is 0.
6978
		 */
6979
		minWidth?: number;
B
Benjamin Pasero 已提交
6980
		/**
6981
		 * Window's minimum height. Default is 0.
B
Benjamin Pasero 已提交
6982
		 */
6983
		minHeight?: number;
B
Benjamin Pasero 已提交
6984
		/**
6985
		 * Window's maximum width. Default is no limit.
B
Benjamin Pasero 已提交
6986
		 */
6987
		maxWidth?: number;
B
Benjamin Pasero 已提交
6988
		/**
6989
		 * Window's maximum height. Default is no limit.
B
Benjamin Pasero 已提交
6990
		 */
6991
		maxHeight?: number;
B
Benjamin Pasero 已提交
6992
		/**
6993
		 * Whether window is resizable. Default is true.
B
Benjamin Pasero 已提交
6994
		 */
6995
		resizable?: boolean;
B
Benjamin Pasero 已提交
6996
		/**
6997
		 * Whether window is movable. This is not implemented on Linux. Default is true.
B
Benjamin Pasero 已提交
6998
		 */
6999
		movable?: boolean;
B
Benjamin Pasero 已提交
7000
		/**
7001 7002
		 * Whether window is minimizable. This is not implemented on Linux. Default is
		 * true.
B
Benjamin Pasero 已提交
7003
		 */
7004
		minimizable?: boolean;
B
Benjamin Pasero 已提交
7005
		/**
7006 7007
		 * Whether window is maximizable. This is not implemented on Linux. Default is
		 * true.
B
Benjamin Pasero 已提交
7008
		 */
7009
		maximizable?: boolean;
B
Benjamin Pasero 已提交
7010
		/**
7011
		 * Whether window is closable. This is not implemented on Linux. Default is true.
B
Benjamin Pasero 已提交
7012
		 */
7013
		closable?: boolean;
B
Benjamin Pasero 已提交
7014
		/**
7015 7016 7017 7018
		 * Whether the window can be focused. Default is true. On Windows setting
		 * focusable: false also implies setting skipTaskbar: true. On Linux setting
		 * focusable: false makes the window stop interacting with wm, so the window will
		 * always stay on top in all workspaces.
B
Benjamin Pasero 已提交
7019
		 */
7020
		focusable?: boolean;
B
Benjamin Pasero 已提交
7021
		/**
7022
		 * Whether the window should always stay on top of other windows. Default is false.
B
Benjamin Pasero 已提交
7023
		 */
7024
		alwaysOnTop?: boolean;
B
Benjamin Pasero 已提交
7025
		/**
7026 7027
		 * Whether the window should show in fullscreen. When explicitly set to false the
		 * fullscreen button will be hidden or disabled on macOS. Default is false.
B
Benjamin Pasero 已提交
7028
		 */
7029
		fullscreen?: boolean;
B
Benjamin Pasero 已提交
7030
		/**
7031 7032 7033
		 * Whether the window can be put into fullscreen mode. On macOS, also whether the
		 * maximize/zoom button should toggle full screen mode or maximize window. Default
		 * is true.
B
Benjamin Pasero 已提交
7034
		 */
7035
		fullscreenable?: boolean;
7036 7037 7038 7039
		/**
		 * Use pre-Lion fullscreen on macOS. Default is false.
		 */
		simpleFullscreen?: boolean;
B
Benjamin Pasero 已提交
7040
		/**
7041
		 * Whether to show the window in taskbar. Default is false.
B
Benjamin Pasero 已提交
7042
		 */
7043
		skipTaskbar?: boolean;
B
Benjamin Pasero 已提交
7044
		/**
7045
		 * The kiosk mode. Default is false.
B
Benjamin Pasero 已提交
7046
		 */
7047
		kiosk?: boolean;
B
Benjamin Pasero 已提交
7048
		/**
7049
		 * Default window title. Default is "Electron".
B
Benjamin Pasero 已提交
7050
		 */
7051
		title?: string;
B
Benjamin Pasero 已提交
7052
		/**
7053 7054 7055
		 * The window icon. On Windows it is recommended to use ICO icons to get best
		 * visual effects, you can also leave it undefined so the executable's icon will be
		 * used.
B
Benjamin Pasero 已提交
7056
		 */
7057
		icon?: NativeImage | string;
B
Benjamin Pasero 已提交
7058
		/**
7059
		 * Whether window should be shown when created. Default is true.
B
Benjamin Pasero 已提交
7060
		 */
7061
		show?: boolean;
B
Benjamin Pasero 已提交
7062
		/**
7063
		 * Specify false to create a . Default is true.
B
Benjamin Pasero 已提交
7064
		 */
7065
		frame?: boolean;
B
Benjamin Pasero 已提交
7066
		/**
7067
		 * Specify parent window. Default is null.
B
Benjamin Pasero 已提交
7068
		 */
7069
		parent?: BrowserWindow;
B
Benjamin Pasero 已提交
7070
		/**
7071 7072
		 * Whether this is a modal window. This only works when the window is a child
		 * window. Default is false.
B
Benjamin Pasero 已提交
7073
		 */
7074
		modal?: boolean;
B
Benjamin Pasero 已提交
7075
		/**
7076 7077
		 * Whether the web view accepts a single mouse-down event that simultaneously
		 * activates the window. Default is false.
B
Benjamin Pasero 已提交
7078
		 */
7079
		acceptFirstMouse?: boolean;
B
Benjamin Pasero 已提交
7080
		/**
7081
		 * Whether to hide cursor when typing. Default is false.
B
Benjamin Pasero 已提交
7082
		 */
7083
		disableAutoHideCursor?: boolean;
B
Benjamin Pasero 已提交
7084
		/**
7085
		 * Auto hide the menu bar unless the Alt key is pressed. Default is false.
B
Benjamin Pasero 已提交
7086
		 */
7087
		autoHideMenuBar?: boolean;
7088
		/**
7089
		 * Enable the window to be resized larger than screen. Default is false.
7090
		 */
7091
		enableLargerThanScreen?: boolean;
B
Benjamin Pasero 已提交
7092
		/**
7093
		 * Window's background color as a hexadecimal value, like #66CD00 or #FFF or
7094 7095 7096
		 * #80FFFFFF (alpha is supported). Default is #FFF (white). If transparent is set
		 * to true, only values with transparent (#00-------) or opaque (#FF-----) alpha
		 * values are respected.
B
Benjamin Pasero 已提交
7097
		 */
7098
		backgroundColor?: string;
B
Benjamin Pasero 已提交
7099
		/**
7100 7101
		 * Whether window should have a shadow. This is only implemented on macOS. Default
		 * is true.
B
Benjamin Pasero 已提交
7102
		 */
7103
		hasShadow?: boolean;
7104 7105 7106 7107 7108
		/**
		 * Set the initial opacity of the window, between 0.0 (fully transparent) and 1.0
		 * (fully opaque). This is only implemented on Windows and macOS.
		 */
		opacity?: number;
B
Benjamin Pasero 已提交
7109
		/**
7110 7111
		 * Forces using dark theme for the window, only works on some GTK+3 desktop
		 * environments. Default is false.
B
Benjamin Pasero 已提交
7112
		 */
7113
		darkTheme?: boolean;
B
Benjamin Pasero 已提交
7114
		/**
7115
		 * Makes the window . Default is false.
B
Benjamin Pasero 已提交
7116
		 */
7117
		transparent?: boolean;
B
Benjamin Pasero 已提交
7118
		/**
7119
		 * The type of window, default is normal window. See more about this below.
B
Benjamin Pasero 已提交
7120
		 */
7121
		type?: string;
B
Benjamin Pasero 已提交
7122
		/**
7123
		 * The style of window title bar. Default is default. Possible values are:
B
Benjamin Pasero 已提交
7124
		 */
7125
		titleBarStyle?: ('default' | 'hidden' | 'hiddenInset' | 'customButtonsOnHover');
B
Benjamin Pasero 已提交
7126
		/**
7127
		 * Shows the title in the title bar in full screen mode on macOS for all
B
Benjamin Pasero 已提交
7128
		 * titleBarStyle options. Default is false.
B
Benjamin Pasero 已提交
7129
		 */
B
Benjamin Pasero 已提交
7130
		fullscreenWindowTitle?: boolean;
B
Benjamin Pasero 已提交
7131
		/**
7132 7133 7134
		 * Use WS_THICKFRAME style for frameless windows on Windows, which adds standard
		 * window frame. Setting it to false will remove window shadow and window
		 * animations. Default is true.
B
Benjamin Pasero 已提交
7135
		 */
7136
		thickFrame?: boolean;
B
Benjamin Pasero 已提交
7137
		/**
7138 7139
		 * Add a type of vibrancy effect to the window, only on macOS. Can be
		 * appearance-based, light, dark, titlebar, selection, menu, popover, sidebar,
7140 7141
		 * medium-light or ultra-dark. Please note that using frame: false in combination
		 * with a vibrancy value requires that you use a non-default titleBarStyle as well.
B
Benjamin Pasero 已提交
7142
		 */
7143
		vibrancy?: ('appearance-based' | 'light' | 'dark' | 'titlebar' | 'selection' | 'menu' | 'popover' | 'sidebar' | 'medium-light' | 'ultra-dark');
B
Benjamin Pasero 已提交
7144
		/**
7145 7146 7147 7148 7149
		 * Controls the behavior on macOS when option-clicking the green stoplight button
		 * on the toolbar or by clicking the Window > Zoom menu item. If true, the window
		 * will grow to the preferred width of the web page when zoomed, false will cause
		 * it to zoom to the width of the screen. This will also affect the behavior when
		 * calling maximize() directly. Default is false.
B
Benjamin Pasero 已提交
7150
		 */
7151
		zoomToPageWidth?: boolean;
B
Benjamin Pasero 已提交
7152
		/**
7153
		 * Tab group name, allows opening the window as a native tab on macOS 10.12+.
B
Benjamin Pasero 已提交
7154 7155 7156
		 * Windows with the same tabbing identifier will be grouped together. This also
		 * adds a native new tab button to your window's tab bar and allows your app and
		 * window to receive the new-window-for-tab event.
B
Benjamin Pasero 已提交
7157
		 */
7158
		tabbingIdentifier?: string;
B
Benjamin Pasero 已提交
7159
		/**
7160
		 * Settings of web page's features.
B
Benjamin Pasero 已提交
7161
		 */
7162 7163 7164 7165
		webPreferences?: WebPreferences;
	}

	interface CertificateTrustDialogOptions {
B
Benjamin Pasero 已提交
7166
		/**
7167
		 * The certificate to trust/import.
B
Benjamin Pasero 已提交
7168
		 */
7169
		certificate: Certificate;
B
Benjamin Pasero 已提交
7170
		/**
7171
		 * The message to display to the user.
B
Benjamin Pasero 已提交
7172
		 */
7173 7174 7175 7176 7177 7178
		message: string;
	}

	interface CertificateVerifyProcRequest {
		hostname: string;
		certificate: Certificate;
B
Benjamin Pasero 已提交
7179
		/**
7180
		 * Verification result from chromium.
B
Benjamin Pasero 已提交
7181
		 */
7182 7183 7184 7185 7186
		verificationResult: string;
		/**
		 * Error code.
		 */
		errorCode: number;
7187 7188 7189
	}

	interface ClearStorageDataOptions {
B
Benjamin Pasero 已提交
7190
		/**
7191
		 * Should follow window.location.origin’s representation scheme://host:port.
B
Benjamin Pasero 已提交
7192
		 */
B
Benjamin Pasero 已提交
7193
		origin?: string;
B
Benjamin Pasero 已提交
7194
		/**
7195
		 * The types of storages to clear, can contain: appcache, cookies, filesystem,
7196
		 * indexdb, localstorage, shadercache, websql, serviceworkers, cachestorage.
B
Benjamin Pasero 已提交
7197
		 */
B
Benjamin Pasero 已提交
7198
		storages?: string[];
B
Benjamin Pasero 已提交
7199
		/**
7200
		 * The types of quotas to clear, can contain: temporary, persistent, syncable.
B
Benjamin Pasero 已提交
7201
		 */
B
Benjamin Pasero 已提交
7202
		quotas?: string[];
7203 7204 7205
	}

	interface CommandLine {
B
Benjamin Pasero 已提交
7206
		/**
7207 7208 7209
		 * Append a switch (with optional value) to Chromium's command line. Note: This
		 * will not affect process.argv, and is mainly used by developers to control some
		 * low-level Chromium behaviors.
B
Benjamin Pasero 已提交
7210
		 */
7211
		appendSwitch: (the_switch: string, value?: string) => void;
B
Benjamin Pasero 已提交
7212
		/**
7213 7214
		 * Append an argument to Chromium's command line. The argument will be quoted
		 * correctly. Note: This will not affect process.argv.
B
Benjamin Pasero 已提交
7215
		 */
7216 7217 7218 7219
		appendArgument: (value: string) => void;
	}

	interface Config {
B
Benjamin Pasero 已提交
7220
		/**
7221
		 * The URL associated with the PAC file.
B
Benjamin Pasero 已提交
7222
		 */
7223
		pacScript: string;
B
Benjamin Pasero 已提交
7224
		/**
7225
		 * Rules indicating which proxies to use.
B
Benjamin Pasero 已提交
7226
		 */
7227
		proxyRules: string;
B
Benjamin Pasero 已提交
7228
		/**
7229
		 * Rules indicating which URLs should bypass the proxy settings.
B
Benjamin Pasero 已提交
7230
		 */
7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241
		proxyBypassRules: string;
	}

	interface ConsoleMessageEvent extends Event {
		level: number;
		message: string;
		line: number;
		sourceId: string;
	}

	interface ContextMenuParams {
B
Benjamin Pasero 已提交
7242
		/**
7243
		 * x coordinate.
B
Benjamin Pasero 已提交
7244
		 */
7245
		x: number;
B
Benjamin Pasero 已提交
7246
		/**
7247
		 * y coordinate.
B
Benjamin Pasero 已提交
7248
		 */
7249
		y: number;
B
Benjamin Pasero 已提交
7250
		/**
7251
		 * URL of the link that encloses the node the context menu was invoked on.
B
Benjamin Pasero 已提交
7252
		 */
7253
		linkURL: string;
B
Benjamin Pasero 已提交
7254
		/**
7255 7256
		 * Text associated with the link. May be an empty string if the contents of the
		 * link are an image.
B
Benjamin Pasero 已提交
7257
		 */
7258
		linkText: string;
B
Benjamin Pasero 已提交
7259
		/**
7260
		 * URL of the top level page that the context menu was invoked on.
B
Benjamin Pasero 已提交
7261
		 */
7262
		pageURL: string;
B
Benjamin Pasero 已提交
7263
		/**
7264
		 * URL of the subframe that the context menu was invoked on.
B
Benjamin Pasero 已提交
7265
		 */
7266
		frameURL: string;
B
Benjamin Pasero 已提交
7267
		/**
7268 7269
		 * Source URL for the element that the context menu was invoked on. Elements with
		 * source URLs are images, audio and video.
B
Benjamin Pasero 已提交
7270
		 */
7271
		srcURL: string;
B
Benjamin Pasero 已提交
7272
		/**
7273 7274
		 * Type of the node the context menu was invoked on. Can be none, image, audio,
		 * video, canvas, file or plugin.
B
Benjamin Pasero 已提交
7275
		 */
7276
		mediaType: ('none' | 'image' | 'audio' | 'video' | 'canvas' | 'file' | 'plugin');
B
Benjamin Pasero 已提交
7277
		/**
7278
		 * Whether the context menu was invoked on an image which has non-empty contents.
B
Benjamin Pasero 已提交
7279
		 */
7280
		hasImageContents: boolean;
B
Benjamin Pasero 已提交
7281
		/**
7282
		 * Whether the context is editable.
B
Benjamin Pasero 已提交
7283
		 */
7284
		isEditable: boolean;
B
Benjamin Pasero 已提交
7285
		/**
7286
		 * Text of the selection that the context menu was invoked on.
B
Benjamin Pasero 已提交
7287
		 */
7288
		selectionText: string;
B
Benjamin Pasero 已提交
7289
		/**
7290
		 * Title or alt text of the selection that the context was invoked on.
B
Benjamin Pasero 已提交
7291
		 */
7292
		titleText: string;
B
Benjamin Pasero 已提交
7293
		/**
7294
		 * The misspelled word under the cursor, if any.
B
Benjamin Pasero 已提交
7295
		 */
7296
		misspelledWord: string;
B
Benjamin Pasero 已提交
7297
		/**
7298
		 * The character encoding of the frame on which the menu was invoked.
B
Benjamin Pasero 已提交
7299
		 */
7300
		frameCharset: string;
B
Benjamin Pasero 已提交
7301
		/**
7302 7303
		 * If the context menu was invoked on an input field, the type of that field.
		 * Possible values are none, plainText, password, other.
B
Benjamin Pasero 已提交
7304
		 */
7305
		inputFieldType: string;
B
Benjamin Pasero 已提交
7306
		/**
7307 7308
		 * Input source that invoked the context menu. Can be none, mouse, keyboard, touch
		 * or touchMenu.
B
Benjamin Pasero 已提交
7309
		 */
7310
		menuSourceType: ('none' | 'mouse' | 'keyboard' | 'touch' | 'touchMenu');
B
Benjamin Pasero 已提交
7311
		/**
7312
		 * The flags for the media element the context menu was invoked on.
B
Benjamin Pasero 已提交
7313
		 */
7314
		mediaFlags: MediaFlags;
B
Benjamin Pasero 已提交
7315
		/**
7316 7317
		 * These flags indicate whether the renderer believes it is able to perform the
		 * corresponding action.
B
Benjamin Pasero 已提交
7318
		 */
7319 7320 7321 7322 7323
		editFlags: EditFlags;
	}

	interface CrashReporterStartOptions {
		companyName?: string;
B
Benjamin Pasero 已提交
7324
		/**
7325
		 * URL that crash reports will be sent to as POST.
B
Benjamin Pasero 已提交
7326
		 */
7327
		submitURL: string;
B
Benjamin Pasero 已提交
7328
		/**
7329
		 * Defaults to app.getName().
B
Benjamin Pasero 已提交
7330
		 */
7331
		productName?: string;
B
Benjamin Pasero 已提交
7332
		/**
7333
		 * Whether crash reports should be sent to the server Default is true.
B
Benjamin Pasero 已提交
7334
		 */
7335
		uploadToServer?: boolean;
B
Benjamin Pasero 已提交
7336
		/**
7337
		 * Default is false.
J
Joao Moreno 已提交
7338
		 */
7339
		ignoreSystemCrashHandler?: boolean;
J
Joao Moreno 已提交
7340
		/**
7341
		 * An object you can define that will be sent along with the report. Only string
B
Benjamin Pasero 已提交
7342 7343
		 * properties are sent correctly. Nested objects are not supported and the property
		 * names and values must be less than 64 characters long.
B
Benjamin Pasero 已提交
7344
		 */
7345
		extra?: Extra;
B
Benjamin Pasero 已提交
7346
		/**
7347 7348
		 * Directory to store the crashreports temporarily (only used when the crash
		 * reporter is started via process.crashReporter.start).
B
Benjamin Pasero 已提交
7349
		 */
7350 7351 7352 7353
		crashesDirectory?: string;
	}

	interface CreateFromBufferOptions {
B
Benjamin Pasero 已提交
7354
		/**
7355
		 * Required for bitmap buffers.
B
Benjamin Pasero 已提交
7356
		 */
7357
		width?: number;
B
Benjamin Pasero 已提交
7358
		/**
7359
		 * Required for bitmap buffers.
B
Benjamin Pasero 已提交
7360
		 */
7361
		height?: number;
B
Benjamin Pasero 已提交
7362
		/**
7363
		 * Defaults to 1.0.
B
Benjamin Pasero 已提交
7364
		 */
7365 7366 7367 7368
		scaleFactor?: number;
	}

	interface CreateInterruptedDownloadOptions {
B
Benjamin Pasero 已提交
7369
		/**
7370
		 * Absolute path of the download.
B
Benjamin Pasero 已提交
7371
		 */
7372
		path: string;
B
Benjamin Pasero 已提交
7373
		/**
7374
		 * Complete URL chain for the download.
B
Benjamin Pasero 已提交
7375
		 */
7376 7377
		urlChain: string[];
		mimeType?: string;
B
Benjamin Pasero 已提交
7378
		/**
7379
		 * Start range for the download.
B
Benjamin Pasero 已提交
7380
		 */
7381
		offset: number;
B
Benjamin Pasero 已提交
7382
		/**
7383
		 * Total length of the download.
B
Benjamin Pasero 已提交
7384
		 */
7385
		length: number;
B
Benjamin Pasero 已提交
7386
		/**
7387
		 * Last-Modified header value.
B
Benjamin Pasero 已提交
7388
		 */
7389
		lastModified: string;
B
Benjamin Pasero 已提交
7390
		/**
7391
		 * ETag header value.
B
Benjamin Pasero 已提交
7392
		 */
7393
		eTag: string;
B
Benjamin Pasero 已提交
7394
		/**
7395
		 * Time when download was started in number of seconds since UNIX epoch.
B
Benjamin Pasero 已提交
7396
		 */
7397 7398 7399 7400 7401 7402 7403 7404
		startTime?: number;
	}

	interface Data {
		text?: string;
		html?: string;
		image?: NativeImage;
		rtf?: string;
B
Benjamin Pasero 已提交
7405
		/**
7406
		 * The title of the url at text.
B
Benjamin Pasero 已提交
7407
		 */
7408 7409 7410 7411
		bookmark?: string;
	}

	interface Details {
B
Benjamin Pasero 已提交
7412
		/**
7413
		 * The url to associate the cookie with.
B
Benjamin Pasero 已提交
7414
		 */
7415
		url: string;
B
Benjamin Pasero 已提交
7416
		/**
7417
		 * The name of the cookie. Empty by default if omitted.
B
Benjamin Pasero 已提交
7418
		 */
7419
		name?: string;
B
Benjamin Pasero 已提交
7420
		/**
7421
		 * The value of the cookie. Empty by default if omitted.
B
Benjamin Pasero 已提交
7422
		 */
7423
		value?: string;
B
Benjamin Pasero 已提交
7424
		/**
7425
		 * The domain of the cookie. Empty by default if omitted.
B
Benjamin Pasero 已提交
7426
		 */
7427
		domain?: string;
B
Benjamin Pasero 已提交
7428
		/**
7429
		 * The path of the cookie. Empty by default if omitted.
B
Benjamin Pasero 已提交
7430
		 */
7431
		path?: string;
B
Benjamin Pasero 已提交
7432
		/**
7433
		 * Whether the cookie should be marked as Secure. Defaults to false.
B
Benjamin Pasero 已提交
7434
		 */
7435
		secure?: boolean;
B
Benjamin Pasero 已提交
7436
		/**
7437
		 * Whether the cookie should be marked as HTTP only. Defaults to false.
B
Benjamin Pasero 已提交
7438
		 */
7439
		httpOnly?: boolean;
B
Benjamin Pasero 已提交
7440
		/**
7441 7442 7443
		 * The expiration date of the cookie as the number of seconds since the UNIX epoch.
		 * If omitted then the cookie becomes a session cookie and will not be retained
		 * between sessions.
B
Benjamin Pasero 已提交
7444
		 */
7445 7446 7447 7448 7449 7450 7451 7452 7453 7454 7455 7456 7457 7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475
		expirationDate?: number;
	}

	interface DevToolsExtensions {
	}

	interface DidChangeThemeColorEvent extends Event {
		themeColor: string;
	}

	interface DidFailLoadEvent extends Event {
		errorCode: number;
		errorDescription: string;
		validatedURL: string;
		isMainFrame: boolean;
	}

	interface DidFrameFinishLoadEvent extends Event {
		isMainFrame: boolean;
	}

	interface DidNavigateEvent extends Event {
		url: string;
	}

	interface DidNavigateInPageEvent extends Event {
		isMainFrame: boolean;
		url: string;
	}

	interface DisplayBalloonOptions {
7476 7477 7478
		/**
		 * -
		 */
7479
		icon?: NativeImage | string;
7480 7481
		title: string;
		content: string;
7482 7483 7484
	}

	interface Dock {
B
Benjamin Pasero 已提交
7485
		/**
7486 7487 7488 7489
		 * When critical is passed, the dock icon will bounce until either the application
		 * becomes active or the request is canceled. 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.
B
Benjamin Pasero 已提交
7490
		 */
7491
		bounce: (type?: 'critical' | 'informational') => number;
B
Benjamin Pasero 已提交
7492
		/**
7493
		 * Cancel the bounce of id.
B
Benjamin Pasero 已提交
7494
		 */
7495
		cancelBounce: (id: number) => void;
B
Benjamin Pasero 已提交
7496
		/**
7497
		 * Bounces the Downloads stack if the filePath is inside the Downloads folder.
B
Benjamin Pasero 已提交
7498
		 */
7499
		downloadFinished: (filePath: string) => void;
B
Benjamin Pasero 已提交
7500
		/**
7501
		 * Sets the string to be displayed in the dock’s badging area.
B
Benjamin Pasero 已提交
7502
		 */
7503 7504
		setBadge: (text: string) => void;
		getBadge: () => string;
B
Benjamin Pasero 已提交
7505
		/**
7506
		 * Hides the dock icon.
B
Benjamin Pasero 已提交
7507
		 */
7508
		hide: () => void;
B
Benjamin Pasero 已提交
7509
		/**
7510
		 * Shows the dock icon.
B
Benjamin Pasero 已提交
7511
		 */
7512 7513
		show: () => void;
		isVisible: () => boolean;
B
Benjamin Pasero 已提交
7514
		/**
7515
		 * Sets the application's dock menu.
B
Benjamin Pasero 已提交
7516
		 */
7517
		setMenu: (menu: Menu) => void;
B
Benjamin Pasero 已提交
7518
		/**
7519
		 * Sets the image associated with this dock icon.
B
Benjamin Pasero 已提交
7520
		 */
7521 7522 7523 7524
		setIcon: (image: NativeImage | string) => void;
	}

	interface EnableNetworkEmulationOptions {
B
Benjamin Pasero 已提交
7525
		/**
7526
		 * Whether to emulate network outage. Defaults to false.
B
Benjamin Pasero 已提交
7527
		 */
7528
		offline?: boolean;
B
Benjamin Pasero 已提交
7529
		/**
7530
		 * RTT in ms. Defaults to 0 which will disable latency throttling.
B
Benjamin Pasero 已提交
7531
		 */
7532
		latency?: number;
B
Benjamin Pasero 已提交
7533
		/**
7534
		 * Download rate in Bps. Defaults to 0 which will disable download throttling.
B
Benjamin Pasero 已提交
7535
		 */
7536
		downloadThroughput?: number;
B
Benjamin Pasero 已提交
7537
		/**
7538
		 * Upload rate in Bps. Defaults to 0 which will disable upload throttling.
B
Benjamin Pasero 已提交
7539
		 */
7540 7541 7542
		uploadThroughput?: number;
	}

B
Benjamin Pasero 已提交
7543 7544 7545
	interface Extensions {
	}

7546 7547 7548 7549 7550 7551 7552 7553 7554 7555 7556 7557
	interface FeedURLOptions {
		url: string;
		/**
		 * HTTP request headers.
		 */
		headers?: Headers;
		/**
		 * Either json or default, see the README for more information.
		 */
		serverType?: string;
	}

7558 7559 7560 7561 7562
	interface FileIconOptions {
		size: ('small' | 'normal' | 'large');
	}

	interface Filter {
B
Benjamin Pasero 已提交
7563
		/**
7564 7565
		 * Retrieves cookies which are associated with url. Empty implies retrieving
		 * cookies of all urls.
B
Benjamin Pasero 已提交
7566
		 */
7567
		url?: string;
B
Benjamin Pasero 已提交
7568
		/**
7569
		 * Filters cookies by name.
B
Benjamin Pasero 已提交
7570
		 */
7571
		name?: string;
B
Benjamin Pasero 已提交
7572
		/**
7573
		 * Retrieves cookies whose domains match or are subdomains of domains.
B
Benjamin Pasero 已提交
7574
		 */
7575
		domain?: string;
B
Benjamin Pasero 已提交
7576
		/**
7577
		 * Retrieves cookies whose path matches path.
B
Benjamin Pasero 已提交
7578
		 */
7579
		path?: string;
B
Benjamin Pasero 已提交
7580
		/**
7581
		 * Filters cookies by their Secure property.
B
Benjamin Pasero 已提交
7582
		 */
7583
		secure?: boolean;
B
Benjamin Pasero 已提交
7584
		/**
7585
		 * Filters out session or persistent cookies.
B
Benjamin Pasero 已提交
7586
		 */
7587 7588 7589 7590
		session?: boolean;
	}

	interface FindInPageOptions {
B
Benjamin Pasero 已提交
7591
		/**
7592
		 * Whether to search forward or backward, defaults to true.
B
Benjamin Pasero 已提交
7593
		 */
7594
		forward?: boolean;
B
Benjamin Pasero 已提交
7595
		/**
7596
		 * Whether the operation is first request or a follow up, defaults to false.
B
Benjamin Pasero 已提交
7597
		 */
7598
		findNext?: boolean;
B
Benjamin Pasero 已提交
7599
		/**
7600
		 * Whether search should be case-sensitive, defaults to false.
B
Benjamin Pasero 已提交
7601
		 */
7602
		matchCase?: boolean;
B
Benjamin Pasero 已提交
7603
		/**
7604
		 * Whether to look only at the start of words. defaults to false.
B
Benjamin Pasero 已提交
7605
		 */
7606
		wordStart?: boolean;
B
Benjamin Pasero 已提交
7607
		/**
7608 7609 7610
		 * When combined with wordStart, accepts a match in the middle of a word if the
		 * match begins with an uppercase letter followed by a lowercase or non-letter.
		 * Accepts several other intra-word matches, defaults to false.
B
Benjamin Pasero 已提交
7611
		 */
7612 7613 7614 7615 7616 7617 7618 7619
		medialCapitalAsWordStart?: boolean;
	}

	interface FoundInPageEvent extends Event {
		result: FoundInPageResult;
	}

	interface FromPartitionOptions {
B
Benjamin Pasero 已提交
7620
		/**
7621
		 * Whether to enable cache.
B
Benjamin Pasero 已提交
7622
		 */
7623 7624 7625 7626
		cache: boolean;
	}

	interface Header {
B
Benjamin Pasero 已提交
7627
		/**
7628
		 * Specify an extra header name.
B
Benjamin Pasero 已提交
7629
		 */
7630 7631 7632
		name: string;
	}

7633 7634 7635
	interface Headers {
	}

7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647
	interface HeapStatistics {
		totalHeapSize: number;
		totalHeapSizeExecutable: number;
		totalPhysicalSize: number;
		totalAvailableSize: number;
		usedHeapSize: number;
		heapSizeLimit: number;
		mallocedMemory: number;
		peakMallocedMemory: number;
		doesZapGarbage: boolean;
	}

7648 7649 7650 7651 7652 7653 7654 7655 7656
	interface IgnoreMouseEventsOptions {
		/**
		 * If true, forwards mouse move messages to Chromium, enabling mouse related events
		 * such as mouseleave. Only used when ignore is true. If ignore is false,
		 * forwarding is always disabled regardless of this value.
		 */
		forward?: boolean;
	}

7657
	interface ImportCertificateOptions {
B
Benjamin Pasero 已提交
7658
		/**
7659
		 * Path for the pkcs12 file.
B
Benjamin Pasero 已提交
7660
		 */
7661
		certificate: string;
B
Benjamin Pasero 已提交
7662
		/**
7663
		 * Passphrase for the certificate.
B
Benjamin Pasero 已提交
7664
		 */
7665 7666 7667 7668
		password: string;
	}

	interface Input {
B
Benjamin Pasero 已提交
7669
		/**
7670
		 * Either keyUp or keyDown.
B
Benjamin Pasero 已提交
7671
		 */
7672
		type: string;
B
Benjamin Pasero 已提交
7673
		/**
7674
		 * Equivalent to .
B
Benjamin Pasero 已提交
7675
		 */
7676
		key: string;
B
Benjamin Pasero 已提交
7677
		/**
7678
		 * Equivalent to .
B
Benjamin Pasero 已提交
7679
		 */
7680
		code: string;
B
Benjamin Pasero 已提交
7681
		/**
7682
		 * Equivalent to .
B
Benjamin Pasero 已提交
7683
		 */
7684
		isAutoRepeat: boolean;
B
Benjamin Pasero 已提交
7685
		/**
7686
		 * Equivalent to .
B
Benjamin Pasero 已提交
7687
		 */
7688
		shift: boolean;
B
Benjamin Pasero 已提交
7689
		/**
7690
		 * Equivalent to .
B
Benjamin Pasero 已提交
7691
		 */
7692
		control: boolean;
B
Benjamin Pasero 已提交
7693
		/**
7694
		 * Equivalent to .
B
Benjamin Pasero 已提交
7695
		 */
7696
		alt: boolean;
B
Benjamin Pasero 已提交
7697
		/**
7698
		 * Equivalent to .
B
Benjamin Pasero 已提交
7699
		 */
7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723
		meta: boolean;
	}

	interface InterceptBufferProtocolRequest {
		url: string;
		referrer: string;
		method: string;
		uploadData: UploadData[];
	}

	interface InterceptFileProtocolRequest {
		url: string;
		referrer: string;
		method: string;
		uploadData: UploadData[];
	}

	interface InterceptHttpProtocolRequest {
		url: string;
		referrer: string;
		method: string;
		uploadData: UploadData[];
	}

7724 7725 7726 7727 7728 7729 7730 7731
	interface InterceptStreamProtocolRequest {
		url: string;
		headers: Headers;
		referrer: string;
		method: string;
		uploadData: UploadData[];
	}

7732 7733 7734 7735 7736 7737 7738 7739 7740 7741 7742 7743 7744
	interface InterceptStringProtocolRequest {
		url: string;
		referrer: string;
		method: string;
		uploadData: UploadData[];
	}

	interface IpcMessageEvent extends Event {
		channel: string;
		args: any[];
	}

	interface Item {
B
Benjamin Pasero 已提交
7745
		/**
7746
		 * or files Array The path(s) to the file(s) being dragged.
B
Benjamin Pasero 已提交
7747
		 */
7748
		file: string;
B
Benjamin Pasero 已提交
7749
		/**
7750
		 * The image must be non-empty on macOS.
B
Benjamin Pasero 已提交
7751
		 */
7752 7753 7754 7755
		icon: NativeImage;
	}

	interface JumpListSettings {
B
Benjamin Pasero 已提交
7756
		/**
7757 7758
		 * The minimum number of items that will be shown in the Jump List (for a more
		 * detailed description of this value see the ).
B
Benjamin Pasero 已提交
7759
		 */
7760
		minItems: number;
B
Benjamin Pasero 已提交
7761
		/**
7762 7763 7764 7765
		 * Array of JumpListItem objects that correspond to 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 call to app.setJumpList(), Windows will not
		 * display any custom category that contains any of the removed items.
B
Benjamin Pasero 已提交
7766
		 */
7767 7768 7769 7770 7771 7772 7773 7774 7775
		removedItems: JumpListItem[];
	}

	interface LoadCommitEvent extends Event {
		url: string;
		isMainFrame: boolean;
	}

	interface LoadURLOptions {
B
Benjamin Pasero 已提交
7776
		/**
7777
		 * An HTTP Referrer url.
B
Benjamin Pasero 已提交
7778
		 */
7779
		httpReferrer?: string | Referrer;
B
Benjamin Pasero 已提交
7780
		/**
7781
		 * A user agent originating the request.
B
Benjamin Pasero 已提交
7782
		 */
7783
		userAgent?: string;
B
Benjamin Pasero 已提交
7784
		/**
7785
		 * Extra headers separated by "\n"
B
Benjamin Pasero 已提交
7786
		 */
7787
		extraHeaders?: string;
7788
		postData?: UploadRawData[] | UploadFile[] | UploadBlob[];
B
Benjamin Pasero 已提交
7789
		/**
7790 7791 7792
		 * Base url (with trailing path separator) for files to be loaded by the data url.
		 * This is needed only if the specified url is a data url and needs to load other
		 * files.
B
Benjamin Pasero 已提交
7793
		 */
7794 7795 7796 7797 7798
		baseURLForDataURL?: string;
	}

	interface LoginItemSettings {
		options?: Options;
B
Benjamin Pasero 已提交
7799
		/**
7800
		 * true if the app is set to open at login.
B
Benjamin Pasero 已提交
7801
		 */
7802
		openAtLogin: boolean;
B
Benjamin Pasero 已提交
7803
		/**
7804 7805
		 * true if the app is set to open as hidden at login. This setting is not available
		 * on .
B
Benjamin Pasero 已提交
7806
		 */
7807
		openAsHidden: boolean;
B
Benjamin Pasero 已提交
7808
		/**
7809 7810
		 * true if the app was opened at login automatically. This setting is not available
		 * on .
B
Benjamin Pasero 已提交
7811
		 */
7812
		wasOpenedAtLogin: boolean;
B
Benjamin Pasero 已提交
7813
		/**
7814
		 * true if the app was opened as a hidden login item. This indicates that the app
7815
		 * should not open any windows at startup. This setting is not available on .
B
Benjamin Pasero 已提交
7816
		 */
7817
		wasOpenedAsHidden: boolean;
B
Benjamin Pasero 已提交
7818
		/**
7819 7820
		 * 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
7821 7822
		 * that were open the last time the app was closed. This setting is not available
		 * on .
B
Benjamin Pasero 已提交
7823
		 */
7824 7825 7826 7827
		restoreState: boolean;
	}

	interface LoginItemSettingsOptions {
B
Benjamin Pasero 已提交
7828
		/**
7829
		 * The executable path to compare against. Defaults to process.execPath.
B
Benjamin Pasero 已提交
7830
		 */
7831
		path?: string;
B
Benjamin Pasero 已提交
7832
		/**
7833
		 * The command-line arguments to compare against. Defaults to an empty array.
B
Benjamin Pasero 已提交
7834
		 */
7835
		args?: string[];
B
Benjamin Pasero 已提交
7836 7837
	}

7838 7839 7840
	interface MemoryDumpConfig {
	}

7841
	interface MenuItemConstructorOptions {
7842
		/**
7843 7844
		 * Will be called with click(menuItem, browserWindow, event) when the menu item is
		 * clicked.
7845
		 */
7846
		click?: (menuItem: MenuItem, browserWindow: BrowserWindow, event: Event) => void;
B
Benjamin Pasero 已提交
7847
		/**
7848 7849
		 * Define the action of the menu item, when specified the click property will be
		 * ignored. See .
B
Benjamin Pasero 已提交
7850
		 */
7851
		role?: string;
B
Benjamin Pasero 已提交
7852
		/**
7853
		 * Can be normal, separator, submenu, checkbox or radio.
B
Benjamin Pasero 已提交
7854
		 */
7855 7856 7857 7858 7859
		type?: ('normal' | 'separator' | 'submenu' | 'checkbox' | 'radio');
		label?: string;
		sublabel?: string;
		accelerator?: Accelerator;
		icon?: NativeImage | string;
B
Benjamin Pasero 已提交
7860
		/**
7861
		 * If false, the menu item will be greyed out and unclickable.
B
Benjamin Pasero 已提交
7862
		 */
7863
		enabled?: boolean;
B
Benjamin Pasero 已提交
7864
		/**
7865
		 * If false, the menu item will be entirely hidden.
B
Benjamin Pasero 已提交
7866
		 */
7867
		visible?: boolean;
B
Benjamin Pasero 已提交
7868
		/**
7869
		 * Should only be specified for checkbox or radio type menu items.
B
Benjamin Pasero 已提交
7870
		 */
7871
		checked?: boolean;
B
Benjamin Pasero 已提交
7872 7873 7874 7875 7876
		/**
		 * If false, the accelerator won't be registered with the system, but it will still
		 * be displayed. Defaults to true.
		 */
		registerAccelerator?: boolean;
B
Benjamin Pasero 已提交
7877
		/**
7878
		 * Should be specified for submenu type menu items. If submenu is specified, the
7879
		 * type: 'submenu' can be omitted. If the value is not a then it will be
7880
		 * automatically converted to one using Menu.buildFromTemplate.
B
Benjamin Pasero 已提交
7881
		 */
7882
		submenu?: MenuItemConstructorOptions[] | Menu;
B
Benjamin Pasero 已提交
7883
		/**
7884 7885
		 * Unique within a single menu. If defined then it can be used as a reference to
		 * this item by the position attribute.
B
Benjamin Pasero 已提交
7886
		 */
7887
		id?: string;
B
Benjamin Pasero 已提交
7888
		/**
7889 7890
		 * This field allows fine-grained definition of the specific location within a
		 * given menu.
B
Benjamin Pasero 已提交
7891
		 */
7892
		position?: string;
B
Benjamin Pasero 已提交
7893 7894
	}

7895
	interface MessageBoxOptions {
B
Benjamin Pasero 已提交
7896
		/**
7897 7898 7899
		 * Can be "none", "info", "error", "question" or "warning". On Windows, "question"
		 * displays the same icon as "info", unless you set an icon using the "icon"
		 * option. On macOS, both "warning" and "error" display the same warning icon.
B
Benjamin Pasero 已提交
7900
		 */
7901
		type?: string;
B
Benjamin Pasero 已提交
7902
		/**
7903 7904
		 * Array of texts for buttons. On Windows, an empty array will result in one button
		 * labeled "OK".
B
Benjamin Pasero 已提交
7905
		 */
7906
		buttons?: string[];
B
Benjamin Pasero 已提交
7907
		/**
7908 7909
		 * Index of the button in the buttons array which will be selected by default when
		 * the message box opens.
B
Benjamin Pasero 已提交
7910
		 */
7911
		defaultId?: number;
B
Benjamin Pasero 已提交
7912
		/**
7913
		 * Title of the message box, some platforms will not show it.
B
Benjamin Pasero 已提交
7914
		 */
7915
		title?: string;
B
Benjamin Pasero 已提交
7916
		/**
7917
		 * Content of the message box.
B
Benjamin Pasero 已提交
7918
		 */
7919
		message: string;
B
Benjamin Pasero 已提交
7920
		/**
7921
		 * Extra information of the message.
B
Benjamin Pasero 已提交
7922
		 */
7923
		detail?: string;
B
Benjamin Pasero 已提交
7924
		/**
7925 7926
		 * If provided, the message box will include a checkbox with the given label. The
		 * checkbox state can be inspected only when using callback.
B
Benjamin Pasero 已提交
7927
		 */
7928
		checkboxLabel?: string;
B
Benjamin Pasero 已提交
7929
		/**
7930
		 * Initial checked state of the checkbox. false by default.
B
Benjamin Pasero 已提交
7931
		 */
7932 7933
		checkboxChecked?: boolean;
		icon?: NativeImage;
B
Benjamin Pasero 已提交
7934
		/**
7935 7936 7937 7938
		 * The index of the button to be used to cancel the dialog, via the Esc key. By
		 * default this is assigned to the first button with "cancel" or "no" as the label.
		 * If no such labeled buttons exist and this option is not set, 0 will be used as
		 * the return value or callback response. This option is ignored on Windows.
B
Benjamin Pasero 已提交
7939
		 */
7940
		cancelId?: number;
B
Benjamin Pasero 已提交
7941
		/**
7942 7943 7944 7945
		 * On Windows Electron will try to figure out which one of the buttons are common
		 * buttons (like "Cancel" or "Yes"), and show the others as command links in the
		 * dialog. This can make the dialog appear in the style of modern Windows apps. If
		 * you don't like this behavior, you can set noLink to true.
B
Benjamin Pasero 已提交
7946
		 */
7947
		noLink?: boolean;
B
Benjamin Pasero 已提交
7948
		/**
7949 7950 7951 7952 7953 7954 7955
		 * Normalize the keyboard access keys across platforms. Default is false. Enabling
		 * this assumes & is used in the button labels for the placement of the keyboard
		 * shortcut access key and labels will be converted so they work correctly on each
		 * platform, & characters are removed on macOS, converted to _ on Linux, and left
		 * untouched on Windows. For example, a button label of Vie&w will be converted to
		 * Vie_w on Linux and View on macOS and can be selected via Alt-W on Windows and
		 * Linux.
B
Benjamin Pasero 已提交
7956
		 */
7957
		normalizeAccessKeys?: boolean;
B
Benjamin Pasero 已提交
7958 7959
	}

7960 7961 7962
	interface NewWindowEvent extends Event {
		url: string;
		frameName: string;
B
Benjamin Pasero 已提交
7963
		/**
7964 7965
		 * Can be `default`, `foreground-tab`, `background-tab`, `new-window`,
		 * `save-to-disk` and `other`.
B
Benjamin Pasero 已提交
7966
		 */
7967
		disposition: ('default' | 'foreground-tab' | 'background-tab' | 'new-window' | 'save-to-disk' | 'other');
B
Benjamin Pasero 已提交
7968
		/**
7969
		 * The options which should be used for creating the new .
B
Benjamin Pasero 已提交
7970
		 */
7971
		options: Options;
B
Benjamin Pasero 已提交
7972 7973
	}

7974
	interface NotificationConstructorOptions {
B
Benjamin Pasero 已提交
7975
		/**
7976
		 * A title for the notification, which will be shown at the top of the notification
7977
		 * window when it is shown.
B
Benjamin Pasero 已提交
7978
		 */
7979
		title: string;
B
Benjamin Pasero 已提交
7980
		/**
B
Benjamin Pasero 已提交
7981
		 * A subtitle for the notification, which will be displayed below the title.
B
Benjamin Pasero 已提交
7982
		 */
B
Benjamin Pasero 已提交
7983
		subtitle?: string;
B
Benjamin Pasero 已提交
7984
		/**
B
Benjamin Pasero 已提交
7985
		 * The body text of the notification, which will be displayed below the title or
7986
		 * subtitle.
B
Benjamin Pasero 已提交
7987
		 */
7988
		body: string;
B
Benjamin Pasero 已提交
7989
		/**
7990
		 * Whether or not to emit an OS notification noise when showing the notification.
B
Benjamin Pasero 已提交
7991
		 */
7992
		silent?: boolean;
B
Benjamin Pasero 已提交
7993
		/**
7994
		 * An icon to use in the notification.
B
Benjamin Pasero 已提交
7995
		 */
7996
		icon?: string | NativeImage;
B
Benjamin Pasero 已提交
7997
		/**
7998
		 * Whether or not to add an inline reply option to the notification.
B
Benjamin Pasero 已提交
7999
		 */
8000
		hasReply?: boolean;
B
Benjamin Pasero 已提交
8001
		/**
8002
		 * The placeholder to write in the inline reply input field.
B
Benjamin Pasero 已提交
8003
		 */
8004
		replyPlaceholder?: string;
B
Benjamin Pasero 已提交
8005
		/**
B
Benjamin Pasero 已提交
8006
		 * The name of the sound file to play when the notification is shown.
B
Benjamin Pasero 已提交
8007
		 */
B
Benjamin Pasero 已提交
8008
		sound?: string;
B
Benjamin Pasero 已提交
8009
		/**
B
Benjamin Pasero 已提交
8010
		 * Actions to add to the notification. Please read the available actions and
8011
		 * limitations in the NotificationAction documentation.
B
Benjamin Pasero 已提交
8012
		 */
B
Benjamin Pasero 已提交
8013
		actions?: NotificationAction[];
8014 8015 8016 8017 8018
		/**
		 * A custom title for the close button of an alert. An empty string will cause the
		 * default localized text to be used.
		 */
		closeButtonText?: string;
B
Benjamin Pasero 已提交
8019 8020
	}

8021
	interface OnBeforeRedirectDetails {
8022
		id: number;
8023 8024
		url: string;
		method: string;
8025
		webContentsId?: number;
8026 8027 8028 8029
		resourceType: string;
		timestamp: number;
		redirectURL: string;
		statusCode: number;
B
Benjamin Pasero 已提交
8030
		/**
8031
		 * The server IP address that the request was actually sent to.
B
Benjamin Pasero 已提交
8032
		 */
8033 8034 8035 8036 8037 8038
		ip?: string;
		fromCache: boolean;
		responseHeaders: ResponseHeaders;
	}

	interface OnBeforeRedirectFilter {
B
Benjamin Pasero 已提交
8039
		/**
8040 8041
		 * Array of URL patterns that will be used to filter out the requests that do not
		 * match the URL patterns.
B
Benjamin Pasero 已提交
8042
		 */
8043 8044 8045 8046 8047 8048 8049
		urls: string[];
	}

	interface OnBeforeRequestDetails {
		id: number;
		url: string;
		method: string;
8050
		webContentsId?: number;
8051 8052 8053 8054 8055 8056
		resourceType: string;
		timestamp: number;
		uploadData: UploadData[];
	}

	interface OnBeforeRequestFilter {
B
Benjamin Pasero 已提交
8057
		/**
8058 8059
		 * Array of URL patterns that will be used to filter out the requests that do not
		 * match the URL patterns.
B
Benjamin Pasero 已提交
8060
		 */
8061
		urls: string[];
B
Benjamin Pasero 已提交
8062 8063
	}

B
Benjamin Pasero 已提交
8064 8065 8066 8067 8068 8069 8070 8071 8072 8073
	interface OnBeforeSendHeadersDetails {
		id: number;
		url: string;
		method: string;
		webContentsId?: number;
		resourceType: string;
		timestamp: number;
		requestHeaders: RequestHeaders;
	}

8074
	interface OnBeforeSendHeadersFilter {
B
Benjamin Pasero 已提交
8075
		/**
8076 8077
		 * Array of URL patterns that will be used to filter out the requests that do not
		 * match the URL patterns.
B
Benjamin Pasero 已提交
8078
		 */
8079 8080 8081
		urls: string[];
	}

B
Benjamin Pasero 已提交
8082 8083 8084 8085 8086 8087 8088 8089
	interface OnBeforeSendHeadersResponse {
		cancel?: boolean;
		/**
		 * When provided, request will be made with these headers.
		 */
		requestHeaders?: RequestHeaders;
	}

8090 8091 8092 8093
	interface OnCompletedDetails {
		id: number;
		url: string;
		method: string;
8094
		webContentsId?: number;
8095 8096 8097 8098 8099 8100 8101 8102 8103
		resourceType: string;
		timestamp: number;
		responseHeaders: ResponseHeaders;
		fromCache: boolean;
		statusCode: number;
		statusLine: string;
	}

	interface OnCompletedFilter {
B
Benjamin Pasero 已提交
8104
		/**
8105 8106
		 * Array of URL patterns that will be used to filter out the requests that do not
		 * match the URL patterns.
B
Benjamin Pasero 已提交
8107
		 */
8108
		urls: string[];
B
Benjamin Pasero 已提交
8109 8110
	}

8111 8112
	interface OnErrorOccurredDetails {
		id: number;
B
Benjamin Pasero 已提交
8113
		url: string;
8114
		method: string;
8115
		webContentsId?: number;
8116 8117 8118
		resourceType: string;
		timestamp: number;
		fromCache: boolean;
B
Benjamin Pasero 已提交
8119
		/**
8120
		 * The error description.
B
Benjamin Pasero 已提交
8121
		 */
8122
		error: string;
B
Benjamin Pasero 已提交
8123 8124
	}

8125
	interface OnErrorOccurredFilter {
B
Benjamin Pasero 已提交
8126
		/**
8127 8128
		 * Array of URL patterns that will be used to filter out the requests that do not
		 * match the URL patterns.
B
Benjamin Pasero 已提交
8129
		 */
8130
		urls: string[];
B
Benjamin Pasero 已提交
8131 8132
	}

B
Benjamin Pasero 已提交
8133 8134 8135 8136 8137 8138 8139 8140 8141 8142 8143 8144
	interface OnHeadersReceivedDetails {
		id: number;
		url: string;
		method: string;
		webContentsId?: number;
		resourceType: string;
		timestamp: number;
		statusLine: string;
		statusCode: number;
		responseHeaders: ResponseHeaders;
	}

8145
	interface OnHeadersReceivedFilter {
B
Benjamin Pasero 已提交
8146
		/**
8147 8148
		 * Array of URL patterns that will be used to filter out the requests that do not
		 * match the URL patterns.
B
Benjamin Pasero 已提交
8149
		 */
8150 8151 8152
		urls: string[];
	}

B
Benjamin Pasero 已提交
8153 8154 8155 8156 8157 8158 8159 8160 8161 8162 8163 8164 8165
	interface OnHeadersReceivedResponse {
		cancel: boolean;
		/**
		 * When provided, the server is assumed to have responded with these headers.
		 */
		responseHeaders?: ResponseHeaders;
		/**
		 * Should be provided when overriding responseHeaders to change header status
		 * otherwise original response header's status will be used.
		 */
		statusLine?: string;
	}

8166 8167 8168 8169
	interface OnResponseStartedDetails {
		id: number;
		url: string;
		method: string;
8170
		webContentsId?: number;
8171 8172 8173
		resourceType: string;
		timestamp: number;
		responseHeaders: ResponseHeaders;
B
Benjamin Pasero 已提交
8174
		/**
8175
		 * Indicates whether the response was fetched from disk cache.
B
Benjamin Pasero 已提交
8176
		 */
8177 8178 8179 8180 8181 8182
		fromCache: boolean;
		statusCode: number;
		statusLine: string;
	}

	interface OnResponseStartedFilter {
B
Benjamin Pasero 已提交
8183
		/**
8184 8185
		 * Array of URL patterns that will be used to filter out the requests that do not
		 * match the URL patterns.
B
Benjamin Pasero 已提交
8186
		 */
8187
		urls: string[];
B
Benjamin Pasero 已提交
8188 8189
	}

8190 8191
	interface OnSendHeadersDetails {
		id: number;
B
Benjamin Pasero 已提交
8192
		url: string;
8193
		method: string;
8194
		webContentsId?: number;
8195 8196 8197
		resourceType: string;
		timestamp: number;
		requestHeaders: RequestHeaders;
B
Benjamin Pasero 已提交
8198 8199
	}

8200
	interface OnSendHeadersFilter {
B
Benjamin Pasero 已提交
8201
		/**
8202 8203
		 * Array of URL patterns that will be used to filter out the requests that do not
		 * match the URL patterns.
B
Benjamin Pasero 已提交
8204
		 */
8205 8206 8207 8208
		urls: string[];
	}

	interface OpenDevToolsOptions {
B
Benjamin Pasero 已提交
8209
		/**
8210 8211 8212
		 * Opens the devtools with specified dock state, can be right, bottom, undocked,
		 * detach. Defaults to last used dock state. In undocked mode it's possible to dock
		 * back. In detach mode it's not.
B
Benjamin Pasero 已提交
8213
		 */
8214
		mode: ('right' | 'bottom' | 'undocked' | 'detach');
B
Benjamin Pasero 已提交
8215 8216
	}

8217 8218 8219
	interface OpenDialogOptions {
		title?: string;
		defaultPath?: string;
B
Benjamin Pasero 已提交
8220
		/**
8221 8222
		 * Custom label for the confirmation button, when left empty the default label will
		 * be used.
B
Benjamin Pasero 已提交
8223
		 */
8224 8225
		buttonLabel?: string;
		filters?: FileFilter[];
B
Benjamin Pasero 已提交
8226
		/**
8227 8228
		 * Contains which features the dialog should use. The following values are
		 * supported:
B
Benjamin Pasero 已提交
8229
		 */
B
Benjamin Pasero 已提交
8230
		properties?: Array<'openFile' | 'openDirectory' | 'multiSelections' | 'showHiddenFiles' | 'createDirectory' | 'promptToCreate' | 'noResolveAliases' | 'treatPackageAsDirectory'>;
B
Benjamin Pasero 已提交
8231
		/**
8232
		 * Message to display above input boxes.
B
Benjamin Pasero 已提交
8233
		 */
8234
		message?: string;
8235 8236 8237 8238
		/**
		 * Create when packaged for the Mac App Store.
		 */
		securityScopedBookmarks?: boolean;
B
Benjamin Pasero 已提交
8239 8240
	}

8241
	interface OpenExternalOptions {
B
Benjamin Pasero 已提交
8242
		/**
8243
		 * true to bring the opened application to the foreground. The default is true.
B
Benjamin Pasero 已提交
8244
		 */
8245 8246 8247 8248
		activate: boolean;
	}

	interface PageFaviconUpdatedEvent extends Event {
B
Benjamin Pasero 已提交
8249
		/**
8250
		 * Array of URLs.
B
Benjamin Pasero 已提交
8251
		 */
8252 8253 8254 8255 8256 8257
		favicons: string[];
	}

	interface PageTitleUpdatedEvent extends Event {
		title: string;
		explicitSet: boolean;
B
Benjamin Pasero 已提交
8258 8259
	}

8260
	interface Parameters {
B
Benjamin Pasero 已提交
8261
		/**
8262
		 * Specify the screen type to emulate (default: desktop):
B
Benjamin Pasero 已提交
8263
		 */
8264
		screenPosition: ('desktop' | 'mobile');
B
Benjamin Pasero 已提交
8265
		/**
8266
		 * Set the emulated screen size (screenPosition == mobile).
B
Benjamin Pasero 已提交
8267
		 */
8268
		screenSize: Size;
B
Benjamin Pasero 已提交
8269
		/**
8270
		 * Position the view on the screen (screenPosition == mobile) (default: {x: 0, y:
8271
		 * 0}).
B
Benjamin Pasero 已提交
8272
		 */
8273
		viewPosition: Point;
B
Benjamin Pasero 已提交
8274 8275
		/**
		 * Set the device scale factor (if zero defaults to original device scale factor)
8276
		 * (default: 0).
B
Benjamin Pasero 已提交
8277 8278 8279
		 */
		deviceScaleFactor: number;
		/**
8280
		 * Set the emulated view size (empty means no override)
B
Benjamin Pasero 已提交
8281
		 */
8282
		viewSize: Size;
8283 8284
		/**
		 * Scale of emulated view inside available space (not in fit to view mode)
8285
		 * (default: 1).
8286 8287
		 */
		scale: number;
B
Benjamin Pasero 已提交
8288 8289
	}

8290
	interface Payment {
8291 8292 8293
		/**
		 * The identifier of the purchased product.
		 */
8294
		productIdentifier: string;
8295 8296 8297
		/**
		 * The quantity purchased.
		 */
8298 8299 8300 8301 8302 8303 8304 8305 8306 8307
		quantity: number;
	}

	interface PermissionRequestHandlerDetails {
		/**
		 * The url of the openExternal request.
		 */
		externalURL: string;
	}

8308 8309 8310
	interface PluginCrashedEvent extends Event {
		name: string;
		version: string;
B
Benjamin Pasero 已提交
8311 8312
	}

8313
	interface PopupOptions {
8314 8315 8316 8317
		/**
		 * Default is the focused window.
		 */
		window?: BrowserWindow;
B
Benjamin Pasero 已提交
8318
		/**
8319
		 * Default is the current mouse cursor position. Must be declared if y is declared.
B
Benjamin Pasero 已提交
8320
		 */
8321
		x?: number;
B
Benjamin Pasero 已提交
8322
		/**
8323
		 * Default is the current mouse cursor position. Must be declared if x is declared.
B
Benjamin Pasero 已提交
8324
		 */
8325
		y?: number;
B
Benjamin Pasero 已提交
8326
		/**
8327 8328
		 * The index of the menu item to be positioned under the mouse cursor at the
		 * specified coordinates. Default is -1.
B
Benjamin Pasero 已提交
8329
		 */
8330
		positioningItem?: number;
8331 8332 8333 8334
		/**
		 * Called when menu is closed.
		 */
		callback?: () => void;
B
Benjamin Pasero 已提交
8335 8336
	}

8337
	interface PrintOptions {
B
Benjamin Pasero 已提交
8338
		/**
8339
		 * Don't ask user for print settings. Default is false.
B
Benjamin Pasero 已提交
8340
		 */
B
Benjamin Pasero 已提交
8341
		silent?: boolean;
B
Benjamin Pasero 已提交
8342
		/**
8343
		 * Also prints the background color and image of the web page. Default is false.
B
Benjamin Pasero 已提交
8344
		 */
B
Benjamin Pasero 已提交
8345
		printBackground?: boolean;
B
Benjamin Pasero 已提交
8346
		/**
8347
		 * Set the printer device name to use. Default is ''.
B
Benjamin Pasero 已提交
8348
		 */
8349 8350 8351 8352
		deviceName?: string;
	}

	interface PrintToPDFOptions {
B
Benjamin Pasero 已提交
8353
		/**
8354 8355
		 * Specifies the type of margins to use. Uses 0 for default margin, 1 for no
		 * margin, and 2 for minimum margin.
B
Benjamin Pasero 已提交
8356
		 */
8357
		marginsType?: number;
B
Benjamin Pasero 已提交
8358
		/**
8359 8360
		 * Specify page size of the generated PDF. Can be A3, A4, A5, Legal, Letter,
		 * Tabloid or an Object containing height and width in microns.
B
Benjamin Pasero 已提交
8361
		 */
8362
		pageSize?: string | Size;
B
Benjamin Pasero 已提交
8363
		/**
8364
		 * Whether to print CSS backgrounds.
B
Benjamin Pasero 已提交
8365
		 */
8366
		printBackground?: boolean;
B
Benjamin Pasero 已提交
8367
		/**
8368
		 * Whether to print selection only.
B
Benjamin Pasero 已提交
8369
		 */
8370
		printSelectionOnly?: boolean;
B
Benjamin Pasero 已提交
8371
		/**
8372
		 * true for landscape, false for portrait.
B
Benjamin Pasero 已提交
8373
		 */
8374 8375 8376 8377
		landscape?: boolean;
	}

	interface ProcessMemoryInfo {
B
Benjamin Pasero 已提交
8378
		/**
8379
		 * The amount of memory currently pinned to actual physical RAM.
B
Benjamin Pasero 已提交
8380
		 */
8381
		workingSetSize: number;
B
Benjamin Pasero 已提交
8382
		/**
8383
		 * The maximum amount of memory that has ever been pinned to actual physical RAM.
B
Benjamin Pasero 已提交
8384
		 */
8385
		peakWorkingSetSize: number;
B
Benjamin Pasero 已提交
8386
		/**
8387 8388
		 * The amount of memory not shared by other processes, such as JS heap or HTML
		 * content.
B
Benjamin Pasero 已提交
8389
		 */
8390
		privateBytes: number;
B
Benjamin Pasero 已提交
8391
		/**
8392
		 * The amount of memory shared between processes, typically memory consumed by the
8393
		 * Electron code itself.
B
Benjamin Pasero 已提交
8394
		 */
8395 8396 8397 8398
		sharedBytes: number;
	}

	interface ProgressBarOptions {
B
Benjamin Pasero 已提交
8399
		/**
8400
		 * Mode for the progress bar. Can be none, normal, indeterminate, error or paused.
B
Benjamin Pasero 已提交
8401
		 */
8402
		mode: ('none' | 'normal' | 'indeterminate' | 'error' | 'paused');
B
Benjamin Pasero 已提交
8403 8404
	}

8405 8406
	interface Provider {
		/**
8407
		 * Returns Boolean.
8408 8409
		 */
		spellCheck: (text: string) => void;
B
Benjamin Pasero 已提交
8410 8411
	}

8412 8413 8414 8415 8416 8417 8418 8419 8420 8421 8422 8423 8424 8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435
	interface ReadBookmark {
		title: string;
		url: string;
	}

	interface RedirectRequest {
		url: string;
		method: string;
		session?: Session;
		uploadData?: UploadData;
	}

	interface RegisterBufferProtocolRequest {
		url: string;
		referrer: string;
		method: string;
		uploadData: UploadData[];
	}

	interface RegisterFileProtocolRequest {
		url: string;
		referrer: string;
		method: string;
		uploadData: UploadData[];
B
Benjamin Pasero 已提交
8436 8437
	}

8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449
	interface RegisterHttpProtocolRequest {
		url: string;
		referrer: string;
		method: string;
		uploadData: UploadData[];
	}

	interface RegisterStandardSchemesOptions {
		/**
		 * true to register the scheme as secure. Default false.
		 */
		secure?: boolean;
B
Benjamin Pasero 已提交
8450 8451
	}

8452 8453 8454 8455 8456 8457 8458 8459
	interface RegisterStreamProtocolRequest {
		url: string;
		headers: Headers;
		referrer: string;
		method: string;
		uploadData: UploadData[];
	}

8460 8461 8462 8463 8464 8465 8466 8467 8468 8469 8470
	interface RegisterStringProtocolRequest {
		url: string;
		referrer: string;
		method: string;
		uploadData: UploadData[];
	}

	interface RegisterURLSchemeAsPrivilegedOptions {
		/**
		 * Default true.
		 */
J
Joao Moreno 已提交
8471
		secure?: boolean;
8472 8473 8474
		/**
		 * Default true.
		 */
J
Joao Moreno 已提交
8475
		bypassCSP?: boolean;
8476 8477 8478
		/**
		 * Default true.
		 */
J
Joao Moreno 已提交
8479
		allowServiceWorkers?: boolean;
8480 8481 8482
		/**
		 * Default true.
		 */
J
Joao Moreno 已提交
8483
		supportFetchAPI?: boolean;
8484 8485 8486
		/**
		 * Default true.
		 */
J
Joao Moreno 已提交
8487 8488 8489
		corsEnabled?: boolean;
	}

8490 8491 8492 8493
	interface RelaunchOptions {
		args?: string[];
		execPath?: string;
	}
B
Benjamin Pasero 已提交
8494

8495 8496 8497 8498 8499
	interface Request {
		method: string;
		url: string;
		referrer: string;
	}
B
Benjamin Pasero 已提交
8500

8501
	interface ResizeOptions {
B
Benjamin Pasero 已提交
8502
		/**
8503
		 * Defaults to the image's width.
B
Benjamin Pasero 已提交
8504
		 */
8505
		width?: number;
B
Benjamin Pasero 已提交
8506
		/**
8507
		 * Defaults to the image's height.
B
Benjamin Pasero 已提交
8508
		 */
8509
		height?: number;
B
Benjamin Pasero 已提交
8510
		/**
8511 8512 8513 8514 8515
		 * The desired quality of the resize image. Possible values are good, better or
		 * best. The default is best. These values express a desired quality/speed
		 * tradeoff. They are translated into an algorithm-specific method that depends on
		 * the capabilities (CPU, GPU) of the underlying platform. It is possible for all
		 * three methods to be mapped to the same algorithm on a given platform.
B
Benjamin Pasero 已提交
8516
		 */
8517 8518 8519 8520 8521
		quality?: string;
	}

	interface ResourceUsage {
		images: MemoryUsageDetails;
8522
		scripts: MemoryUsageDetails;
8523 8524 8525 8526 8527 8528 8529 8530
		cssStyleSheets: MemoryUsageDetails;
		xslStyleSheets: MemoryUsageDetails;
		fonts: MemoryUsageDetails;
		other: MemoryUsageDetails;
	}

	interface Response {
		cancel?: boolean;
B
Benjamin Pasero 已提交
8531
		/**
8532 8533
		 * The original request is prevented from being sent or completed and is instead
		 * redirected to the given URL.
B
Benjamin Pasero 已提交
8534
		 */
8535 8536 8537 8538 8539
		redirectURL?: string;
	}

	interface Result {
		requestId: number;
B
Benjamin Pasero 已提交
8540
		/**
8541
		 * Position of the active match.
B
Benjamin Pasero 已提交
8542
		 */
8543
		activeMatchOrdinal: number;
B
Benjamin Pasero 已提交
8544
		/**
8545
		 * Number of Matches.
B
Benjamin Pasero 已提交
8546
		 */
8547
		matches: number;
B
Benjamin Pasero 已提交
8548
		/**
8549
		 * Coordinates of first match region.
B
Benjamin Pasero 已提交
8550
		 */
8551 8552 8553 8554 8555 8556
		selectionArea: SelectionArea;
		finalUpdate: boolean;
	}

	interface SaveDialogOptions {
		title?: string;
B
Benjamin Pasero 已提交
8557
		/**
B
Benjamin Pasero 已提交
8558
		 * Absolute directory path, absolute file path, or file name to use by default.
B
Benjamin Pasero 已提交
8559
		 */
8560
		defaultPath?: string;
B
Benjamin Pasero 已提交
8561
		/**
8562 8563
		 * Custom label for the confirmation button, when left empty the default label will
		 * be used.
B
Benjamin Pasero 已提交
8564
		 */
8565 8566
		buttonLabel?: string;
		filters?: FileFilter[];
B
Benjamin Pasero 已提交
8567
		/**
8568
		 * Message to display above text fields.
B
Benjamin Pasero 已提交
8569
		 */
8570
		message?: string;
B
Benjamin Pasero 已提交
8571
		/**
8572
		 * Custom label for the text displayed in front of the filename text field.
B
Benjamin Pasero 已提交
8573
		 */
8574
		nameFieldLabel?: string;
J
Joao Moreno 已提交
8575
		/**
8576
		 * Show the tags input box, defaults to true.
J
Joao Moreno 已提交
8577
		 */
8578
		showsTagField?: boolean;
8579 8580 8581 8582 8583
		/**
		 * Create a when packaged for the Mac App Store. If this option is enabled and the
		 * file doesn't already exist a blank file will be created at the chosen path.
		 */
		securityScopedBookmarks?: boolean;
8584 8585 8586
	}

	interface Settings {
B
Benjamin Pasero 已提交
8587
		/**
8588 8589
		 * true to open the app at login, false to remove the app as a login item. Defaults
		 * to false.
B
Benjamin Pasero 已提交
8590
		 */
8591
		openAtLogin?: boolean;
B
Benjamin Pasero 已提交
8592
		/**
8593 8594
		 * true to open the app as hidden. Defaults to false. The user can edit this
		 * setting from the System Preferences so
8595
		 * app.getLoginItemSettings().wasOpenedAsHidden should be checked when the app is
8596
		 * opened to know the current value. This setting is not available on .
B
Benjamin Pasero 已提交
8597
		 */
8598
		openAsHidden?: boolean;
8599
		/**
B
Benjamin Pasero 已提交
8600
		 * The executable to launch at login. Defaults to process.execPath.
8601
		 */
B
Benjamin Pasero 已提交
8602
		path?: string;
B
Benjamin Pasero 已提交
8603
		/**
B
Benjamin Pasero 已提交
8604 8605
		 * The command-line arguments to pass to the executable. Defaults to an empty
		 * array. Take care to wrap paths in quotes.
B
Benjamin Pasero 已提交
8606
		 */
B
Benjamin Pasero 已提交
8607
		args?: string[];
8608 8609 8610
	}

	interface SourcesOptions {
B
Benjamin Pasero 已提交
8611
		/**
8612 8613
		 * An array of Strings that lists the types of desktop sources to be captured,
		 * available types are screen and window.
B
Benjamin Pasero 已提交
8614
		 */
8615
		types: string[];
B
Benjamin Pasero 已提交
8616
		/**
8617 8618
		 * The size that the media source thumbnail should be scaled to. Default is 150 x
		 * 150.
B
Benjamin Pasero 已提交
8619
		 */
8620 8621 8622 8623 8624 8625 8626 8627 8628
		thumbnailSize?: Size;
	}

	interface StartMonitoringOptions {
		categoryFilter: string;
		traceOptions: string;
	}

	interface SystemMemoryInfo {
B
Benjamin Pasero 已提交
8629
		/**
8630
		 * The total amount of physical memory in Kilobytes available to the system.
B
Benjamin Pasero 已提交
8631
		 */
8632
		total: number;
B
Benjamin Pasero 已提交
8633
		/**
8634
		 * The total amount of memory not being used by applications or disk cache.
B
Benjamin Pasero 已提交
8635
		 */
8636
		free: number;
B
Benjamin Pasero 已提交
8637
		/**
8638
		 * The total amount of swap memory in Kilobytes available to the system.
B
Benjamin Pasero 已提交
8639
		 */
8640
		swapTotal: number;
B
Benjamin Pasero 已提交
8641
		/**
8642
		 * The free amount of swap memory in Kilobytes available to the system.
B
Benjamin Pasero 已提交
8643
		 */
8644 8645 8646 8647
		swapFree: number;
	}

	interface ToBitmapOptions {
B
Benjamin Pasero 已提交
8648
		/**
8649
		 * Defaults to 1.0.
B
Benjamin Pasero 已提交
8650
		 */
8651 8652 8653 8654
		scaleFactor?: number;
	}

	interface ToDataURLOptions {
B
Benjamin Pasero 已提交
8655
		/**
8656
		 * Defaults to 1.0.
B
Benjamin Pasero 已提交
8657
		 */
8658 8659 8660 8661
		scaleFactor?: number;
	}

	interface ToPNGOptions {
B
Benjamin Pasero 已提交
8662
		/**
8663
		 * Defaults to 1.0.
B
Benjamin Pasero 已提交
8664
		 */
8665 8666 8667 8668
		scaleFactor?: number;
	}

	interface TouchBarButtonConstructorOptions {
B
Benjamin Pasero 已提交
8669
		/**
8670
		 * Button text.
B
Benjamin Pasero 已提交
8671
		 */
8672
		label?: string;
B
Benjamin Pasero 已提交
8673
		/**
8674
		 * Button background color in hex format, i.e #ABCDEF.
B
Benjamin Pasero 已提交
8675
		 */
8676
		backgroundColor?: string;
B
Benjamin Pasero 已提交
8677
		/**
8678
		 * Button icon.
B
Benjamin Pasero 已提交
8679
		 */
8680
		icon?: NativeImage;
8681
		/**
8682
		 * Can be left, right or overlay.
8683
		 */
8684
		iconPosition?: ('left' | 'right' | 'overlay');
B
Benjamin Pasero 已提交
8685
		/**
8686
		 * Function to call when the button is clicked.
B
Benjamin Pasero 已提交
8687
		 */
8688 8689 8690 8691
		click?: () => void;
	}

	interface TouchBarColorPickerConstructorOptions {
B
Benjamin Pasero 已提交
8692
		/**
8693
		 * Array of hex color strings to appear as possible colors to select.
B
Benjamin Pasero 已提交
8694
		 */
8695
		availableColors?: string[];
B
Benjamin Pasero 已提交
8696
		/**
8697
		 * The selected hex color in the picker, i.e #ABCDEF.
B
Benjamin Pasero 已提交
8698
		 */
8699
		selectedColor?: string;
B
Benjamin Pasero 已提交
8700
		/**
8701
		 * Function to call when a color is selected.
B
Benjamin Pasero 已提交
8702
		 */
8703 8704 8705
		change?: (color: string) => void;
	}

B
Benjamin Pasero 已提交
8706
	interface TouchBarConstructorOptions {
8707 8708
		items: Array<TouchBarButton | TouchBarColorPicker | TouchBarGroup | TouchBarLabel | TouchBarPopover | TouchBarScrubber | TouchBarSegmentedControl | TouchBarSlider | TouchBarSpacer>;
		escapeItem?: TouchBarButton | TouchBarColorPicker | TouchBarGroup | TouchBarLabel | TouchBarPopover | TouchBarScrubber | TouchBarSegmentedControl | TouchBarSlider | TouchBarSpacer | null;
B
Benjamin Pasero 已提交
8709 8710
	}

8711
	interface TouchBarGroupConstructorOptions {
B
Benjamin Pasero 已提交
8712
		/**
8713
		 * Items to display as a group.
B
Benjamin Pasero 已提交
8714
		 */
8715 8716 8717 8718
		items: TouchBar;
	}

	interface TouchBarLabelConstructorOptions {
B
Benjamin Pasero 已提交
8719
		/**
8720
		 * Text to display.
B
Benjamin Pasero 已提交
8721
		 */
8722
		label?: string;
B
Benjamin Pasero 已提交
8723
		/**
8724
		 * Hex color of text, i.e #ABCDEF.
B
Benjamin Pasero 已提交
8725
		 */
8726 8727 8728 8729
		textColor?: string;
	}

	interface TouchBarPopoverConstructorOptions {
B
Benjamin Pasero 已提交
8730
		/**
8731
		 * Popover button text.
B
Benjamin Pasero 已提交
8732
		 */
8733
		label?: string;
B
Benjamin Pasero 已提交
8734
		/**
8735
		 * Popover button icon.
B
Benjamin Pasero 已提交
8736
		 */
8737
		icon?: NativeImage;
B
Benjamin Pasero 已提交
8738
		/**
8739
		 * Items to display in the popover.
B
Benjamin Pasero 已提交
8740
		 */
8741
		items?: TouchBar;
B
Benjamin Pasero 已提交
8742
		/**
8743 8744
		 * true to display a close button on the left of the popover, false to not show it.
		 * Default is true.
B
Benjamin Pasero 已提交
8745
		 */
8746 8747
		showCloseButton?: boolean;
	}
J
Joao Moreno 已提交
8748

8749
	interface TouchBarScrubberConstructorOptions {
B
Benjamin Pasero 已提交
8750
		/**
8751
		 * An array of items to place in this scrubber.
B
Benjamin Pasero 已提交
8752
		 */
8753
		items: ScrubberItem[];
B
Benjamin Pasero 已提交
8754
		/**
8755
		 * Called when the user taps an item that was not the last tapped item.
8756 8757
		 */
		select: (selectedIndex: number) => void;
B
Benjamin Pasero 已提交
8758
		/**
8759
		 * Called when the user taps any item.
B
Benjamin Pasero 已提交
8760
		 */
8761
		highlight: (highlightedIndex: number) => void;
B
Benjamin Pasero 已提交
8762
		/**
8763
		 * Selected item style. Defaults to null.
B
Benjamin Pasero 已提交
8764
		 */
8765
		selectedStyle: string;
B
Benjamin Pasero 已提交
8766
		/**
8767
		 * Selected overlay item style. Defaults to null.
B
Benjamin Pasero 已提交
8768
		 */
8769
		overlayStyle: string;
B
Benjamin Pasero 已提交
8770
		/**
8771
		 * Defaults to false.
B
Benjamin Pasero 已提交
8772
		 */
8773
		showArrowButtons: boolean;
B
Benjamin Pasero 已提交
8774
		/**
8775
		 * Defaults to free.
B
Benjamin Pasero 已提交
8776
		 */
8777 8778 8779 8780 8781 8782 8783 8784
		mode: string;
		/**
		 * Defaults to true.
		 */
		continuous: boolean;
	}

	interface TouchBarSegmentedControlConstructorOptions {
B
Benjamin Pasero 已提交
8785
		/**
8786
		 * Style of the segments:
B
Benjamin Pasero 已提交
8787
		 */
8788
		segmentStyle?: ('automatic' | 'rounded' | 'textured-rounded' | 'round-rect' | 'textured-square' | 'capsule' | 'small-square' | 'separated');
B
Benjamin Pasero 已提交
8789
		/**
8790
		 * The selection mode of the control:
B
Benjamin Pasero 已提交
8791
		 */
8792
		mode?: ('single' | 'multiple' | 'buttons');
B
Benjamin Pasero 已提交
8793
		/**
8794
		 * An array of segments to place in this control.
B
Benjamin Pasero 已提交
8795
		 */
8796
		segments: SegmentedControlSegment[];
B
Benjamin Pasero 已提交
8797
		/**
8798 8799
		 * The index of the currently selected segment, will update automatically with user
		 * interaction. When the mode is multiple it will be the last selected item.
B
Benjamin Pasero 已提交
8800
		 */
8801
		selectedIndex?: number;
B
Benjamin Pasero 已提交
8802
		/**
8803
		 * Called when the user selects a new segment.
B
Benjamin Pasero 已提交
8804
		 */
8805 8806 8807 8808
		change: (selectedIndex: number, isSelected: boolean) => void;
	}

	interface TouchBarSliderConstructorOptions {
B
Benjamin Pasero 已提交
8809
		/**
8810
		 * Label text.
B
Benjamin Pasero 已提交
8811
		 */
8812
		label?: string;
B
Benjamin Pasero 已提交
8813
		/**
8814
		 * Selected value.
B
Benjamin Pasero 已提交
8815
		 */
8816
		value?: number;
B
Benjamin Pasero 已提交
8817
		/**
8818
		 * Minimum value.
B
Benjamin Pasero 已提交
8819
		 */
8820
		minValue?: number;
B
Benjamin Pasero 已提交
8821
		/**
8822
		 * Maximum value.
B
Benjamin Pasero 已提交
8823
		 */
8824
		maxValue?: number;
B
Benjamin Pasero 已提交
8825
		/**
8826
		 * Function to call when the slider is changed.
B
Benjamin Pasero 已提交
8827
		 */
8828 8829 8830 8831
		change?: (newValue: number) => void;
	}

	interface TouchBarSpacerConstructorOptions {
B
Benjamin Pasero 已提交
8832
		/**
8833
		 * Size of spacer, possible values are:
B
Benjamin Pasero 已提交
8834
		 */
8835 8836 8837 8838 8839 8840 8841
		size?: ('small' | 'large' | 'flexible');
	}

	interface UpdateTargetUrlEvent extends Event {
		url: string;
	}

8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 8856 8857 8858 8859 8860 8861 8862
	interface UploadProgress {
		/**
		 * Whether the request is currently active. If this is false no other properties
		 * will be set
		 */
		active: boolean;
		/**
		 * Whether the upload has started. If this is false both current and total will be
		 * set to 0.
		 */
		started: boolean;
		/**
		 * The number of bytes that have been uploaded so far
		 */
		current: number;
		/**
		 * The number of bytes that will be uploaded this request
		 */
		total: number;
	}

8863
	interface Versions {
B
Benjamin Pasero 已提交
8864
		/**
8865
		 * A String representing Chrome's version string.
B
Benjamin Pasero 已提交
8866
		 */
8867
		chrome?: string;
B
Benjamin Pasero 已提交
8868
		/**
B
Benjamin Pasero 已提交
8869
		 * A String representing Electron's version string.
B
Benjamin Pasero 已提交
8870
		 */
B
Benjamin Pasero 已提交
8871
		electron?: string;
8872 8873 8874 8875 8876 8877 8878
	}

	interface WillNavigateEvent extends Event {
		url: string;
	}

	interface EditFlags {
B
Benjamin Pasero 已提交
8879
		/**
8880
		 * Whether the renderer believes it can undo.
B
Benjamin Pasero 已提交
8881
		 */
8882
		canUndo: boolean;
B
Benjamin Pasero 已提交
8883
		/**
8884
		 * Whether the renderer believes it can redo.
B
Benjamin Pasero 已提交
8885
		 */
8886
		canRedo: boolean;
B
Benjamin Pasero 已提交
8887
		/**
8888
		 * Whether the renderer believes it can cut.
B
Benjamin Pasero 已提交
8889
		 */
8890
		canCut: boolean;
B
Benjamin Pasero 已提交
8891
		/**
8892
		 * Whether the renderer believes it can copy
B
Benjamin Pasero 已提交
8893
		 */
8894
		canCopy: boolean;
B
Benjamin Pasero 已提交
8895
		/**
8896
		 * Whether the renderer believes it can paste.
B
Benjamin Pasero 已提交
8897
		 */
8898
		canPaste: boolean;
B
Benjamin Pasero 已提交
8899
		/**
8900
		 * Whether the renderer believes it can delete.
B
Benjamin Pasero 已提交
8901
		 */
8902
		canDelete: boolean;
B
Benjamin Pasero 已提交
8903
		/**
8904
		 * Whether the renderer believes it can select all.
B
Benjamin Pasero 已提交
8905
		 */
8906 8907 8908 8909 8910 8911 8912 8913
		canSelectAll: boolean;
	}

	interface Extra {
	}

	interface FoundInPageResult {
		requestId: number;
B
Benjamin Pasero 已提交
8914
		/**
8915
		 * Position of the active match.
B
Benjamin Pasero 已提交
8916
		 */
8917
		activeMatchOrdinal: number;
B
Benjamin Pasero 已提交
8918
		/**
8919
		 * Number of Matches.
B
Benjamin Pasero 已提交
8920
		 */
8921
		matches: number;
B
Benjamin Pasero 已提交
8922
		/**
8923
		 * Coordinates of first match region.
B
Benjamin Pasero 已提交
8924
		 */
8925 8926 8927 8928 8929
		selectionArea: SelectionArea;
		finalUpdate: boolean;
	}

	interface MediaFlags {
B
Benjamin Pasero 已提交
8930
		/**
8931
		 * Whether the media element has crashed.
B
Benjamin Pasero 已提交
8932
		 */
8933
		inError: boolean;
B
Benjamin Pasero 已提交
8934
		/**
8935
		 * Whether the media element is paused.
B
Benjamin Pasero 已提交
8936
		 */
8937
		isPaused: boolean;
B
Benjamin Pasero 已提交
8938
		/**
8939
		 * Whether the media element is muted.
B
Benjamin Pasero 已提交
8940
		 */
8941
		isMuted: boolean;
B
Benjamin Pasero 已提交
8942
		/**
8943
		 * Whether the media element has audio.
B
Benjamin Pasero 已提交
8944
		 */
8945
		hasAudio: boolean;
B
Benjamin Pasero 已提交
8946
		/**
8947
		 * Whether the media element is looping.
B
Benjamin Pasero 已提交
8948
		 */
8949
		isLooping: boolean;
B
Benjamin Pasero 已提交
8950
		/**
8951
		 * Whether the media element's controls are visible.
B
Benjamin Pasero 已提交
8952
		 */
8953
		isControlsVisible: boolean;
B
Benjamin Pasero 已提交
8954
		/**
8955
		 * Whether the media element's controls are toggleable.
B
Benjamin Pasero 已提交
8956
		 */
8957
		canToggleControls: boolean;
B
Benjamin Pasero 已提交
8958
		/**
8959
		 * Whether the media element can be rotated.
B
Benjamin Pasero 已提交
8960
		 */
8961 8962 8963 8964 8965 8966 8967 8968 8969 8970 8971 8972 8973 8974 8975 8976
		canRotate: boolean;
	}

	interface Options {
	}

	interface RequestHeaders {
	}

	interface ResponseHeaders {
	}

	interface SelectionArea {
	}

	interface WebPreferences {
B
Benjamin Pasero 已提交
8977
		/**
8978 8979
		 * Whether to enable DevTools. If it is set to false, can not use
		 * BrowserWindow.webContents.openDevTools() to open DevTools. Default is true.
B
Benjamin Pasero 已提交
8980
		 */
8981
		devTools?: boolean;
B
Benjamin Pasero 已提交
8982
		/**
8983
		 * Whether node integration is enabled. Default is true.
B
Benjamin Pasero 已提交
8984
		 */
8985
		nodeIntegration?: boolean;
B
Benjamin Pasero 已提交
8986
		/**
8987 8988
		 * Whether node integration is enabled in web workers. Default is false. More about
		 * this can be found in .
B
Benjamin Pasero 已提交
8989
		 */
8990
		nodeIntegrationInWorker?: boolean;
B
Benjamin Pasero 已提交
8991
		/**
8992 8993 8994 8995 8996
		 * Specifies a script that will be loaded before other scripts run in the page.
		 * This script will always have access to node APIs no matter whether node
		 * integration is turned on or off. The value should be the absolute file path to
		 * the script. When node integration is turned off, the preload script can
		 * reintroduce Node global symbols back to the global scope. See example .
B
Benjamin Pasero 已提交
8997
		 */
8998
		preload?: string;
B
Benjamin Pasero 已提交
8999
		/**
9000 9001 9002 9003 9004
		 * If set, this will sandbox the renderer associated with the window, making it
		 * compatible with the Chromium OS-level sandbox and disabling the Node.js engine.
		 * This is not the same as the nodeIntegration option and the APIs available to the
		 * preload script are more limited. Read more about the option . This option is
		 * currently experimental and may change or be removed in future Electron releases.
B
Benjamin Pasero 已提交
9005
		 */
9006
		sandbox?: boolean;
B
Benjamin Pasero 已提交
9007
		/**
9008 9009 9010 9011
		 * Sets the session used by the page. Instead of passing the Session object
		 * directly, you can also choose to use the partition option instead, which accepts
		 * a partition string. When both session and partition are provided, session will
		 * be preferred. Default is the default session.
B
Benjamin Pasero 已提交
9012
		 */
9013
		session?: Session;
B
Benjamin Pasero 已提交
9014
		/**
9015 9016 9017 9018 9019 9020
		 * Sets the session used by the page according to the session's partition string.
		 * If partition starts with persist:, the page will use a persistent session
		 * available to all pages in the app with the same partition. If there is no
		 * persist: prefix, the page will use an in-memory session. By assigning the same
		 * partition, multiple pages can share the same session. Default is the default
		 * session.
B
Benjamin Pasero 已提交
9021
		 */
9022
		partition?: string;
9023 9024 9025 9026 9027 9028 9029 9030 9031
		/**
		 * When specified, web pages with the same affinity will run in the same renderer
		 * process. Note that due to reusing the renderer process, certain webPreferences
		 * options will also be shared between the web pages even when you specified
		 * different values for them, including but not limited to preload, sandbox and
		 * nodeIntegration. So it is suggested to use exact same webPreferences for web
		 * pages with the same affinity.
		 */
		affinity?: string;
B
Benjamin Pasero 已提交
9032
		/**
9033
		 * The default zoom factor of the page, 3.0 represents 300%. Default is 1.0.
B
Benjamin Pasero 已提交
9034
		 */
9035
		zoomFactor?: number;
B
Benjamin Pasero 已提交
9036
		/**
9037
		 * Enables JavaScript support. Default is true.
B
Benjamin Pasero 已提交
9038
		 */
9039
		javascript?: boolean;
B
Benjamin Pasero 已提交
9040
		/**
9041 9042 9043
		 * When false, it will disable the same-origin policy (usually using testing
		 * websites by people), and set allowRunningInsecureContent to true if this options
		 * has not been set by user. Default is true.
B
Benjamin Pasero 已提交
9044
		 */
9045
		// webSecurity?: boolean; ### VSCODE CHANGE (https://github.com/electron/electron/blob/master/docs/tutorial/security.md) ###
B
Benjamin Pasero 已提交
9046
		/**
9047 9048
		 * Allow an https page to run JavaScript, CSS or plugins from http URLs. Default is
		 * false.
B
Benjamin Pasero 已提交
9049
		 */
9050
		// allowRunningInsecureContent?: boolean; ### VSCODE CHANGE (https://github.com/electron/electron/blob/master/docs/tutorial/security.md) ###
B
Benjamin Pasero 已提交
9051
		/**
9052
		 * Enables image support. Default is true.
B
Benjamin Pasero 已提交
9053
		 */
9054
		images?: boolean;
B
Benjamin Pasero 已提交
9055
		/**
9056
		 * Make TextArea elements resizable. Default is true.
B
Benjamin Pasero 已提交
9057
		 */
9058
		textAreasAreResizable?: boolean;
B
Benjamin Pasero 已提交
9059
		/**
9060
		 * Enables WebGL support. Default is true.
B
Benjamin Pasero 已提交
9061
		 */
9062
		webgl?: boolean;
B
Benjamin Pasero 已提交
9063
		/**
9064
		 * Enables WebAudio support. Default is true.
B
Benjamin Pasero 已提交
9065
		 */
9066
		webaudio?: boolean;
B
Benjamin Pasero 已提交
9067
		/**
9068
		 * Whether plugins should be enabled. Default is false.
B
Benjamin Pasero 已提交
9069
		 */
9070
		plugins?: boolean;
B
Benjamin Pasero 已提交
9071
		/**
9072
		 * Enables Chromium's experimental features. Default is false.
B
Benjamin Pasero 已提交
9073
		 */
9074
		// experimentalFeatures?: boolean; ### VSCODE CHANGE (https://github.com/electron/electron/blob/master/docs/tutorial/security.md) ###
B
Benjamin Pasero 已提交
9075
		/**
9076
		 * Enables Chromium's experimental canvas features. Default is false.
B
Benjamin Pasero 已提交
9077
		 */
9078
		experimentalCanvasFeatures?: boolean;
B
Benjamin Pasero 已提交
9079
		/**
9080
		 * Enables scroll bounce (rubber banding) effect on macOS. Default is false.
B
Benjamin Pasero 已提交
9081
		 */
9082
		scrollBounce?: boolean;
B
Benjamin Pasero 已提交
9083
		/**
9084 9085
		 * A list of feature strings separated by ,, like CSSVariables,KeyboardEventKey to
		 * enable. The full list of supported feature strings can be found in the file.
B
Benjamin Pasero 已提交
9086
		 */
9087
		enableBlinkFeatures?: string;
B
Benjamin Pasero 已提交
9088
		/**
9089 9090
		 * A list of feature strings separated by ,, like CSSVariables,KeyboardEventKey to
		 * disable. The full list of supported feature strings can be found in the file.
B
Benjamin Pasero 已提交
9091
		 */
9092
		disableBlinkFeatures?: string;
B
Benjamin Pasero 已提交
9093
		/**
9094
		 * Sets the default font for the font-family.
B
Benjamin Pasero 已提交
9095
		 */
9096
		defaultFontFamily?: DefaultFontFamily;
B
Benjamin Pasero 已提交
9097
		/**
9098
		 * Defaults to 16.
B
Benjamin Pasero 已提交
9099
		 */
9100
		defaultFontSize?: number;
B
Benjamin Pasero 已提交
9101
		/**
9102
		 * Defaults to 13.
B
Benjamin Pasero 已提交
9103
		 */
9104
		defaultMonospaceFontSize?: number;
B
Benjamin Pasero 已提交
9105
		/**
9106
		 * Defaults to 0.
B
Benjamin Pasero 已提交
9107
		 */
9108
		minimumFontSize?: number;
B
Benjamin Pasero 已提交
9109
		/**
9110
		 * Defaults to ISO-8859-1.
B
Benjamin Pasero 已提交
9111
		 */
9112
		defaultEncoding?: string;
B
Benjamin Pasero 已提交
9113
		/**
9114
		 * Whether to throttle animations and timers when the page becomes background. This
9115
		 * also affects the . Defaults to true.
B
Benjamin Pasero 已提交
9116
		 */
9117
		backgroundThrottling?: boolean;
B
Benjamin Pasero 已提交
9118
		/**
9119 9120
		 * Whether to enable offscreen rendering for the browser window. Defaults to false.
		 * See the for more details.
B
Benjamin Pasero 已提交
9121
		 */
9122
		offscreen?: boolean;
B
Benjamin Pasero 已提交
9123
		/**
9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138
		 * Whether to run Electron APIs and the specified preload script in a separate
		 * JavaScript context. Defaults to false. The context that the preload script runs
		 * in will still have full access to the document and window globals but it will
		 * use its own set of JavaScript builtins (Array, Object, JSON, etc.) and will be
		 * isolated from any changes made to the global environment by the loaded page. The
		 * Electron API will only be available in the preload script and not the loaded
		 * page. This option should be used when loading potentially untrusted remote
		 * content to ensure the loaded content cannot tamper with the preload script and
		 * any Electron APIs being used. This option uses the same technique used by . You
		 * can access this context in the dev tools by selecting the 'Electron Isolated
		 * Context' entry in the combo box at the top of the Console tab. This option is
		 * currently experimental and may change or be removed in future Electron releases.
		 */
		contextIsolation?: boolean;
		/**
9139 9140 9141
		 * Whether to use native window.open(). If set to true, the webPreferences of child
		 * window will always be the same with parent window, regardless of the parameters
		 * passed to window.open(). Defaults to false. This option is currently
B
Benjamin Pasero 已提交
9142
		 * experimental.
9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153
		 */
		nativeWindowOpen?: boolean;
		/**
		 * Whether to enable the . Defaults to the value of the nodeIntegration option. The
		 * preload script configured for the <webview> will have node integration enabled
		 * when it is executed so you should ensure remote/untrusted content is not able to
		 * create a <webview> tag with a possibly malicious preload script. You can use the
		 * will-attach-webview event on to strip away the preload script and to validate or
		 * alter the <webview>'s initial settings.
		 */
		webviewTag?: boolean;
9154 9155 9156 9157 9158
		/**
		 * A list of strings that will be appended to process.argv in the renderer process
		 * of this app. Useful for passing small bits of data down to renderer process
		 * preload scripts.
		 */
9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 9169 9170 9171 9172 9173 9174
		additionalArguments?: string[];
		/**
		 * Whether to enable browser style consecutive dialog protection. Default is false.
		 */
		safeDialogs?: boolean;
		/**
		 * The message to display when consecutive dialog protection is triggered. If not
		 * defined the default message would be used, note that currently the default
		 * message is in English and not localized.
		 */
		safeDialogsMessage?: string;
		/**
		 * Whether dragging and dropping a file or link onto the page causes a navigation.
		 * Default is false.
		 */
		navigateOnDragDrop?: boolean;
B
Benjamin Pasero 已提交
9175 9176
	}

9177
	interface DefaultFontFamily {
B
Benjamin Pasero 已提交
9178
		/**
9179
		 * Defaults to Times New Roman.
B
Benjamin Pasero 已提交
9180
		 */
9181
		standard?: string;
B
Benjamin Pasero 已提交
9182
		/**
9183
		 * Defaults to Times New Roman.
B
Benjamin Pasero 已提交
9184
		 */
9185
		serif?: string;
B
Benjamin Pasero 已提交
9186
		/**
9187
		 * Defaults to Arial.
B
Benjamin Pasero 已提交
9188
		 */
9189
		sansSerif?: string;
B
Benjamin Pasero 已提交
9190
		/**
9191
		 * Defaults to Courier New.
B
Benjamin Pasero 已提交
9192
		 */
9193
		monospace?: string;
B
Benjamin Pasero 已提交
9194
		/**
9195
		 * Defaults to Script.
B
Benjamin Pasero 已提交
9196
		 */
9197
		cursive?: string;
B
Benjamin Pasero 已提交
9198
		/**
9199
		 * Defaults to Impact.
B
Benjamin Pasero 已提交
9200
		 */
9201
		fantasy?: string;
B
Benjamin Pasero 已提交
9202
	}
9203

B
Benjamin Pasero 已提交
9204 9205
}

9206
declare module 'electron' {
B
Benjamin Pasero 已提交
9207
	export = Electron;
B
Benjamin Pasero 已提交
9208 9209
}

B
Benjamin Pasero 已提交
9210
interface NodeRequireFunction {
B
Benjamin Pasero 已提交
9211
	(moduleName: 'electron'): typeof Electron;
B
Benjamin Pasero 已提交
9212
}
B
Benjamin Pasero 已提交
9213 9214 9215

interface File {
	/**
9216
	 * The real path to the file on the users filesystem
B
Benjamin Pasero 已提交
9217 9218 9219 9220
	 */
	path: string;
}

B
Benjamin Pasero 已提交
9221 9222 9223 9224
declare module 'original-fs' {
	import * as fs from 'fs';
	export = fs;
}
9225 9226 9227 9228

interface Document {
	createElement(tagName: 'webview'): Electron.WebviewTag;
}
B
Benjamin Pasero 已提交
9229 9230

declare namespace NodeJS {
9231
	interface Process extends EventEmitter {
B
Benjamin Pasero 已提交
9232

9233
		// Docs: http://electron.atom.io/docs/api/process
B
Benjamin Pasero 已提交
9234

9235
		// ### BEGIN VSCODE MODIFICATION ###
9236 9237 9238 9239 9240 9241 9242 9243 9244 9245
		// /**
		//  * Emitted when Electron has loaded its internal initialization script and is
		//  * beginning to load the web page or the main script. It can be used by the preload
		//  * script to add removed Node global symbols back to the global scope when node
		//  * integration is turned off:
		//  */
		// on(event: 'loaded', listener: Function): this;
		// once(event: 'loaded', listener: Function): this;
		// addListener(event: 'loaded', listener: Function): this;
		// removeListener(event: 'loaded', listener: Function): this;
9246 9247
		// ### END VSCODE MODIFICATION ###

B
Benjamin Pasero 已提交
9248
		/**
9249
		 * Causes the main thread of the current process crash.
B
Benjamin Pasero 已提交
9250
		 */
9251 9252
		crash(): void;
		getCPUUsage(): Electron.CPUUsage;
9253 9254 9255 9256 9257
		/**
		 * Returns an object with V8 heap statistics. Note that all statistics are reported
		 * in Kilobytes.
		 */
		getHeapStatistics(): Electron.HeapStatistics;
9258
		getIOCounters(): Electron.IOCounters;
B
Benjamin Pasero 已提交
9259
		/**
9260 9261
		 * Returns an object giving memory usage statistics about the current process. Note
		 * that all statistics are reported in Kilobytes.
B
Benjamin Pasero 已提交
9262
		 */
9263
		getProcessMemoryInfo(): Electron.ProcessMemoryInfo;
B
Benjamin Pasero 已提交
9264
		/**
9265 9266
		 * Returns an object giving memory usage statistics about the entire system. Note
		 * that all statistics are reported in Kilobytes.
B
Benjamin Pasero 已提交
9267
		 */
9268
		getSystemMemoryInfo(): Electron.SystemMemoryInfo;
B
Benjamin Pasero 已提交
9269 9270 9271 9272 9273 9274 9275 9276 9277 9278
		/**
		 * Causes the main thread of the current process hang.
		 */
		hang(): void;
		/**
		 * Sets the file descriptor soft limit to maxDescriptors or the OS hard limit,
		 * whichever is lower for the current process.
		 */
		setFdLimit(maxDescriptors: number): void;
		/**
9279 9280
		 * A Boolean. When app is started by being passed as parameter to the default app,
		 * this property is true in the main process, otherwise it is undefined.
B
Benjamin Pasero 已提交
9281
		 */
9282
		defaultApp?: boolean;
B
Benjamin Pasero 已提交
9283
		/**
9284 9285
		 * A Boolean. For Mac App Store build, this property is true, for other builds it
		 * is undefined.
B
Benjamin Pasero 已提交
9286
		 */
9287
		mas?: boolean;
B
Benjamin Pasero 已提交
9288
		/**
9289 9290
		 * A Boolean that controls ASAR support inside your application. Setting this to
		 * true will disable the support for asar archives in Node's built-in modules.
B
Benjamin Pasero 已提交
9291
		 */
9292
		noAsar?: boolean;
B
Benjamin Pasero 已提交
9293
		/**
B
Benjamin Pasero 已提交
9294
		 * A Boolean that controls whether or not deprecation warnings are printed to
9295 9296
		 * stderr. Setting this to true will silence deprecation warnings. This property is
		 * used instead of the --no-deprecation command line flag.
B
Benjamin Pasero 已提交
9297
		 */
B
Benjamin Pasero 已提交
9298
		noDeprecation?: boolean;
B
Benjamin Pasero 已提交
9299
		/**
9300
		 * A String representing the path to the resources directory.
B
Benjamin Pasero 已提交
9301
		 */
9302
		resourcesPath?: string;
B
Benjamin Pasero 已提交
9303
		/**
B
Benjamin Pasero 已提交
9304
		 * A Boolean that controls whether or not deprecation warnings will be thrown as
9305
		 * exceptions. Setting this to true will throw errors for deprecations. This
B
Benjamin Pasero 已提交
9306
		 * property is used instead of the --throw-deprecation command line flag.
B
Benjamin Pasero 已提交
9307
		 */
B
Benjamin Pasero 已提交
9308
		throwDeprecation?: boolean;
B
Benjamin Pasero 已提交
9309
		/**
B
Benjamin Pasero 已提交
9310
		 * A Boolean that controls whether or not deprecations printed to stderr include
9311
		 * their stack trace. Setting this to true will print stack traces for
B
Benjamin Pasero 已提交
9312 9313
		 * deprecations. This property is instead of the --trace-deprecation command line
		 * flag.
B
Benjamin Pasero 已提交
9314
		 */
B
Benjamin Pasero 已提交
9315
		traceDeprecation?: boolean;
B
Benjamin Pasero 已提交
9316
		/**
B
Benjamin Pasero 已提交
9317
		 * A Boolean that controls whether or not process warnings printed to stderr
9318 9319
		 * include their stack trace. Setting this to true will print stack traces for
		 * process warnings (including deprecations). This property is instead of the
B
Benjamin Pasero 已提交
9320
		 * --trace-warnings command line flag.
B
Benjamin Pasero 已提交
9321
		 */
B
Benjamin Pasero 已提交
9322
		traceProcessWarnings?: boolean;
B
Benjamin Pasero 已提交
9323
		/**
9324 9325
		 * A String representing the current process's type, can be "browser" (i.e. main
		 * process) or "renderer".
B
Benjamin Pasero 已提交
9326
		 */
9327
		type?: string;
B
Benjamin Pasero 已提交
9328
		/**
9329 9330
		 * A Boolean. If the app is running as a Windows Store app (appx), this property is
		 * true, for otherwise it is undefined.
B
Benjamin Pasero 已提交
9331
		 */
9332
		windowsStore?: boolean;
B
Benjamin Pasero 已提交
9333
	}
9334 9335 9336
	interface ProcessVersions {
		electron: string;
		chrome: string;
B
Benjamin Pasero 已提交
9337
	}
9338
}