@overwolf/ow-electron 37.2.6-beta.2 → 37.7.0-beta.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/checksums.json +10 -10
- package/electron-api.json +538 -328
- package/electron.d.ts +112 -5
- package/ow-electron.d.ts +2 -2
- package/package.json +3 -3
package/electron-api.json
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
"description": "> Control your application's event lifecycle.\n\nProcess: Main\n\nThe following example shows how to quit the application when the last window is closed:",
|
|
5
5
|
"slug": "app",
|
|
6
6
|
"websiteUrl": "https://electronjs.org/docs/api/app",
|
|
7
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
8
|
-
"version": "37.
|
|
7
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/app.md",
|
|
8
|
+
"version": "37.7.0",
|
|
9
9
|
"type": "Module",
|
|
10
10
|
"process": {
|
|
11
11
|
"main": true,
|
|
@@ -223,6 +223,10 @@
|
|
|
223
223
|
"value": "appData",
|
|
224
224
|
"description": "user application data directory, which by default points to:"
|
|
225
225
|
},
|
|
226
|
+
{
|
|
227
|
+
"value": "assets",
|
|
228
|
+
"description": ""
|
|
229
|
+
},
|
|
226
230
|
{
|
|
227
231
|
"value": "userData",
|
|
228
232
|
"description": ""
|
|
@@ -503,6 +507,22 @@
|
|
|
503
507
|
],
|
|
504
508
|
"urlFragment": "#appclearrecentdocuments-macos-windows"
|
|
505
509
|
},
|
|
510
|
+
{
|
|
511
|
+
"name": "getRecentDocuments",
|
|
512
|
+
"signature": "()",
|
|
513
|
+
"description": "An array containing documents in the most recent documents list.",
|
|
514
|
+
"parameters": [],
|
|
515
|
+
"returns": {
|
|
516
|
+
"collection": true,
|
|
517
|
+
"type": "String",
|
|
518
|
+
"possibleValues": null
|
|
519
|
+
},
|
|
520
|
+
"additionalTags": [
|
|
521
|
+
"os_macos",
|
|
522
|
+
"os_windows"
|
|
523
|
+
],
|
|
524
|
+
"urlFragment": "#appgetrecentdocuments-macos-windows"
|
|
525
|
+
},
|
|
506
526
|
{
|
|
507
527
|
"name": "setAsDefaultProtocolClient",
|
|
508
528
|
"signature": "(protocol[, path, args])",
|
|
@@ -3203,8 +3223,8 @@
|
|
|
3203
3223
|
"description": "> Enable apps to automatically update themselves.\n\nProcess: Main\n\n**See also: A detailed guide about how to implement updates in your application.**\n\n`autoUpdater` is an EventEmitter.\n\n### Platform Notices\n\nCurrently, only macOS and Windows are supported. There is no built-in support for auto-updater on Linux, so it is recommended to use the distribution's package manager to update your app.\n\nIn addition, there are some subtle differences on each platform:\n\n### macOS\n\nOn macOS, the `autoUpdater` module is built upon Squirrel.Mac, meaning you don't need any special setup to make it work. For server-side requirements, you can read Server Support. Note that App Transport Security (ATS) applies to all requests made as part of the update process. Apps that need to disable ATS can add the `NSAllowsArbitraryLoads` key to their app's plist.\n\n> [!IMPORTANT] Your application must be signed for automatic updates on macOS. This is a requirement of `Squirrel.Mac`.\n\n### Windows\n\nOn Windows, you have to install your app into a user's machine before you can use the `autoUpdater`, so it is recommended that you use electron-winstaller or Electron Forge's Squirrel.Windows maker to generate a Windows installer.\n\nApps built with Squirrel.Windows will trigger custom launch events that must be handled by your Electron application to ensure proper setup and teardown.\n\nSquirrel.Windows apps will launch with the `--squirrel-firstrun` argument immediately after installation. During this time, Squirrel.Windows will obtain a file lock on your app, and `autoUpdater` requests will fail until the lock is released. In practice, this means that you won't be able to check for updates on first launch for the first few seconds. You can work around this by not checking for updates when `process.argv` contains the `--squirrel-firstrun` flag or by setting a 10-second timeout on your update checks (see electron/electron#7155 for more information).\n\nThe installer generated with Squirrel.Windows will create a shortcut icon with an Application User Model ID in the format of `com.squirrel.PACKAGE_ID.YOUR_EXE_WITHOUT_DOT_EXE`, examples are `com.squirrel.slack.Slack` and `com.squirrel.code.Code`. You have to use the same ID for your app with `app.setAppUserModelId` API, otherwise Windows will not be able to pin your app properly in task bar.",
|
|
3204
3224
|
"slug": "auto-updater",
|
|
3205
3225
|
"websiteUrl": "https://electronjs.org/docs/api/auto-updater",
|
|
3206
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
3207
|
-
"version": "37.
|
|
3226
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/auto-updater.md",
|
|
3227
|
+
"version": "37.7.0",
|
|
3208
3228
|
"type": "Module",
|
|
3209
3229
|
"process": {
|
|
3210
3230
|
"main": true,
|
|
@@ -3420,8 +3440,8 @@
|
|
|
3420
3440
|
"description": "> Create and control windows.\n\nProcess: Main\n\n> [!NOTE] `BaseWindow` provides a flexible way to compose multiple web views in a single window. For windows with only a single, full-size web view, the `BrowserWindow` class may be a simpler option.\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Parent and child windows\n\nBy using `parent` option, you can create child windows:\n\n```\nconst { BaseWindow } = require('electron')\n\nconst parent = new BaseWindow()\nconst child = new BaseWindow({ parent })\n```\n\nThe `child` window will always show on top of the `parent` window.\n\n### Modal windows\n\nA modal window is a child window that disables parent window. To create a modal window, you have to set both the `parent` and `modal` options:\n\n```\nconst { BaseWindow } = require('electron')\n\nconst parent = new BaseWindow()\nconst child = new BaseWindow({ parent, modal: true })\n```\n\n### Platform notices\n\n* On macOS modal windows will be displayed as sheets attached to the parent window.\n* On macOS the child windows will keep the relative position to parent window when parent window moves, while on Windows and Linux child windows will not move.\n* On Linux the type of modal windows will be changed to `dialog`.\n* On Linux many desktop environments do not support hiding a modal window.\n\n### Resource management\n\nWhen you add a `WebContentsView` to a `BaseWindow` and the `BaseWindow` is closed, the `webContents` of the `WebContentsView` are not destroyed automatically.\n\nIt is your responsibility to close the `webContents` when you no longer need them, e.g. when the `BaseWindow` is closed:\n\n```\nconst { BaseWindow, WebContentsView } = require('electron')\n\nconst win = new BaseWindow({ width: 800, height: 600 })\n\nconst view = new WebContentsView()\nwin.contentView.addChildView(view)\n\nwin.on('closed', () => {\n view.webContents.close()\n})\n```\n\nUnlike with a `BrowserWindow`, if you don't explicitly close the `webContents`, you'll encounter memory leaks.\n\n### Class: BaseWindow\n\n> Create and control windows.\n\nProcess: Main\n\n`BaseWindow` is an EventEmitter.\n\nIt creates a new `BaseWindow` with native properties as set by the `options`.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
3421
3441
|
"slug": "base-window",
|
|
3422
3442
|
"websiteUrl": "https://electronjs.org/docs/api/base-window",
|
|
3423
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
3424
|
-
"version": "37.
|
|
3443
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/base-window.md",
|
|
3444
|
+
"version": "37.7.0",
|
|
3425
3445
|
"type": "Class",
|
|
3426
3446
|
"process": {
|
|
3427
3447
|
"main": true,
|
|
@@ -5222,6 +5242,59 @@
|
|
|
5222
5242
|
],
|
|
5223
5243
|
"urlFragment": "#winsetappdetailsoptions-windows"
|
|
5224
5244
|
},
|
|
5245
|
+
{
|
|
5246
|
+
"name": "setAccentColor",
|
|
5247
|
+
"signature": "(accentColor)",
|
|
5248
|
+
"description": "Sets the system accent color and highlighting of active window border.\n\nThe `accentColor` parameter accepts the following values:\n\n* **Color string** - Sets a custom accent color using standard CSS color formats (Hex, RGB, RGBA, HSL, HSLA, or named colors). Alpha values in RGBA/HSLA formats are ignored and the color is treated as fully opaque.\n* **`true`** - Uses the system's default accent color from user preferences in System Settings.\n* **`false`** - Explicitly disables accent color highlighting for the window.\n\nExamples:",
|
|
5249
|
+
"parameters": [
|
|
5250
|
+
{
|
|
5251
|
+
"name": "accentColor",
|
|
5252
|
+
"description": "The accent color for the window. By default, follows user preference in System Settings.",
|
|
5253
|
+
"required": true,
|
|
5254
|
+
"collection": false,
|
|
5255
|
+
"type": [
|
|
5256
|
+
{
|
|
5257
|
+
"collection": false,
|
|
5258
|
+
"type": "boolean"
|
|
5259
|
+
},
|
|
5260
|
+
{
|
|
5261
|
+
"collection": false,
|
|
5262
|
+
"type": "String",
|
|
5263
|
+
"possibleValues": null
|
|
5264
|
+
}
|
|
5265
|
+
]
|
|
5266
|
+
}
|
|
5267
|
+
],
|
|
5268
|
+
"returns": null,
|
|
5269
|
+
"additionalTags": [
|
|
5270
|
+
"os_windows"
|
|
5271
|
+
],
|
|
5272
|
+
"urlFragment": "#winsetaccentcoloraccentcolor-windows"
|
|
5273
|
+
},
|
|
5274
|
+
{
|
|
5275
|
+
"name": "getAccentColor",
|
|
5276
|
+
"signature": "()",
|
|
5277
|
+
"description": "the system accent color and highlighting of active window border in Hex RGB format.\n\nIf a color has been set for the window that differs from the system accent color, the window accent color will be returned. Otherwise, a boolean will be returned, with `true` indicating that the window uses the global system accent color, and `false` indicating that accent color highlighting is disabled for this window.",
|
|
5278
|
+
"parameters": [],
|
|
5279
|
+
"returns": {
|
|
5280
|
+
"collection": false,
|
|
5281
|
+
"type": [
|
|
5282
|
+
{
|
|
5283
|
+
"collection": false,
|
|
5284
|
+
"type": "String",
|
|
5285
|
+
"possibleValues": null
|
|
5286
|
+
},
|
|
5287
|
+
{
|
|
5288
|
+
"collection": false,
|
|
5289
|
+
"type": "boolean"
|
|
5290
|
+
}
|
|
5291
|
+
]
|
|
5292
|
+
},
|
|
5293
|
+
"additionalTags": [
|
|
5294
|
+
"os_windows"
|
|
5295
|
+
],
|
|
5296
|
+
"urlFragment": "#wingetaccentcolor-windows"
|
|
5297
|
+
},
|
|
5225
5298
|
{
|
|
5226
5299
|
"name": "setIcon",
|
|
5227
5300
|
"signature": "(icon)",
|
|
@@ -6646,8 +6719,8 @@
|
|
|
6646
6719
|
"description": "> [!NOTE] The `BrowserView` class is deprecated, and replaced by the new `WebContentsView` class.\n\nA `BrowserView` can be used to embed additional web content into a `BrowserWindow`. It is like a child window, except that it is positioned relative to its owning window. It is meant to be an alternative to the `webview` tag.\n\n### Class: BrowserView\n\n> Create and control views.\n\n> [!NOTE] The `BrowserView` class is deprecated, and replaced by the new `WebContentsView` class.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.\n\n### Example\n\n```\n// In the main process.\nconst { app, BrowserView, BrowserWindow } = require('electron')\n\napp.whenReady().then(() => {\n const win = new BrowserWindow({ width: 800, height: 600 })\n\n const view = new BrowserView()\n win.setBrowserView(view)\n view.setBounds({ x: 0, y: 0, width: 300, height: 300 })\n view.webContents.loadURL('https://electronjs.org')\n})\n```",
|
|
6647
6720
|
"slug": "browser-view",
|
|
6648
6721
|
"websiteUrl": "https://electronjs.org/docs/api/browser-view",
|
|
6649
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
6650
|
-
"version": "37.
|
|
6722
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/browser-view.md",
|
|
6723
|
+
"version": "37.7.0",
|
|
6651
6724
|
"type": "Class",
|
|
6652
6725
|
"process": {
|
|
6653
6726
|
"main": true,
|
|
@@ -6814,8 +6887,8 @@
|
|
|
6814
6887
|
"description": "> Create and control browser windows.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Window customization\n\nThe `BrowserWindow` class exposes various ways to modify the look and behavior of your app's windows. For more details, see the Window Customization tutorial.\n\n### Showing the window gracefully\n\nWhen loading a page in the window directly, users may see the page load incrementally, which is not a good experience for a native app. To make the window display without a visual flash, there are two solutions for different situations.\n\n### Using the `ready-to-show` event\n\nWhile loading the page, the `ready-to-show` event will be emitted when the renderer process has rendered the page for the first time if the window has not been shown yet. Showing the window after this event will have no visual flash:\n\n```\nconst { BrowserWindow } = require('electron')\nconst win = new BrowserWindow({ show: false })\nwin.once('ready-to-show', () => {\n win.show()\n})\n```\n\nThis event is usually emitted after the `did-finish-load` event, but for pages with many remote resources, it may be emitted before the `did-finish-load` event.\n\nPlease note that using this event implies that the renderer will be considered \"visible\" and paint even though `show` is false. This event will never fire if you use `paintWhenInitiallyHidden: false`\n\n### Setting the `backgroundColor` property\n\nFor a complex app, the `ready-to-show` event could be emitted too late, making the app feel slow. In this case, it is recommended to show the window immediately, and use a `backgroundColor` close to your app's background:\n\n```\nconst { BrowserWindow } = require('electron')\n\nconst win = new BrowserWindow({ backgroundColor: '#2e2c29' })\nwin.loadURL('https://github.com')\n```\n\nNote that even for apps that use `ready-to-show` event, it is still recommended to set `backgroundColor` to make the app feel more native.\n\nSome examples of valid `backgroundColor` values include:\n\n```\nconst win = new BrowserWindow()\nwin.setBackgroundColor('hsl(230, 100%, 50%)')\nwin.setBackgroundColor('rgb(255, 145, 145)')\nwin.setBackgroundColor('#ff00a3')\nwin.setBackgroundColor('blueviolet')\n```\n\nFor more information about these color types see valid options in win.setBackgroundColor.\n\n### Parent and child windows\n\nBy using `parent` option, you can create child windows:\n\n```\nconst { BrowserWindow } = require('electron')\n\nconst top = new BrowserWindow()\nconst child = new BrowserWindow({ parent: top })\nchild.show()\ntop.show()\n```\n\nThe `child` window will always show on top of the `top` window.\n\n### Modal windows\n\nA modal window is a child window that disables parent window. To create a modal window, you have to set both the `parent` and `modal` options:\n\n```\nconst { BrowserWindow } = require('electron')\n\nconst top = new BrowserWindow()\nconst child = new BrowserWindow({ parent: top, modal: true, show: false })\nchild.loadURL('https://github.com')\nchild.once('ready-to-show', () => {\n child.show()\n})\n```\n\n### Page visibility\n\nThe Page Visibility API works as follows:\n\n* On all platforms, the visibility state tracks whether the window is hidden/minimized or not.\n* Additionally, on macOS, the visibility state also tracks the window occlusion state. If the window is occluded (i.e. fully covered) by another window, the visibility state will be `hidden`. On other platforms, the visibility state will be `hidden` only when the window is minimized or explicitly hidden with `win.hide()`.\n* If a `BrowserWindow` is created with `show: false`, the initial visibility state will be `visible` despite the window actually being hidden.\n* If `backgroundThrottling` is disabled, the visibility state will remain `visible` even if the window is minimized, occluded, or hidden.\n\nIt is recommended that you pause expensive operations when the visibility state is `hidden` in order to minimize power consumption.\n\n### Platform notices\n\n* On macOS modal windows will be displayed as sheets attached to the parent window.\n* On macOS the child windows will keep the relative position to parent window when parent window moves, while on Windows and Linux child windows will not move.\n* On Linux the type of modal windows will be changed to `dialog`.\n* On Linux many desktop environments do not support hiding a modal window.\n\n### Class: BrowserWindow extends `BaseWindow`\n\n> Create and control browser windows.\n\nProcess: Main\n\n`BrowserWindow` is an EventEmitter.\n\nIt creates a new `BrowserWindow` with native properties as set by the `options`.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
6815
6888
|
"slug": "browser-window",
|
|
6816
6889
|
"websiteUrl": "https://electronjs.org/docs/api/browser-window",
|
|
6817
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
6818
|
-
"version": "37.
|
|
6890
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/browser-window.md",
|
|
6891
|
+
"version": "37.7.0",
|
|
6819
6892
|
"type": "Class",
|
|
6820
6893
|
"process": {
|
|
6821
6894
|
"main": true,
|
|
@@ -8897,6 +8970,59 @@
|
|
|
8897
8970
|
],
|
|
8898
8971
|
"urlFragment": "#winsetappdetailsoptions-windows"
|
|
8899
8972
|
},
|
|
8973
|
+
{
|
|
8974
|
+
"name": "setAccentColor",
|
|
8975
|
+
"signature": "(accentColor)",
|
|
8976
|
+
"description": "Sets the system accent color and highlighting of active window border.\n\nThe `accentColor` parameter accepts the following values:\n\n* **Color string** - Sets a custom accent color using standard CSS color formats (Hex, RGB, RGBA, HSL, HSLA, or named colors). Alpha values in RGBA/HSLA formats are ignored and the color is treated as fully opaque.\n* **`true`** - Uses the system's default accent color from user preferences in System Settings.\n* **`false`** - Explicitly disables accent color highlighting for the window.\n\nExamples:",
|
|
8977
|
+
"parameters": [
|
|
8978
|
+
{
|
|
8979
|
+
"name": "accentColor",
|
|
8980
|
+
"description": "The accent color for the window. By default, follows user preference in System Settings.",
|
|
8981
|
+
"required": true,
|
|
8982
|
+
"collection": false,
|
|
8983
|
+
"type": [
|
|
8984
|
+
{
|
|
8985
|
+
"collection": false,
|
|
8986
|
+
"type": "boolean"
|
|
8987
|
+
},
|
|
8988
|
+
{
|
|
8989
|
+
"collection": false,
|
|
8990
|
+
"type": "String",
|
|
8991
|
+
"possibleValues": null
|
|
8992
|
+
}
|
|
8993
|
+
]
|
|
8994
|
+
}
|
|
8995
|
+
],
|
|
8996
|
+
"returns": null,
|
|
8997
|
+
"additionalTags": [
|
|
8998
|
+
"os_windows"
|
|
8999
|
+
],
|
|
9000
|
+
"urlFragment": "#winsetaccentcoloraccentcolor-windows"
|
|
9001
|
+
},
|
|
9002
|
+
{
|
|
9003
|
+
"name": "getAccentColor",
|
|
9004
|
+
"signature": "()",
|
|
9005
|
+
"description": "the system accent color and highlighting of active window border in Hex RGB format.\n\nIf a color has been set for the window that differs from the system accent color, the window accent color will be returned. Otherwise, a boolean will be returned, with `true` indicating that the window uses the global system accent color, and `false` indicating that accent color highlighting is disabled for this window.",
|
|
9006
|
+
"parameters": [],
|
|
9007
|
+
"returns": {
|
|
9008
|
+
"collection": false,
|
|
9009
|
+
"type": [
|
|
9010
|
+
{
|
|
9011
|
+
"collection": false,
|
|
9012
|
+
"type": "String",
|
|
9013
|
+
"possibleValues": null
|
|
9014
|
+
},
|
|
9015
|
+
{
|
|
9016
|
+
"collection": false,
|
|
9017
|
+
"type": "boolean"
|
|
9018
|
+
}
|
|
9019
|
+
]
|
|
9020
|
+
},
|
|
9021
|
+
"additionalTags": [
|
|
9022
|
+
"os_windows"
|
|
9023
|
+
],
|
|
9024
|
+
"urlFragment": "#wingetaccentcolor-windows"
|
|
9025
|
+
},
|
|
8900
9026
|
{
|
|
8901
9027
|
"name": "showDefinitionForSelection",
|
|
8902
9028
|
"signature": "()",
|
|
@@ -10529,8 +10655,8 @@
|
|
|
10529
10655
|
"description": "> Make HTTP/HTTPS requests.\n\nProcess: Main, Utility\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._\n\n`ClientRequest` implements the Writable Stream interface and is therefore an EventEmitter.",
|
|
10530
10656
|
"slug": "client-request",
|
|
10531
10657
|
"websiteUrl": "https://electronjs.org/docs/api/client-request",
|
|
10532
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
10533
|
-
"version": "37.
|
|
10658
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/client-request.md",
|
|
10659
|
+
"version": "37.7.0",
|
|
10534
10660
|
"type": "Class",
|
|
10535
10661
|
"process": {
|
|
10536
10662
|
"main": true,
|
|
@@ -11303,8 +11429,8 @@
|
|
|
11303
11429
|
"description": "> Perform copy and paste operations on the system clipboard.\n\nProcess: Main, Renderer (non-sandboxed only)\n\nOn Linux, there is also a `selection` clipboard. To manipulate it you need to pass `selection` to each method:",
|
|
11304
11430
|
"slug": "clipboard",
|
|
11305
11431
|
"websiteUrl": "https://electronjs.org/docs/api/clipboard",
|
|
11306
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
11307
|
-
"version": "37.
|
|
11432
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/clipboard.md",
|
|
11433
|
+
"version": "37.7.0",
|
|
11308
11434
|
"type": "Module",
|
|
11309
11435
|
"process": {
|
|
11310
11436
|
"main": true,
|
|
@@ -11970,8 +12096,8 @@
|
|
|
11970
12096
|
"description": "",
|
|
11971
12097
|
"slug": "command-line",
|
|
11972
12098
|
"websiteUrl": "https://electronjs.org/docs/api/command-line",
|
|
11973
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
11974
|
-
"version": "37.
|
|
12099
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/command-line.md",
|
|
12100
|
+
"version": "37.7.0",
|
|
11975
12101
|
"type": "Class",
|
|
11976
12102
|
"process": {
|
|
11977
12103
|
"main": true,
|
|
@@ -12098,8 +12224,8 @@
|
|
|
12098
12224
|
"description": "> Collect tracing data from Chromium to find performance bottlenecks and slow operations.\n\nProcess: Main\n\nThis module does not include a web interface. To view recorded traces, use trace viewer, available at `chrome://tracing` in Chrome.\n\n> [!NOTE] You should not use this module until the `ready` event of the app module is emitted.",
|
|
12099
12225
|
"slug": "content-tracing",
|
|
12100
12226
|
"websiteUrl": "https://electronjs.org/docs/api/content-tracing",
|
|
12101
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
12102
|
-
"version": "37.
|
|
12227
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/content-tracing.md",
|
|
12228
|
+
"version": "37.7.0",
|
|
12103
12229
|
"type": "Module",
|
|
12104
12230
|
"process": {
|
|
12105
12231
|
"main": true,
|
|
@@ -12236,8 +12362,8 @@
|
|
|
12236
12362
|
"description": "> Create a safe, bi-directional, synchronous bridge across isolated contexts\n\nProcess: Renderer\n\nAn example of exposing an API to a renderer from an isolated preload script is given below:\n\n```\n// Preload (Isolated World)\nconst { contextBridge, ipcRenderer } = require('electron')\n\ncontextBridge.exposeInMainWorld(\n 'electron',\n {\n doThing: () => ipcRenderer.send('do-a-thing')\n }\n)\n```\n\n### Glossary\n\n\n\n### Main World\n\nThe \"Main World\" is the JavaScript context that your main renderer code runs in. By default, the page you load in your renderer executes code in this world.\n\n### Isolated World\n\nWhen `contextIsolation` is enabled in your `webPreferences` (this is the default behavior since Electron 12.0.0), your `preload` scripts run in an \"Isolated World\". You can read more about context isolation and what it affects in the security docs.",
|
|
12237
12363
|
"slug": "context-bridge",
|
|
12238
12364
|
"websiteUrl": "https://electronjs.org/docs/api/context-bridge",
|
|
12239
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
12240
|
-
"version": "37.
|
|
12365
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/context-bridge.md",
|
|
12366
|
+
"version": "37.7.0",
|
|
12241
12367
|
"type": "Module",
|
|
12242
12368
|
"process": {
|
|
12243
12369
|
"main": false,
|
|
@@ -12353,8 +12479,8 @@
|
|
|
12353
12479
|
"description": "",
|
|
12354
12480
|
"slug": "cookies",
|
|
12355
12481
|
"websiteUrl": "https://electronjs.org/docs/api/cookies",
|
|
12356
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
12357
|
-
"version": "37.
|
|
12482
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/cookies.md",
|
|
12483
|
+
"version": "37.7.0",
|
|
12358
12484
|
"type": "Class",
|
|
12359
12485
|
"process": {
|
|
12360
12486
|
"main": true,
|
|
@@ -12703,8 +12829,8 @@
|
|
|
12703
12829
|
"description": "> Submit crash reports to a remote server.\n\nProcess: Main, Renderer\n\nThe following is an example of setting up Electron to automatically submit crash reports to a remote server:\n\n```\nconst { crashReporter } = require('electron')\n\ncrashReporter.start({ submitURL: 'https://your-domain.com/url-to-submit' })\n```\n\nFor setting up a server to accept and process crash reports, you can use following projects:\n\n* socorro\n* mini-breakpad-server\n\n> [!NOTE] Electron uses Crashpad, not Breakpad, to collect and upload crashes, but for the time being, the upload protocol is the same.\n\nOr use a 3rd party hosted solution:\n\n* Backtrace\n* Sentry\n* BugSplat\n* Bugsnag\n\nCrash reports are stored temporarily before being uploaded in a directory underneath the app's user data directory, called 'Crashpad'. You can override this directory by calling `app.setPath('crashDumps', '/path/to/crashes')` before starting the crash reporter.\n\nElectron uses crashpad to monitor and report crashes.",
|
|
12704
12830
|
"slug": "crash-reporter",
|
|
12705
12831
|
"websiteUrl": "https://electronjs.org/docs/api/crash-reporter",
|
|
12706
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
12707
|
-
"version": "37.
|
|
12832
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/crash-reporter.md",
|
|
12833
|
+
"version": "37.7.0",
|
|
12708
12834
|
"type": "Module",
|
|
12709
12835
|
"process": {
|
|
12710
12836
|
"main": true,
|
|
@@ -12976,8 +13102,8 @@
|
|
|
12976
13102
|
"description": "",
|
|
12977
13103
|
"slug": "debugger",
|
|
12978
13104
|
"websiteUrl": "https://electronjs.org/docs/api/debugger",
|
|
12979
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
12980
|
-
"version": "37.
|
|
13105
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/debugger.md",
|
|
13106
|
+
"version": "37.7.0",
|
|
12981
13107
|
"type": "Class",
|
|
12982
13108
|
"process": {
|
|
12983
13109
|
"main": true,
|
|
@@ -13148,8 +13274,8 @@
|
|
|
13148
13274
|
"description": "> Access information about media sources that can be used to capture audio and video from the desktop using the `navigator.mediaDevices.getUserMedia` API.\n\nProcess: Main\n\nThe following example shows how to capture video from a desktop window whose title is `Electron`:\n\n```\n// main.js\nconst { app, BrowserWindow, desktopCapturer, session } = require('electron')\n\napp.whenReady().then(() => {\n const mainWindow = new BrowserWindow()\n\n session.defaultSession.setDisplayMediaRequestHandler((request, callback) => {\n desktopCapturer.getSources({ types: ['screen'] }).then((sources) => {\n // Grant access to the first screen found.\n callback({ video: sources[0], audio: 'loopback' })\n })\n // If true, use the system picker if available.\n // Note: this is currently experimental. If the system picker\n // is available, it will be used and the media request handler\n // will not be invoked.\n }, { useSystemPicker: true })\n\n mainWindow.loadFile('index.html')\n})\n```\n\n```\n// renderer.js\nconst startButton = document.getElementById('startButton')\nconst stopButton = document.getElementById('stopButton')\nconst video = document.querySelector('video')\n\nstartButton.addEventListener('click', () => {\n navigator.mediaDevices.getDisplayMedia({\n audio: true,\n video: {\n width: 320,\n height: 240,\n frameRate: 30\n }\n }).then(stream => {\n video.srcObject = stream\n video.onloadedmetadata = (e) => video.play()\n }).catch(e => console.log(e))\n})\n\nstopButton.addEventListener('click', () => {\n video.pause()\n})\n```\n\n```\n<!-- index.html -->\n<html>\n<meta http-equiv=\"content-security-policy\" content=\"script-src 'self' 'unsafe-inline'\" />\n <body>\n <button id=\"startButton\" class=\"button\">Start</button>\n <button id=\"stopButton\" class=\"button\">Stop</button>\n <video width=\"320\" height=\"240\" autoplay></video>\n <script src=\"renderer.js\"></script>\n </body>\n</html>\n```\n\nSee `navigator.mediaDevices.getDisplayMedia` for more information.\n\n> [!NOTE] `navigator.mediaDevices.getDisplayMedia` does not permit the use of `deviceId` for selection of a source - see specification.",
|
|
13149
13275
|
"slug": "desktop-capturer",
|
|
13150
13276
|
"websiteUrl": "https://electronjs.org/docs/api/desktop-capturer",
|
|
13151
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
13152
|
-
"version": "37.
|
|
13277
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/desktop-capturer.md",
|
|
13278
|
+
"version": "37.7.0",
|
|
13153
13279
|
"type": "Module",
|
|
13154
13280
|
"process": {
|
|
13155
13281
|
"main": true,
|
|
@@ -13230,8 +13356,8 @@
|
|
|
13230
13356
|
"description": "> Display native system dialogs for opening and saving files, alerting, etc.\n\nProcess: Main\n\nAn example of showing a dialog to select multiple files:",
|
|
13231
13357
|
"slug": "dialog",
|
|
13232
13358
|
"websiteUrl": "https://electronjs.org/docs/api/dialog",
|
|
13233
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
13234
|
-
"version": "37.
|
|
13359
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/dialog.md",
|
|
13360
|
+
"version": "37.7.0",
|
|
13235
13361
|
"type": "Module",
|
|
13236
13362
|
"process": {
|
|
13237
13363
|
"main": true,
|
|
@@ -14313,8 +14439,8 @@
|
|
|
14313
14439
|
"description": "",
|
|
14314
14440
|
"slug": "dock",
|
|
14315
14441
|
"websiteUrl": "https://electronjs.org/docs/api/dock",
|
|
14316
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
14317
|
-
"version": "37.
|
|
14442
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/dock.md",
|
|
14443
|
+
"version": "37.7.0",
|
|
14318
14444
|
"type": "Class",
|
|
14319
14445
|
"process": {
|
|
14320
14446
|
"main": true,
|
|
@@ -14558,8 +14684,8 @@
|
|
|
14558
14684
|
"description": "",
|
|
14559
14685
|
"slug": "download-item",
|
|
14560
14686
|
"websiteUrl": "https://electronjs.org/docs/api/download-item",
|
|
14561
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
14562
|
-
"version": "37.
|
|
14687
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/download-item.md",
|
|
14688
|
+
"version": "37.7.0",
|
|
14563
14689
|
"type": "Class",
|
|
14564
14690
|
"process": {
|
|
14565
14691
|
"main": true,
|
|
@@ -14981,8 +15107,8 @@
|
|
|
14981
15107
|
"description": "",
|
|
14982
15108
|
"slug": "extensions-api",
|
|
14983
15109
|
"websiteUrl": "https://electronjs.org/docs/api/extensions-api",
|
|
14984
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
14985
|
-
"version": "37.
|
|
15110
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/extensions-api.md",
|
|
15111
|
+
"version": "37.7.0",
|
|
14986
15112
|
"type": "Class",
|
|
14987
15113
|
"process": {
|
|
14988
15114
|
"main": true,
|
|
@@ -15181,8 +15307,8 @@
|
|
|
15181
15307
|
"description": "> Detect keyboard events when the application does not have keyboard focus.\n\nProcess: Main\n\nThe `globalShortcut` module can register/unregister a global keyboard shortcut with the operating system so that you can customize the operations for various shortcuts.\n\n> [!NOTE] The shortcut is global; it will work even if the app does not have the keyboard focus. This module cannot be used before the `ready` event of the app module is emitted. Please also note that it is also possible to use Chromium's `GlobalShortcutsPortal` implementation, which allows apps to bind global shortcuts when running within a Wayland session.",
|
|
15182
15308
|
"slug": "global-shortcut",
|
|
15183
15309
|
"websiteUrl": "https://electronjs.org/docs/api/global-shortcut",
|
|
15184
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15185
|
-
"version": "37.
|
|
15310
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/global-shortcut.md",
|
|
15311
|
+
"version": "37.7.0",
|
|
15186
15312
|
"type": "Module",
|
|
15187
15313
|
"process": {
|
|
15188
15314
|
"main": true,
|
|
@@ -15303,8 +15429,8 @@
|
|
|
15303
15429
|
"description": "> A View that displays an image.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\nUseful for showing splash screens that will be swapped for `WebContentsView`s when the content finishes loading.\n\nNote that `ImageView` is experimental and may be changed or removed in the future.\n\n### Class: ImageView extends `View`\n\n> A View that displays an image.\n\nProcess: Main\n\n`ImageView` inherits from `View`.\n\n`ImageView` is an EventEmitter.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
15304
15430
|
"slug": "image-view",
|
|
15305
15431
|
"websiteUrl": "https://electronjs.org/docs/api/image-view",
|
|
15306
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15307
|
-
"version": "37.
|
|
15432
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/image-view.md",
|
|
15433
|
+
"version": "37.7.0",
|
|
15308
15434
|
"type": "Class",
|
|
15309
15435
|
"process": {
|
|
15310
15436
|
"main": true,
|
|
@@ -15348,8 +15474,8 @@
|
|
|
15348
15474
|
"description": "> In-app purchases on Mac App Store.\n\nProcess: Main",
|
|
15349
15475
|
"slug": "in-app-purchase",
|
|
15350
15476
|
"websiteUrl": "https://electronjs.org/docs/api/in-app-purchase",
|
|
15351
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15352
|
-
"version": "37.
|
|
15477
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/in-app-purchase.md",
|
|
15478
|
+
"version": "37.7.0",
|
|
15353
15479
|
"type": "Module",
|
|
15354
15480
|
"process": {
|
|
15355
15481
|
"main": true,
|
|
@@ -15543,8 +15669,8 @@
|
|
|
15543
15669
|
"description": "",
|
|
15544
15670
|
"slug": "incoming-message",
|
|
15545
15671
|
"websiteUrl": "https://electronjs.org/docs/api/incoming-message",
|
|
15546
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15547
|
-
"version": "37.
|
|
15672
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/incoming-message.md",
|
|
15673
|
+
"version": "37.7.0",
|
|
15548
15674
|
"type": "Class",
|
|
15549
15675
|
"process": {
|
|
15550
15676
|
"main": true,
|
|
@@ -15701,8 +15827,8 @@
|
|
|
15701
15827
|
"description": "",
|
|
15702
15828
|
"slug": "ipc-main-service-worker",
|
|
15703
15829
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-main-service-worker",
|
|
15704
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15705
|
-
"version": "37.
|
|
15830
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/ipc-main-service-worker.md",
|
|
15831
|
+
"version": "37.7.0",
|
|
15706
15832
|
"type": "Class",
|
|
15707
15833
|
"process": {
|
|
15708
15834
|
"main": true,
|
|
@@ -15999,8 +16125,8 @@
|
|
|
15999
16125
|
"description": "\n\n### ipcMain\n\n> Communicate asynchronously from the main process to renderer processes.\n\nProcess: Main\n\nThe `ipcMain` module is an Event Emitter. When used in the main process, it handles asynchronous and synchronous messages sent from a renderer process (web page). Messages sent from a renderer will be emitted to this module.\n\nFor usage examples, check out the IPC tutorial.\n\n### Sending messages\n\nIt is also possible to send messages from the main process to the renderer process, see webContents.send for more information.\n\n* When sending a message, the event name is the `channel`.\n* To reply to a synchronous message, you need to set `event.returnValue`.\n* To send an asynchronous message back to the sender, you can use `event.reply(...)`. This helper method will automatically handle messages coming from frames that aren't the main frame (e.g. iframes) whereas `event.sender.send(...)` will always send to the main frame.",
|
|
16000
16126
|
"slug": "ipc-main",
|
|
16001
16127
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-main",
|
|
16002
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
16003
|
-
"version": "37.
|
|
16128
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/ipc-main.md",
|
|
16129
|
+
"version": "37.7.0",
|
|
16004
16130
|
"type": "Module",
|
|
16005
16131
|
"process": {
|
|
16006
16132
|
"main": true,
|
|
@@ -16378,8 +16504,8 @@
|
|
|
16378
16504
|
"description": "\n\n### ipcRenderer\n\n> Communicate asynchronously from a renderer process to the main process.\n\nProcess: Renderer\n\nThe `ipcRenderer` module is an EventEmitter. It provides a few methods so you can send synchronous and asynchronous messages from the render process (web page) to the main process. You can also receive replies from the main process.\n\nSee IPC tutorial for code examples.",
|
|
16379
16505
|
"slug": "ipc-renderer",
|
|
16380
16506
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-renderer",
|
|
16381
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
16382
|
-
"version": "37.
|
|
16507
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/ipc-renderer.md",
|
|
16508
|
+
"version": "37.7.0",
|
|
16383
16509
|
"type": "Module",
|
|
16384
16510
|
"process": {
|
|
16385
16511
|
"main": false,
|
|
@@ -16767,11 +16893,11 @@
|
|
|
16767
16893
|
},
|
|
16768
16894
|
{
|
|
16769
16895
|
"name": "MenuItem",
|
|
16770
|
-
"description": "> Add items to native application menus and context menus.\n\nProcess: Main\n\nSee `Menu` for examples.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
16896
|
+
"description": "\n\n### Class: MenuItem\n\n> Add items to native application menus and context menus.\n\nProcess: Main\n\nSee `Menu` for examples.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
16771
16897
|
"slug": "menu-item",
|
|
16772
16898
|
"websiteUrl": "https://electronjs.org/docs/api/menu-item",
|
|
16773
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
16774
|
-
"version": "37.
|
|
16899
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/menu-item.md",
|
|
16900
|
+
"version": "37.7.0",
|
|
16775
16901
|
"type": "Class",
|
|
16776
16902
|
"process": {
|
|
16777
16903
|
"main": true,
|
|
@@ -17685,8 +17811,8 @@
|
|
|
17685
17811
|
"description": "\n\n### Class: Menu\n\n> Create native application menus and context menus.\n\nProcess: Main\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
17686
17812
|
"slug": "menu",
|
|
17687
17813
|
"websiteUrl": "https://electronjs.org/docs/api/menu",
|
|
17688
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
17689
|
-
"version": "37.
|
|
17814
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/menu.md",
|
|
17815
|
+
"version": "37.7.0",
|
|
17690
17816
|
"type": "Class",
|
|
17691
17817
|
"process": {
|
|
17692
17818
|
"main": true,
|
|
@@ -18067,8 +18193,8 @@
|
|
|
18067
18193
|
"description": "",
|
|
18068
18194
|
"slug": "message-channel-main",
|
|
18069
18195
|
"websiteUrl": "https://electronjs.org/docs/api/message-channel-main",
|
|
18070
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
18071
|
-
"version": "37.
|
|
18196
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/message-channel-main.md",
|
|
18197
|
+
"version": "37.7.0",
|
|
18072
18198
|
"type": "Class",
|
|
18073
18199
|
"process": {
|
|
18074
18200
|
"main": true,
|
|
@@ -18108,8 +18234,8 @@
|
|
|
18108
18234
|
"description": "",
|
|
18109
18235
|
"slug": "message-port-main",
|
|
18110
18236
|
"websiteUrl": "https://electronjs.org/docs/api/message-port-main",
|
|
18111
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
18112
|
-
"version": "37.
|
|
18237
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/message-port-main.md",
|
|
18238
|
+
"version": "37.7.0",
|
|
18113
18239
|
"type": "Class",
|
|
18114
18240
|
"process": {
|
|
18115
18241
|
"main": true,
|
|
@@ -18215,8 +18341,8 @@
|
|
|
18215
18341
|
"description": "> Create tray, dock, and application icons using PNG or JPG files.\n\nProcess: Main, Renderer\n\nThe `nativeImage` module provides a unified interface for manipulating system images. These can be handy if you want to provide multiple scaled versions of the same icon or take advantage of macOS template images.\n\nElectron APIs that take image files accept either file paths or `NativeImage` instances. An empty and transparent image will be used when `null` is passed.\n\nFor example, when creating a Tray or setting a BrowserWindow's icon, you can either pass an image file path as a string:\n\n```\nconst { BrowserWindow, Tray } = require('electron')\n\nconst tray = new Tray('/Users/somebody/images/icon.png')\nconst win = new BrowserWindow({ icon: '/Users/somebody/images/window.png' })\n```\n\nor generate a `NativeImage` instance from the same file:\n\n### Supported Formats\n\nCurrently, `PNG` and `JPEG` image formats are supported across all platforms. `PNG` is recommended because of its support for transparency and lossless compression.\n\nOn Windows, you can also load `ICO` icons from file paths. For best visual quality, we recommend including at least the following sizes:\n\n* Small icon\n * 16x16 (100% DPI scale)\n * 20x20 (125% DPI scale)\n * 24x24 (150% DPI scale)\n * 32x32 (200% DPI scale)\n* Large icon\n * 32x32 (100% DPI scale)\n * 40x40 (125% DPI scale)\n * 48x48 (150% DPI scale)\n * 64x64 (200% DPI scale)\n * 256x256\n\nCheck the _Icon Scaling_ section in the Windows App Icon Construction reference.\n\n:::note\n\nEXIF metadata is currently not supported and will not be taken into account during image encoding and decoding.\n\n:::\n\n### High Resolution Image\n\nOn platforms that support high pixel density displays (such as Apple Retina), you can append `@2x` after image's base filename to mark it as a 2x scale high resolution image.\n\nFor example, if `icon.png` is a normal image that has standard resolution, then `icon@2x.png` will be treated as a high resolution image that has double Dots per Inch (DPI) density.\n\nIf you want to support displays with different DPI densities at the same time, you can put images with different sizes in the same folder and use the filename without DPI suffixes within Electron. For example:\n\n```\nimages/\n├── icon.png\n├── icon@2x.png\n└── icon@3x.png\n```\n\n```\nconst { Tray } = require('electron')\nconst appTray = new Tray('/Users/somebody/images/icon.png')\n```\n\nThe following suffixes for DPI are also supported:\n\n* `@1x`\n* `@1.25x`\n* `@1.33x`\n* `@1.4x`\n* `@1.5x`\n* `@1.8x`\n* `@2x`\n* `@2.5x`\n* `@3x`\n* `@4x`\n* `@5x`\n\n### Template Image _macOS_\n\nOn macOS, template images consist of black and an alpha channel. Template images are not intended to be used as standalone images and are usually mixed with other content to create the desired final appearance.\n\nThe most common case is to use template images for a menu bar (Tray) icon, so it can adapt to both light and dark menu bars.\n\nTo mark an image as a template image, its base filename should end with the word `Template` (e.g. `xxxTemplate.png`). You can also specify template images at different DPI densities (e.g. `xxxTemplate@2x.png`).",
|
|
18216
18342
|
"slug": "native-image",
|
|
18217
18343
|
"websiteUrl": "https://electronjs.org/docs/api/native-image",
|
|
18218
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
18219
|
-
"version": "37.
|
|
18344
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/native-image.md",
|
|
18345
|
+
"version": "37.7.0",
|
|
18220
18346
|
"type": "Module",
|
|
18221
18347
|
"process": {
|
|
18222
18348
|
"main": true,
|
|
@@ -18462,8 +18588,8 @@
|
|
|
18462
18588
|
"description": "",
|
|
18463
18589
|
"slug": "native-image",
|
|
18464
18590
|
"websiteUrl": "https://electronjs.org/docs/api/native-image",
|
|
18465
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
18466
|
-
"version": "37.
|
|
18591
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/native-image.md",
|
|
18592
|
+
"version": "37.7.0",
|
|
18467
18593
|
"type": "Class",
|
|
18468
18594
|
"process": {
|
|
18469
18595
|
"main": true,
|
|
@@ -18884,8 +19010,8 @@
|
|
|
18884
19010
|
"description": "> Read and respond to changes in Chromium's native color theme.\n\nProcess: Main",
|
|
18885
19011
|
"slug": "native-theme",
|
|
18886
19012
|
"websiteUrl": "https://electronjs.org/docs/api/native-theme",
|
|
18887
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
18888
|
-
"version": "37.
|
|
19013
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/native-theme.md",
|
|
19014
|
+
"version": "37.7.0",
|
|
18889
19015
|
"type": "Module",
|
|
18890
19016
|
"process": {
|
|
18891
19017
|
"main": true,
|
|
@@ -19008,8 +19134,8 @@
|
|
|
19008
19134
|
"description": "",
|
|
19009
19135
|
"slug": "navigation-history",
|
|
19010
19136
|
"websiteUrl": "https://electronjs.org/docs/api/navigation-history",
|
|
19011
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
19012
|
-
"version": "37.
|
|
19137
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/navigation-history.md",
|
|
19138
|
+
"version": "37.7.0",
|
|
19013
19139
|
"type": "Class",
|
|
19014
19140
|
"process": {
|
|
19015
19141
|
"main": true,
|
|
@@ -19256,8 +19382,8 @@
|
|
|
19256
19382
|
"description": "> Logging network events for a session.\n\nProcess: Main\n\n```\nconst { app, netLog } = require('electron')\n\napp.whenReady().then(async () => {\n await netLog.startLogging('/path/to/net-log')\n // After some network events\n const path = await netLog.stopLogging()\n console.log('Net-logs written to', path)\n})\n```\n\nSee `--log-net-log` to log network events throughout the app's lifecycle.\n\n> [!NOTE] All methods unless specified can only be used after the `ready` event of the `app` module gets emitted.",
|
|
19257
19383
|
"slug": "net-log",
|
|
19258
19384
|
"websiteUrl": "https://electronjs.org/docs/api/net-log",
|
|
19259
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
19260
|
-
"version": "37.
|
|
19385
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/net-log.md",
|
|
19386
|
+
"version": "37.7.0",
|
|
19261
19387
|
"type": "Module",
|
|
19262
19388
|
"process": {
|
|
19263
19389
|
"main": true,
|
|
@@ -19372,8 +19498,8 @@
|
|
|
19372
19498
|
"description": "> Issue HTTP/HTTPS requests using Chromium's native networking library\n\nProcess: Main, Utility\n\nThe `net` module is a client-side API for issuing HTTP(S) requests. It is similar to the HTTP and HTTPS modules of Node.js but uses Chromium's native networking library instead of the Node.js implementation, offering better support for web proxies. It also supports checking network status.\n\nThe following is a non-exhaustive list of why you may consider using the `net` module instead of the native Node.js modules:\n\n* Automatic management of system proxy configuration, support of the wpad protocol and proxy pac configuration files.\n* Automatic tunneling of HTTPS requests.\n* Support for authenticating proxies using basic, digest, NTLM, Kerberos or negotiate authentication schemes.\n* Support for traffic monitoring proxies: Fiddler-like proxies used for access control and monitoring.\n\nThe API components (including classes, methods, properties and event names) are similar to those used in Node.js.\n\nExample usage:\n\n```\nconst { app } = require('electron')\napp.whenReady().then(() => {\n const { net } = require('electron')\n const request = net.request('https://github.com')\n request.on('response', (response) => {\n console.log(`STATUS: ${response.statusCode}`)\n console.log(`HEADERS: ${JSON.stringify(response.headers)}`)\n response.on('data', (chunk) => {\n console.log(`BODY: ${chunk}`)\n })\n response.on('end', () => {\n console.log('No more data in response.')\n })\n })\n request.end()\n})\n```\n\nThe `net` API can be used only after the application emits the `ready` event. Trying to use the module before the `ready` event will throw an error.",
|
|
19373
19499
|
"slug": "net",
|
|
19374
19500
|
"websiteUrl": "https://electronjs.org/docs/api/net",
|
|
19375
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
19376
|
-
"version": "37.
|
|
19501
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/net.md",
|
|
19502
|
+
"version": "37.7.0",
|
|
19377
19503
|
"type": "Module",
|
|
19378
19504
|
"process": {
|
|
19379
19505
|
"main": true,
|
|
@@ -19613,8 +19739,8 @@
|
|
|
19613
19739
|
"description": "> Create OS desktop notifications\n\nProcess: Main\n\n> [!NOTE] If you want to show notifications from a renderer process you should use the web Notifications API\n\n### Class: Notification\n\n> Create OS desktop notifications\n\nProcess: Main\n\n`Notification` is an EventEmitter.\n\nIt creates a new `Notification` with native properties as set by the `options`.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.\n\n### Static Methods\n\nThe `Notification` class has the following static methods:\n\n### `Notification.isSupported()`\n\nReturns `boolean` - Whether or not desktop notifications are supported on the current system",
|
|
19614
19740
|
"slug": "notification",
|
|
19615
19741
|
"websiteUrl": "https://electronjs.org/docs/api/notification",
|
|
19616
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
19617
|
-
"version": "37.
|
|
19742
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/notification.md",
|
|
19743
|
+
"version": "37.7.0",
|
|
19618
19744
|
"type": "Class",
|
|
19619
19745
|
"process": {
|
|
19620
19746
|
"main": true,
|
|
@@ -20120,8 +20246,8 @@
|
|
|
20120
20246
|
"description": "> Interface for communication with parent process.\n\nProcess: Utility\n\n`parentPort` is an EventEmitter. _This object is not exported from the `'electron'` module. It is only available as a property of the process object in the Electron API._",
|
|
20121
20247
|
"slug": "parent-port",
|
|
20122
20248
|
"websiteUrl": "https://electronjs.org/docs/api/parent-port",
|
|
20123
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
20124
|
-
"version": "37.
|
|
20249
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/parent-port.md",
|
|
20250
|
+
"version": "37.7.0",
|
|
20125
20251
|
"type": "Module",
|
|
20126
20252
|
"process": {
|
|
20127
20253
|
"main": false,
|
|
@@ -20192,8 +20318,8 @@
|
|
|
20192
20318
|
"description": "> Monitor power state changes.\n\nProcess: Main",
|
|
20193
20319
|
"slug": "power-monitor",
|
|
20194
20320
|
"websiteUrl": "https://electronjs.org/docs/api/power-monitor",
|
|
20195
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
20196
|
-
"version": "37.
|
|
20321
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/power-monitor.md",
|
|
20322
|
+
"version": "37.7.0",
|
|
20197
20323
|
"type": "Module",
|
|
20198
20324
|
"process": {
|
|
20199
20325
|
"main": true,
|
|
@@ -20481,8 +20607,8 @@
|
|
|
20481
20607
|
"description": "> Block the system from entering low-power (sleep) mode.\n\nProcess: Main\n\nFor example:",
|
|
20482
20608
|
"slug": "power-save-blocker",
|
|
20483
20609
|
"websiteUrl": "https://electronjs.org/docs/api/power-save-blocker",
|
|
20484
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
20485
|
-
"version": "37.
|
|
20610
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/power-save-blocker.md",
|
|
20611
|
+
"version": "37.7.0",
|
|
20486
20612
|
"type": "Module",
|
|
20487
20613
|
"process": {
|
|
20488
20614
|
"main": true,
|
|
@@ -20571,8 +20697,8 @@
|
|
|
20571
20697
|
"description": "> Extensions to process object.\n\nProcess: Main, Renderer\n\nElectron's `process` object is extended from the Node.js `process` object. It adds the following events, properties, and methods:\n\n### Sandbox\n\nIn sandboxed renderers the `process` object contains only a subset of the APIs:\n\n* `crash()`\n* `hang()`\n* `getCreationTime()`\n* `getHeapStatistics()`\n* `getBlinkMemoryInfo()`\n* `getProcessMemoryInfo()`\n* `getSystemMemoryInfo()`\n* `getSystemVersion()`\n* `getCPUUsage()`\n* `uptime()`\n* `argv`\n* `execPath`\n* `env`\n* `pid`\n* `arch`\n* `platform`\n* `sandboxed`\n* `contextIsolated`\n* `type`\n* `version`\n* `versions`\n* `mas`\n* `windowsStore`\n* `contextId`",
|
|
20572
20698
|
"slug": "process",
|
|
20573
20699
|
"websiteUrl": "https://electronjs.org/docs/api/process",
|
|
20574
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
20575
|
-
"version": "37.
|
|
20700
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/process.md",
|
|
20701
|
+
"version": "37.7.0",
|
|
20576
20702
|
"type": "Module",
|
|
20577
20703
|
"process": {
|
|
20578
20704
|
"main": true,
|
|
@@ -20760,7 +20886,7 @@
|
|
|
20760
20886
|
{
|
|
20761
20887
|
"name": "getSystemMemoryInfo",
|
|
20762
20888
|
"signature": "()",
|
|
20763
|
-
"description": "* `total` Integer - The total amount of physical memory in Kilobytes available to the system.\n* `free` Integer - The total amount of memory not being used by applications or disk cache.\n* `swapTotal` Integer _Windows_ _Linux_ - The total amount of swap memory in Kilobytes available to the system.\n* `swapFree` Integer _Windows_ _Linux_ - The free amount of swap memory in Kilobytes available to the system.\n\nReturns an object giving memory usage statistics about the entire system. Note that all statistics are reported in Kilobytes.",
|
|
20889
|
+
"description": "* `total` Integer - The total amount of physical memory in Kilobytes available to the system.\n* `free` Integer - The total amount of memory not being used by applications or disk cache.\n* `fileBacked` Integer _macOS_ - The amount of memory that currently has been paged out to storage. Includes memory for file caches, network buffers, and other system services.\n* `purgeable` Integer _macOS_ - The amount of memory that is marked as \"purgeable\". The system can reclaim it if memory pressure increases.\n* `swapTotal` Integer _Windows_ _Linux_ - The total amount of swap memory in Kilobytes available to the system.\n* `swapFree` Integer _Windows_ _Linux_ - The free amount of swap memory in Kilobytes available to the system.\n\nReturns an object giving memory usage statistics about the entire system. Note that all statistics are reported in Kilobytes.",
|
|
20764
20890
|
"parameters": [],
|
|
20765
20891
|
"returns": {
|
|
20766
20892
|
"collection": false,
|
|
@@ -20782,6 +20908,26 @@
|
|
|
20782
20908
|
"collection": false,
|
|
20783
20909
|
"type": "Integer"
|
|
20784
20910
|
},
|
|
20911
|
+
{
|
|
20912
|
+
"name": "fileBacked",
|
|
20913
|
+
"description": "The amount of memory that currently has been paged out to storage. Includes memory for file caches, network buffers, and other system services.",
|
|
20914
|
+
"required": true,
|
|
20915
|
+
"additionalTags": [
|
|
20916
|
+
"os_macos"
|
|
20917
|
+
],
|
|
20918
|
+
"collection": false,
|
|
20919
|
+
"type": "Integer"
|
|
20920
|
+
},
|
|
20921
|
+
{
|
|
20922
|
+
"name": "purgeable",
|
|
20923
|
+
"description": "The amount of memory that is marked as \"purgeable\". The system can reclaim it if memory pressure increases.",
|
|
20924
|
+
"required": true,
|
|
20925
|
+
"additionalTags": [
|
|
20926
|
+
"os_macos"
|
|
20927
|
+
],
|
|
20928
|
+
"collection": false,
|
|
20929
|
+
"type": "Integer"
|
|
20930
|
+
},
|
|
20785
20931
|
{
|
|
20786
20932
|
"name": "swapTotal",
|
|
20787
20933
|
"description": "The total amount of swap memory in Kilobytes available to the system.",
|
|
@@ -21092,8 +21238,8 @@
|
|
|
21092
21238
|
"description": "> Register a custom protocol and intercept existing protocol requests.\n\nProcess: Main\n\nAn example of implementing a protocol that has the same effect as the `file://` protocol:\n\n```\nconst { app, protocol, net } = require('electron')\nconst path = require('node:path')\nconst url = require('node:url')\n\napp.whenReady().then(() => {\n protocol.handle('atom', (request) => {\n const filePath = request.url.slice('atom://'.length)\n return net.fetch(url.pathToFileURL(path.join(__dirname, filePath)).toString())\n })\n})\n```\n\n> [!NOTE] All methods unless specified can only be used after the `ready` event of the `app` module gets emitted.\n\n### Using `protocol` with a custom `partition` or `session`\n\nA protocol is registered to a specific Electron `session` object. If you don't specify a session, then your `protocol` will be applied to the default session that Electron uses. However, if you define a `partition` or `session` on your `browserWindow`'s `webPreferences`, then that window will use a different session and your custom protocol will not work if you just use `electron.protocol.XXX`.\n\nTo have your custom protocol work in combination with a custom session, you need to register it to that session explicitly.\n\n```\nconst { app, BrowserWindow, net, protocol, session } = require('electron')\nconst path = require('node:path')\nconst url = require('url')\n\napp.whenReady().then(() => {\n const partition = 'persist:example'\n const ses = session.fromPartition(partition)\n\n ses.protocol.handle('atom', (request) => {\n const filePath = request.url.slice('atom://'.length)\n return net.fetch(url.pathToFileURL(path.resolve(__dirname, filePath)).toString())\n })\n\n const mainWindow = new BrowserWindow({ webPreferences: { partition } })\n})\n```",
|
|
21093
21239
|
"slug": "protocol",
|
|
21094
21240
|
"websiteUrl": "https://electronjs.org/docs/api/protocol",
|
|
21095
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
21096
|
-
"version": "37.
|
|
21241
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/protocol.md",
|
|
21242
|
+
"version": "37.7.0",
|
|
21097
21243
|
"type": "Module",
|
|
21098
21244
|
"process": {
|
|
21099
21245
|
"main": true,
|
|
@@ -21959,8 +22105,8 @@
|
|
|
21959
22105
|
"description": "Process: Main\n\n> Register for and receive notifications from remote push notification services\n\nFor example, when registering for push notifications via Apple push notification services (APNS):",
|
|
21960
22106
|
"slug": "push-notifications",
|
|
21961
22107
|
"websiteUrl": "https://electronjs.org/docs/api/push-notifications",
|
|
21962
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
21963
|
-
"version": "37.
|
|
22108
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/push-notifications.md",
|
|
22109
|
+
"version": "37.7.0",
|
|
21964
22110
|
"type": "Module",
|
|
21965
22111
|
"process": {
|
|
21966
22112
|
"main": true,
|
|
@@ -22049,8 +22195,8 @@
|
|
|
22049
22195
|
"description": "> Allows access to simple encryption and decryption of strings for storage on the local machine.\n\nProcess: Main\n\nThis module adds extra protection to data being stored on disk by using OS-provided cryptography systems. Current security semantics for each platform are outlined below.\n\n* **macOS**: Encryption keys are stored for your app in Keychain Access in a way that prevents other applications from loading them without user override. Therefore, content is protected from other users and other apps running in the same userspace.\n* **Windows**: Encryption keys are generated via DPAPI. As per the Windows documentation: \"Typically, only a user with the same logon credential as the user who encrypted the data can typically decrypt the data\". Therefore, content is protected from other users on the same machine, but not from other apps running in the same userspace.\n* **Linux**: Encryption keys are generated and stored in a secret store that varies depending on your window manager and system setup. Options currently supported are `kwallet`, `kwallet5`, `kwallet6` and `gnome-libsecret`, but more may be available in future versions of Electron. As such, the security semantics of content protected via the `safeStorage` API vary between window managers and secret stores.\n * Note that not all Linux setups have an available secret store. If no secret store is available, items stored in using the `safeStorage` API will be unprotected as they are encrypted via hardcoded plaintext password. You can detect when this happens when `safeStorage.getSelectedStorageBackend()` returns `basic_text`.\n\nNote that on Mac, access to the system Keychain is required and these calls can block the current thread to collect user input. The same is true for Linux, if a password management tool is available.",
|
|
22050
22196
|
"slug": "safe-storage",
|
|
22051
22197
|
"websiteUrl": "https://electronjs.org/docs/api/safe-storage",
|
|
22052
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
22053
|
-
"version": "37.
|
|
22198
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/safe-storage.md",
|
|
22199
|
+
"version": "37.7.0",
|
|
22054
22200
|
"type": "Module",
|
|
22055
22201
|
"process": {
|
|
22056
22202
|
"main": true,
|
|
@@ -22180,8 +22326,8 @@
|
|
|
22180
22326
|
"description": "> Retrieve information about screen size, displays, cursor position, etc.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n`screen` is an EventEmitter.\n\n> [!NOTE] In the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `let { screen } = require('electron')` will not work.\n\nAn example of creating a window that fills the whole screen:\n\n```\n// Retrieve information about screen size, displays, cursor position, etc.\n//\n// For more info, see:\n// https://www.electronjs.org/docs/latest/api/screen\n\nconst { app, BrowserWindow, screen } = require('electron/main')\n\nlet mainWindow = null\n\napp.whenReady().then(() => {\n // Create a window that fills the screen's available work area.\n const primaryDisplay = screen.getPrimaryDisplay()\n const { width, height } = primaryDisplay.workAreaSize\n\n mainWindow = new BrowserWindow({ width, height })\n mainWindow.loadURL('https://electronjs.org')\n})\n```\n\nAnother example of creating a window in the external display:\n\n```\nconst { app, BrowserWindow, screen } = require('electron')\n\nlet win\n\napp.whenReady().then(() => {\n const displays = screen.getAllDisplays()\n const externalDisplay = displays.find((display) => {\n return display.bounds.x !== 0 || display.bounds.y !== 0\n })\n\n if (externalDisplay) {\n win = new BrowserWindow({\n x: externalDisplay.bounds.x + 50,\n y: externalDisplay.bounds.y + 50\n })\n win.loadURL('https://github.com')\n }\n})\n```\n\n> [!NOTE] Screen coordinates used by this module are `Point` structures. There are two kinds of coordinates available to the process:\n\n* **Physical screen points** are raw hardware pixels on a display.\n* **Device-independent pixel (DIP) points** are virtualized screen points scaled based on the DPI (dots per inch) of the display.",
|
|
22181
22327
|
"slug": "screen",
|
|
22182
22328
|
"websiteUrl": "https://electronjs.org/docs/api/screen",
|
|
22183
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
22184
|
-
"version": "37.
|
|
22329
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/screen.md",
|
|
22330
|
+
"version": "37.7.0",
|
|
22185
22331
|
"type": "Module",
|
|
22186
22332
|
"process": {
|
|
22187
22333
|
"main": true,
|
|
@@ -22480,8 +22626,8 @@
|
|
|
22480
22626
|
"description": "",
|
|
22481
22627
|
"slug": "service-worker-main",
|
|
22482
22628
|
"websiteUrl": "https://electronjs.org/docs/api/service-worker-main",
|
|
22483
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
22484
|
-
"version": "37.
|
|
22629
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/service-worker-main.md",
|
|
22630
|
+
"version": "37.7.0",
|
|
22485
22631
|
"type": "Class",
|
|
22486
22632
|
"process": {
|
|
22487
22633
|
"main": true,
|
|
@@ -22621,8 +22767,8 @@
|
|
|
22621
22767
|
"description": "",
|
|
22622
22768
|
"slug": "service-workers",
|
|
22623
22769
|
"websiteUrl": "https://electronjs.org/docs/api/service-workers",
|
|
22624
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
22625
|
-
"version": "37.
|
|
22770
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/service-workers.md",
|
|
22771
|
+
"version": "37.7.0",
|
|
22626
22772
|
"type": "Class",
|
|
22627
22773
|
"process": {
|
|
22628
22774
|
"main": true,
|
|
@@ -22988,8 +23134,8 @@
|
|
|
22988
23134
|
"description": "> Manage browser sessions, cookies, cache, proxy settings, etc.\n\nProcess: Main\n\nThe `session` module can be used to create new `Session` objects.\n\nYou can also access the `session` of existing pages by using the `session` property of `WebContents`, or from the `session` module.",
|
|
22989
23135
|
"slug": "session",
|
|
22990
23136
|
"websiteUrl": "https://electronjs.org/docs/api/session",
|
|
22991
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
22992
|
-
"version": "37.
|
|
23137
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/session.md",
|
|
23138
|
+
"version": "37.7.0",
|
|
22993
23139
|
"type": "Module",
|
|
22994
23140
|
"process": {
|
|
22995
23141
|
"main": true,
|
|
@@ -23094,8 +23240,8 @@
|
|
|
23094
23240
|
"description": "",
|
|
23095
23241
|
"slug": "session",
|
|
23096
23242
|
"websiteUrl": "https://electronjs.org/docs/api/session",
|
|
23097
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
23098
|
-
"version": "37.
|
|
23243
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/session.md",
|
|
23244
|
+
"version": "37.7.0",
|
|
23099
23245
|
"type": "Class",
|
|
23100
23246
|
"process": {
|
|
23101
23247
|
"main": true,
|
|
@@ -23889,7 +24035,7 @@
|
|
|
23889
24035
|
{
|
|
23890
24036
|
"name": "setPermissionCheckHandler",
|
|
23891
24037
|
"signature": "(handler)",
|
|
23892
|
-
"description": "Sets the handler which can be used to respond to permission checks for the `session`. Returning `true` will allow the permission and `false` will reject it. Please note that you must also implement `setPermissionRequestHandler` to get complete permission handling. Most web APIs do a permission check and then make a permission request if the check is denied. To clear the handler, call `setPermissionCheckHandler(null)
|
|
24038
|
+
"description": "Sets the handler which can be used to respond to permission checks for the `session`. Returning `true` will allow the permission and `false` will reject it. Please note that you must also implement `setPermissionRequestHandler` to get complete permission handling. Most web APIs do a permission check and then make a permission request if the check is denied. To clear the handler, call `setPermissionCheckHandler(null)`.\n\n> [!NOTE] `isMainFrame` will always be `false` for a `fileSystem` request as a result of Chromium limitations.",
|
|
23893
24039
|
"parameters": [
|
|
23894
24040
|
{
|
|
23895
24041
|
"name": "handler",
|
|
@@ -23995,6 +24141,10 @@
|
|
|
23995
24141
|
{
|
|
23996
24142
|
"value": "deprecated-sync-clipboard-read",
|
|
23997
24143
|
"description": "Request access to run `document.execCommand(\"paste\")`"
|
|
24144
|
+
},
|
|
24145
|
+
{
|
|
24146
|
+
"value": "fileSystem",
|
|
24147
|
+
"description": "Access to read, write, and file management capabilities using the File System API."
|
|
23998
24148
|
}
|
|
23999
24149
|
]
|
|
24000
24150
|
},
|
|
@@ -24033,7 +24183,7 @@
|
|
|
24033
24183
|
},
|
|
24034
24184
|
{
|
|
24035
24185
|
"name": "mediaType",
|
|
24036
|
-
"description": "The type of media access being requested, can be `video`, `audio` or `unknown
|
|
24186
|
+
"description": "The type of media access being requested, can be `video`, `audio` or `unknown`.",
|
|
24037
24187
|
"required": false,
|
|
24038
24188
|
"additionalTags": [],
|
|
24039
24189
|
"collection": false,
|
|
@@ -24064,11 +24214,46 @@
|
|
|
24064
24214
|
},
|
|
24065
24215
|
{
|
|
24066
24216
|
"name": "isMainFrame",
|
|
24067
|
-
"description": "Whether the frame making the request is the main frame",
|
|
24217
|
+
"description": "Whether the frame making the request is the main frame.",
|
|
24068
24218
|
"required": true,
|
|
24069
24219
|
"additionalTags": [],
|
|
24070
24220
|
"collection": false,
|
|
24071
24221
|
"type": "boolean"
|
|
24222
|
+
},
|
|
24223
|
+
{
|
|
24224
|
+
"name": "filePath",
|
|
24225
|
+
"description": "The path of a `fileSystem` request.",
|
|
24226
|
+
"required": false,
|
|
24227
|
+
"additionalTags": [],
|
|
24228
|
+
"collection": false,
|
|
24229
|
+
"type": "String",
|
|
24230
|
+
"possibleValues": null
|
|
24231
|
+
},
|
|
24232
|
+
{
|
|
24233
|
+
"name": "isDirectory",
|
|
24234
|
+
"description": "Whether a `fileSystem` request is a directory.",
|
|
24235
|
+
"required": false,
|
|
24236
|
+
"additionalTags": [],
|
|
24237
|
+
"collection": false,
|
|
24238
|
+
"type": "boolean"
|
|
24239
|
+
},
|
|
24240
|
+
{
|
|
24241
|
+
"name": "fileAccessType",
|
|
24242
|
+
"description": "The access type of a `fileSystem` request. Can be `writable` or `readable`.",
|
|
24243
|
+
"required": false,
|
|
24244
|
+
"additionalTags": [],
|
|
24245
|
+
"collection": false,
|
|
24246
|
+
"type": "String",
|
|
24247
|
+
"possibleValues": [
|
|
24248
|
+
{
|
|
24249
|
+
"value": "writable",
|
|
24250
|
+
"description": ""
|
|
24251
|
+
},
|
|
24252
|
+
{
|
|
24253
|
+
"value": "readable",
|
|
24254
|
+
"description": ""
|
|
24255
|
+
}
|
|
24256
|
+
]
|
|
24072
24257
|
}
|
|
24073
24258
|
]
|
|
24074
24259
|
}
|
|
@@ -26616,8 +26801,8 @@
|
|
|
26616
26801
|
"description": "The `ShareMenu` class creates Share Menu on macOS, which can be used to share information from the current context to apps, social media accounts, and other services.\n\nFor including the share menu as a submenu of other menus, please use the `shareMenu` role of `MenuItem`.\n\n### Class: ShareMenu\n\n> Create share menu on macOS.\n\nProcess: Main\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
26617
26802
|
"slug": "share-menu",
|
|
26618
26803
|
"websiteUrl": "https://electronjs.org/docs/api/share-menu",
|
|
26619
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
26620
|
-
"version": "37.
|
|
26804
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/share-menu.md",
|
|
26805
|
+
"version": "37.7.0",
|
|
26621
26806
|
"type": "Class",
|
|
26622
26807
|
"process": {
|
|
26623
26808
|
"main": true,
|
|
@@ -26684,8 +26869,8 @@
|
|
|
26684
26869
|
"description": "> Manage files and URLs using their default applications.\n\nProcess: Main, Renderer (non-sandboxed only)\n\nThe `shell` module provides functions related to desktop integration.\n\nAn example of opening a URL in the user's default browser:\n\n```\nconst { shell } = require('electron')\n\nshell.openExternal('https://github.com')\n```\n\n> [!WARNING] While the `shell` module can be used in the renderer process, it will not function in a sandboxed renderer.",
|
|
26685
26870
|
"slug": "shell",
|
|
26686
26871
|
"websiteUrl": "https://electronjs.org/docs/api/shell",
|
|
26687
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
26688
|
-
"version": "37.
|
|
26872
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/shell.md",
|
|
26873
|
+
"version": "37.7.0",
|
|
26689
26874
|
"type": "Module",
|
|
26690
26875
|
"process": {
|
|
26691
26876
|
"main": true,
|
|
@@ -26927,8 +27112,8 @@
|
|
|
26927
27112
|
"description": "> Get system preferences.\n\nProcess: Main, Utility",
|
|
26928
27113
|
"slug": "system-preferences",
|
|
26929
27114
|
"websiteUrl": "https://electronjs.org/docs/api/system-preferences",
|
|
26930
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
26931
|
-
"version": "37.
|
|
27115
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/system-preferences.md",
|
|
27116
|
+
"version": "37.7.0",
|
|
26932
27117
|
"type": "Module",
|
|
26933
27118
|
"process": {
|
|
26934
27119
|
"main": true,
|
|
@@ -28161,8 +28346,8 @@
|
|
|
28161
28346
|
"description": "> Create a button in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28162
28347
|
"slug": "touch-bar-button",
|
|
28163
28348
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-button",
|
|
28164
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28165
|
-
"version": "37.
|
|
28349
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar-button.md",
|
|
28350
|
+
"version": "37.7.0",
|
|
28166
28351
|
"type": "Class",
|
|
28167
28352
|
"process": {
|
|
28168
28353
|
"main": true,
|
|
@@ -28353,8 +28538,8 @@
|
|
|
28353
28538
|
"description": "> Create a color picker in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28354
28539
|
"slug": "touch-bar-color-picker",
|
|
28355
28540
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-color-picker",
|
|
28356
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28357
|
-
"version": "37.
|
|
28541
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar-color-picker.md",
|
|
28542
|
+
"version": "37.7.0",
|
|
28358
28543
|
"type": "Class",
|
|
28359
28544
|
"process": {
|
|
28360
28545
|
"main": true,
|
|
@@ -28446,8 +28631,8 @@
|
|
|
28446
28631
|
"description": "> Create a group in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28447
28632
|
"slug": "touch-bar-group",
|
|
28448
28633
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-group",
|
|
28449
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28450
|
-
"version": "37.
|
|
28634
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar-group.md",
|
|
28635
|
+
"version": "37.7.0",
|
|
28451
28636
|
"type": "Class",
|
|
28452
28637
|
"process": {
|
|
28453
28638
|
"main": true,
|
|
@@ -28489,8 +28674,8 @@
|
|
|
28489
28674
|
"description": "> Create a label in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28490
28675
|
"slug": "touch-bar-label",
|
|
28491
28676
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-label",
|
|
28492
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28493
|
-
"version": "37.
|
|
28677
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar-label.md",
|
|
28678
|
+
"version": "37.7.0",
|
|
28494
28679
|
"type": "Class",
|
|
28495
28680
|
"process": {
|
|
28496
28681
|
"main": true,
|
|
@@ -28582,8 +28767,8 @@
|
|
|
28582
28767
|
"description": "> Instantiates a special \"other items proxy\", which nests TouchBar elements inherited from Chromium at the space indicated by the proxy. By default, this proxy is added to each TouchBar at the end of the input. For more information, see the AppKit docs on NSTouchBarItemIdentifierOtherItemsProxy\n\n> [!NOTE] Only one instance of this class can be added per TouchBar.\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28583
28768
|
"slug": "touch-bar-other-items-proxy",
|
|
28584
28769
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-other-items-proxy",
|
|
28585
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28586
|
-
"version": "37.
|
|
28770
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar-other-items-proxy.md",
|
|
28771
|
+
"version": "37.7.0",
|
|
28587
28772
|
"type": "Class",
|
|
28588
28773
|
"process": {
|
|
28589
28774
|
"main": true,
|
|
@@ -28607,8 +28792,8 @@
|
|
|
28607
28792
|
"description": "> Create a popover in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28608
28793
|
"slug": "touch-bar-popover",
|
|
28609
28794
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-popover",
|
|
28610
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28611
|
-
"version": "37.
|
|
28795
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar-popover.md",
|
|
28796
|
+
"version": "37.7.0",
|
|
28612
28797
|
"type": "Class",
|
|
28613
28798
|
"process": {
|
|
28614
28799
|
"main": true,
|
|
@@ -28695,8 +28880,8 @@
|
|
|
28695
28880
|
"description": "> Create a scrubber (a scrollable selector)\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28696
28881
|
"slug": "touch-bar-scrubber",
|
|
28697
28882
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-scrubber",
|
|
28698
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28699
|
-
"version": "37.
|
|
28883
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar-scrubber.md",
|
|
28884
|
+
"version": "37.7.0",
|
|
28700
28885
|
"type": "Class",
|
|
28701
28886
|
"process": {
|
|
28702
28887
|
"main": true,
|
|
@@ -28945,8 +29130,8 @@
|
|
|
28945
29130
|
"description": "> Create a segmented control (a button group) where one button has a selected state\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28946
29131
|
"slug": "touch-bar-segmented-control",
|
|
28947
29132
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-segmented-control",
|
|
28948
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28949
|
-
"version": "37.
|
|
29133
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar-segmented-control.md",
|
|
29134
|
+
"version": "37.7.0",
|
|
28950
29135
|
"type": "Class",
|
|
28951
29136
|
"process": {
|
|
28952
29137
|
"main": true,
|
|
@@ -29137,8 +29322,8 @@
|
|
|
29137
29322
|
"description": "> Create a slider in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
29138
29323
|
"slug": "touch-bar-slider",
|
|
29139
29324
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-slider",
|
|
29140
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
29141
|
-
"version": "37.
|
|
29325
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar-slider.md",
|
|
29326
|
+
"version": "37.7.0",
|
|
29142
29327
|
"type": "Class",
|
|
29143
29328
|
"process": {
|
|
29144
29329
|
"main": true,
|
|
@@ -29261,8 +29446,8 @@
|
|
|
29261
29446
|
"description": "> Create a spacer between two items in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
29262
29447
|
"slug": "touch-bar-spacer",
|
|
29263
29448
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-spacer",
|
|
29264
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
29265
|
-
"version": "37.
|
|
29449
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar-spacer.md",
|
|
29450
|
+
"version": "37.7.0",
|
|
29266
29451
|
"type": "Class",
|
|
29267
29452
|
"process": {
|
|
29268
29453
|
"main": true,
|
|
@@ -29342,8 +29527,8 @@
|
|
|
29342
29527
|
"description": "> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.\n\n### Class: TouchBar\n\n> Create TouchBar layouts for native macOS applications\n\nProcess: Main",
|
|
29343
29528
|
"slug": "touch-bar",
|
|
29344
29529
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar",
|
|
29345
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
29346
|
-
"version": "37.
|
|
29530
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/touch-bar.md",
|
|
29531
|
+
"version": "37.7.0",
|
|
29347
29532
|
"type": "Class",
|
|
29348
29533
|
"process": {
|
|
29349
29534
|
"main": true,
|
|
@@ -29572,8 +29757,8 @@
|
|
|
29572
29757
|
"description": "\n\n### Class: Tray\n\n> Add icons and context menus to the system's notification area.\n\nProcess: Main\n\n`Tray` is an EventEmitter.\n\n```\nconst { app, Menu, Tray } = require('electron')\n\nlet tray = null\napp.whenReady().then(() => {\n tray = new Tray('/path/to/my/icon')\n const contextMenu = Menu.buildFromTemplate([\n { label: 'Item1', type: 'radio' },\n { label: 'Item2', type: 'radio' },\n { label: 'Item3', type: 'radio', checked: true },\n { label: 'Item4', type: 'radio' }\n ])\n tray.setToolTip('This is my application.')\n tray.setContextMenu(contextMenu)\n})\n```\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.\n\n**Platform Considerations**\n\n**Linux**\n\n* Tray icon uses StatusNotifierItem by default, when it is not available in user's desktop environment the `GtkStatusIcon` will be used instead.\n* The `click` event is emitted when the tray icon receives activation from user, however the StatusNotifierItem spec does not specify which action would cause an activation, for some environments it is left mouse click, but for some it might be double left mouse click.\n* In order for changes made to individual `MenuItem`s to take effect, you have to call `setContextMenu` again. For example:\n\n```\nconst { app, Menu, Tray } = require('electron')\n\nlet appIcon = null\napp.whenReady().then(() => {\n appIcon = new Tray('/path/to/my/icon')\n const contextMenu = Menu.buildFromTemplate([\n { label: 'Item1', type: 'radio' },\n { label: 'Item2', type: 'radio' }\n ])\n\n // Make a change to the context menu\n contextMenu.items[1].checked = false\n\n // Call this again for Linux because we modified the context menu\n appIcon.setContextMenu(contextMenu)\n})\n```\n\n**MacOS**\n\n* Icons passed to the Tray constructor should be Template Images.\n* To make sure your icon isn't grainy on retina monitors, be sure your `@2x` image is 144dpi.\n* If you are bundling your application (e.g., with webpack for development), be sure that the file names are not being mangled or hashed. The filename needs to end in Template, and the `@2x` image needs to have the same filename as the standard image, or MacOS will not magically invert your image's colors or use the high density image.\n* 16x16 (72dpi) and 32x32@2x (144dpi) work well for most icons.\n\n**Windows**\n\n* It is recommended to use `ICO` icons to get best visual effects.",
|
|
29573
29758
|
"slug": "tray",
|
|
29574
29759
|
"websiteUrl": "https://electronjs.org/docs/api/tray",
|
|
29575
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
29576
|
-
"version": "37.
|
|
29760
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/tray.md",
|
|
29761
|
+
"version": "37.7.0",
|
|
29577
29762
|
"type": "Class",
|
|
29578
29763
|
"process": {
|
|
29579
29764
|
"main": true,
|
|
@@ -29603,7 +29788,7 @@
|
|
|
29603
29788
|
},
|
|
29604
29789
|
{
|
|
29605
29790
|
"name": "guid",
|
|
29606
|
-
"description": "
|
|
29791
|
+
"description": "A unique string used to identify the tray icon. Must adhere to UUID format.",
|
|
29607
29792
|
"required": false,
|
|
29608
29793
|
"collection": false,
|
|
29609
29794
|
"type": "String",
|
|
@@ -30005,6 +30190,31 @@
|
|
|
30005
30190
|
],
|
|
30006
30191
|
"urlFragment": "#traygetbounds-macos-windows"
|
|
30007
30192
|
},
|
|
30193
|
+
{
|
|
30194
|
+
"name": "getGUID",
|
|
30195
|
+
"signature": "()",
|
|
30196
|
+
"description": "The GUID used to uniquely identify the tray icon and allow it to retain its position between relaunches, or null if none is set.",
|
|
30197
|
+
"parameters": [],
|
|
30198
|
+
"returns": {
|
|
30199
|
+
"collection": false,
|
|
30200
|
+
"type": [
|
|
30201
|
+
{
|
|
30202
|
+
"collection": false,
|
|
30203
|
+
"type": "String",
|
|
30204
|
+
"possibleValues": null
|
|
30205
|
+
},
|
|
30206
|
+
{
|
|
30207
|
+
"type": "null",
|
|
30208
|
+
"collection": false
|
|
30209
|
+
}
|
|
30210
|
+
]
|
|
30211
|
+
},
|
|
30212
|
+
"additionalTags": [
|
|
30213
|
+
"os_macos",
|
|
30214
|
+
"os_windows"
|
|
30215
|
+
],
|
|
30216
|
+
"urlFragment": "#traygetguid-macos-windows"
|
|
30217
|
+
},
|
|
30008
30218
|
{
|
|
30009
30219
|
"name": "isDestroyed",
|
|
30010
30220
|
"signature": "()",
|
|
@@ -30390,8 +30600,8 @@
|
|
|
30390
30600
|
"description": "`utilityProcess` creates a child process with Node.js and Message ports enabled. It provides the equivalent of `child_process.fork` API from Node.js but instead uses Services API from Chromium to launch the child process.\n\nProcess: Main",
|
|
30391
30601
|
"slug": "utility-process",
|
|
30392
30602
|
"websiteUrl": "https://electronjs.org/docs/api/utility-process",
|
|
30393
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
30394
|
-
"version": "37.
|
|
30603
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/utility-process.md",
|
|
30604
|
+
"version": "37.7.0",
|
|
30395
30605
|
"type": "Module",
|
|
30396
30606
|
"process": {
|
|
30397
30607
|
"main": true,
|
|
@@ -30534,8 +30744,8 @@
|
|
|
30534
30744
|
"description": "",
|
|
30535
30745
|
"slug": "utility-process",
|
|
30536
30746
|
"websiteUrl": "https://electronjs.org/docs/api/utility-process",
|
|
30537
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
30538
|
-
"version": "37.
|
|
30747
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/utility-process.md",
|
|
30748
|
+
"version": "37.7.0",
|
|
30539
30749
|
"type": "Class",
|
|
30540
30750
|
"process": {
|
|
30541
30751
|
"main": true,
|
|
@@ -30730,8 +30940,8 @@
|
|
|
30730
30940
|
"description": "> Create and layout native views.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Class: View\n\n> A basic native view.\n\nProcess: Main\n\n`View` is an EventEmitter.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
30731
30941
|
"slug": "view",
|
|
30732
30942
|
"websiteUrl": "https://electronjs.org/docs/api/view",
|
|
30733
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
30734
|
-
"version": "37.
|
|
30943
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/view.md",
|
|
30944
|
+
"version": "37.7.0",
|
|
30735
30945
|
"type": "Class",
|
|
30736
30946
|
"process": {
|
|
30737
30947
|
"main": true,
|
|
@@ -30911,8 +31121,8 @@
|
|
|
30911
31121
|
"description": "> A View that displays a WebContents.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Class: WebContentsView extends `View`\n\n> A View that displays a WebContents.\n\nProcess: Main\n\n`WebContentsView` inherits from `View`.\n\n`WebContentsView` is an EventEmitter.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
30912
31122
|
"slug": "web-contents-view",
|
|
30913
31123
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents-view",
|
|
30914
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
30915
|
-
"version": "37.
|
|
31124
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/web-contents-view.md",
|
|
31125
|
+
"version": "37.7.0",
|
|
30916
31126
|
"type": "Class",
|
|
30917
31127
|
"process": {
|
|
30918
31128
|
"main": true,
|
|
@@ -30974,8 +31184,8 @@
|
|
|
30974
31184
|
"description": "> Render and control web pages.\n\nProcess: Main\n\n`webContents` is an EventEmitter. It is responsible for rendering and controlling a web page and is a property of the `BrowserWindow` object. An example of accessing the `webContents` object:\n\n### Navigation Events\n\nSeveral events can be used to monitor navigations as they occur within a `webContents`.\n\n### Document Navigations\n\nWhen a `webContents` navigates to another page (as opposed to an in-page navigation), the following events will be fired.\n\n* `did-start-navigation`\n* `will-frame-navigate`\n* `will-navigate` (only fired when main frame navigates)\n* `will-redirect` (only fired when a redirect happens during navigation)\n* `did-redirect-navigation` (only fired when a redirect happens during navigation)\n* `did-frame-navigate`\n* `did-navigate` (only fired when main frame navigates)\n\nSubsequent events will not fire if `event.preventDefault()` is called on any of the cancellable events.\n\n### In-page Navigation\n\nIn-page navigations don't cause the page to reload, but instead navigate to a location within the current page. These events are not cancellable. For an in-page navigations, the following events will fire in this order:\n\n* `did-start-navigation`\n* `did-navigate-in-page`\n\n### Frame Navigation\n\nThe `will-navigate` and `did-navigate` events only fire when the mainFrame navigates. If you want to also observe navigations in `<iframe>`s, use `will-frame-navigate` and `did-frame-navigate` events.",
|
|
30975
31185
|
"slug": "web-contents",
|
|
30976
31186
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents",
|
|
30977
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
30978
|
-
"version": "37.
|
|
31187
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/web-contents.md",
|
|
31188
|
+
"version": "37.7.0",
|
|
30979
31189
|
"type": "Module",
|
|
30980
31190
|
"process": {
|
|
30981
31191
|
"main": true,
|
|
@@ -31115,8 +31325,8 @@
|
|
|
31115
31325
|
"description": "",
|
|
31116
31326
|
"slug": "web-contents",
|
|
31117
31327
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents",
|
|
31118
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
31119
|
-
"version": "37.
|
|
31328
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/web-contents.md",
|
|
31329
|
+
"version": "37.7.0",
|
|
31120
31330
|
"type": "Class",
|
|
31121
31331
|
"process": {
|
|
31122
31332
|
"main": true,
|
|
@@ -37292,8 +37502,8 @@
|
|
|
37292
37502
|
"description": "> Control web pages and iframes.\n\nProcess: Main\n\nThe `webFrameMain` module can be used to lookup frames across existing `WebContents` instances. Navigation events are the common use case.\n\n```\nconst { BrowserWindow, webFrameMain } = require('electron')\n\nconst win = new BrowserWindow({ width: 800, height: 1500 })\nwin.loadURL('https://twitter.com')\n\nwin.webContents.on(\n 'did-frame-navigate',\n (event, url, httpResponseCode, httpStatusText, isMainFrame, frameProcessId, frameRoutingId) => {\n const frame = webFrameMain.fromId(frameProcessId, frameRoutingId)\n if (frame) {\n const code = 'document.body.innerHTML = document.body.innerHTML.replaceAll(\"heck\", \"h*ck\")'\n frame.executeJavaScript(code)\n }\n }\n)\n```\n\nYou can also access frames of existing pages by using the `mainFrame` property of `WebContents`.",
|
|
37293
37503
|
"slug": "web-frame-main",
|
|
37294
37504
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
|
|
37295
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
37296
|
-
"version": "37.
|
|
37505
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/web-frame-main.md",
|
|
37506
|
+
"version": "37.7.0",
|
|
37297
37507
|
"type": "Module",
|
|
37298
37508
|
"process": {
|
|
37299
37509
|
"main": true,
|
|
@@ -37348,8 +37558,8 @@
|
|
|
37348
37558
|
"description": "",
|
|
37349
37559
|
"slug": "web-frame-main",
|
|
37350
37560
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
|
|
37351
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
37352
|
-
"version": "37.
|
|
37561
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/web-frame-main.md",
|
|
37562
|
+
"version": "37.7.0",
|
|
37353
37563
|
"type": "Class",
|
|
37354
37564
|
"process": {
|
|
37355
37565
|
"main": true,
|
|
@@ -37707,8 +37917,8 @@
|
|
|
37707
37917
|
"description": "> Customize the rendering of the current web page.\n\nProcess: Renderer\n\n`webFrame` export of the Electron module is an instance of the `WebFrame` class representing the current frame. Sub-frames can be retrieved by certain properties and methods (e.g. `webFrame.firstChild`).\n\nAn example of zooming current page to 200%.",
|
|
37708
37918
|
"slug": "web-frame",
|
|
37709
37919
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame",
|
|
37710
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
37711
|
-
"version": "37.
|
|
37920
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/web-frame.md",
|
|
37921
|
+
"version": "37.7.0",
|
|
37712
37922
|
"type": "Module",
|
|
37713
37923
|
"process": {
|
|
37714
37924
|
"main": false,
|
|
@@ -37950,7 +38160,7 @@
|
|
|
37950
38160
|
},
|
|
37951
38161
|
{
|
|
37952
38162
|
"name": "executeJavaScript",
|
|
37953
|
-
"signature": "(code[, userGesture, callback])",
|
|
38163
|
+
"signature": "(code[, userGesture][, callback])",
|
|
37954
38164
|
"description": "A promise that resolves with the result of the executed code or is rejected if execution throws or results in a rejected promise.\n\nEvaluates `code` in page.\n\nIn 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.",
|
|
37955
38165
|
"parameters": [
|
|
37956
38166
|
{
|
|
@@ -38008,7 +38218,7 @@
|
|
|
38008
38218
|
},
|
|
38009
38219
|
{
|
|
38010
38220
|
"name": "executeJavaScriptInIsolatedWorld",
|
|
38011
|
-
"signature": "(worldId, scripts[, userGesture, callback])",
|
|
38221
|
+
"signature": "(worldId, scripts[, userGesture][, callback])",
|
|
38012
38222
|
"description": "A promise that resolves with the result of the executed code or is rejected if execution could not start.\n\nWorks like `executeJavaScript` but evaluates `scripts` in an isolated context.\n\nNote that when the execution of script fails, the returned promise will not reject and the `result` would be `undefined`. This is because Chromium does not dispatch errors of isolated worlds to foreign worlds.",
|
|
38013
38223
|
"parameters": [
|
|
38014
38224
|
{
|
|
@@ -38421,8 +38631,8 @@
|
|
|
38421
38631
|
"description": "",
|
|
38422
38632
|
"slug": "web-request",
|
|
38423
38633
|
"websiteUrl": "https://electronjs.org/docs/api/web-request",
|
|
38424
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
38425
|
-
"version": "37.
|
|
38634
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/web-request.md",
|
|
38635
|
+
"version": "37.7.0",
|
|
38426
38636
|
"type": "Class",
|
|
38427
38637
|
"process": {
|
|
38428
38638
|
"main": true,
|
|
@@ -40339,8 +40549,8 @@
|
|
|
40339
40549
|
"description": "> A utility layer to interact with Web API objects (Files, Blobs, etc.)\n\nProcess: Renderer",
|
|
40340
40550
|
"slug": "web-utils",
|
|
40341
40551
|
"websiteUrl": "https://electronjs.org/docs/api/web-utils",
|
|
40342
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
40343
|
-
"version": "37.
|
|
40552
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/web-utils.md",
|
|
40553
|
+
"version": "37.7.0",
|
|
40344
40554
|
"type": "Module",
|
|
40345
40555
|
"process": {
|
|
40346
40556
|
"main": false,
|
|
@@ -40381,8 +40591,8 @@
|
|
|
40381
40591
|
"description": "\n\n### Warning\n\nElectron's `webview` tag is based on Chromium's `webview`, which is undergoing dramatic architectural changes. This impacts the stability of `webviews`, including rendering, navigation, and event routing. We currently recommend to not use the `webview` tag and to consider alternatives, like `iframe`, a `WebContentsView`, or an architecture that avoids embedded content altogether.\n\n### Enabling\n\nBy default the `webview` tag is disabled in Electron >= 5. You need to enable the tag by setting the `webviewTag` webPreferences option when constructing your `BrowserWindow`. For more information see the BrowserWindow constructor docs.\n\n### Overview\n\n> Display external web content in an isolated frame and process.\n\nProcess: Renderer\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._\n\nUse the `webview` tag to embed 'guest' content (such as web pages) in your Electron app. The guest content is contained within the `webview` container. An embedded page within your app controls how the guest content is laid out and rendered.\n\nUnlike an `iframe`, the `webview` runs in a separate process than your app. It doesn't have the same permissions as your web page and all interactions between your app and embedded content will be asynchronous. This keeps your app safe from the embedded content.\n\n> [!NOTE] Most methods called on the webview from the host page require a synchronous call to the main process.\n\n### Example\n\nTo embed a web page in your app, add the `webview` tag to your app's embedder page (this is the app page that will display the guest content). In its simplest form, the `webview` tag includes the `src` of the web page and css styles that control the appearance of the `webview` container:\n\n```\n<webview id=\"foo\" src=\"https://www.github.com/\" style=\"display:inline-flex; width:640px; height:480px\"></webview>\n```\n\nIf you want to control the guest content in any way, you can write JavaScript that listens for `webview` events and responds to those events using the `webview` methods. Here's sample code with two event listeners: one that listens for the web page to start loading, the other for the web page to stop loading, and displays a \"loading...\" message during the load time:\n\n```\n<script>\n onload = () => {\n const webview = document.querySelector('webview')\n const indicator = document.querySelector('.indicator')\n\n const loadstart = () => {\n indicator.innerText = 'loading...'\n }\n\n const loadstop = () => {\n indicator.innerText = ''\n }\n\n webview.addEventListener('did-start-loading', loadstart)\n webview.addEventListener('did-stop-loading', loadstop)\n }\n</script>\n```\n\n### Internal implementation\n\nUnder the hood `webview` is implemented with Out-of-Process iframes (OOPIFs). The `webview` tag is essentially a custom element using shadow DOM to wrap an `iframe` element inside it.\n\nSo the behavior of `webview` is very similar to a cross-domain `iframe`, as examples:\n\n* When clicking into a `webview`, the page focus will move from the embedder frame to `webview`.\n* You can not add keyboard, mouse, and scroll event listeners to `webview`.\n* All reactions between the embedder frame and `webview` are asynchronous.\n\n### CSS Styling Notes\n\nPlease note that the `webview` tag's style uses `display:flex;` internally to ensure the child `iframe` element fills the full height and width of its `webview` container when used with traditional and flexbox layouts. Please do not overwrite the default `display:flex;` CSS property, unless specifying `display:inline-flex;` for inline layout.\n\n### Tag Attributes\n\nThe `webview` tag has the following attributes:\n\n### `src`\n\n```\n<webview src=\"https://www.github.com/\"></webview>\n```\n\nA `string` representing the visible URL. Writing to this attribute initiates top-level navigation.\n\nAssigning `src` its own value will reload the current page.\n\nThe `src` attribute can also accept data URLs, such as `data:text/plain,Hello, world!`.\n\n### `nodeintegration`\n\n```\n<webview src=\"https://www.google.com/\" nodeintegration></webview>\n```\n\nA `boolean`. 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.\n\n### `nodeintegrationinsubframes`\n\n```\n<webview src=\"https://www.google.com/\" nodeintegrationinsubframes></webview>\n```\n\nA `boolean` for the experimental option for enabling NodeJS support in sub-frames such as iframes inside the `webview`. All your preloads will load for every iframe, you can use `process.isMainFrame` to determine if you are in the main frame or not. This option is disabled by default in the guest page.\n\n### `plugins`\n\n```\n<webview src=\"https://www.github.com/\" plugins></webview>\n```\n\nA `boolean`. When this attribute is present the guest page in `webview` will be able to use browser plugins. Plugins are disabled by default.\n\n### `preload`\n\n```\n<!-- from a file -->\n<webview src=\"https://www.github.com/\" preload=\"./test.js\"></webview>\n<!-- or if you want to load from an asar archive -->\n<webview src=\"https://www.github.com/\" preload=\"./app.asar/test.js\"></webview>\n```\n\nA `string` that specifies a script that will be loaded before other scripts run in the guest page. The protocol of script's URL must be `file:` (even when using `asar:` archives) because it will be loaded by Node's `require` under the hood, which treats `asar:` archives as virtual directories.\n\nWhen 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.\n\n### `httpreferrer`\n\n```\n<webview src=\"https://www.github.com/\" httpreferrer=\"https://example.com/\"></webview>\n```\n\nA `string` that sets the referrer URL for the guest page.\n\n### `useragent`\n\n```\n<webview src=\"https://www.github.com/\" useragent=\"Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; AS; rv:11.0) like Gecko\"></webview>\n```\n\nA `string` that 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.\n\n### `disablewebsecurity`\n\n```\n<webview src=\"https://www.github.com/\" disablewebsecurity></webview>\n```\n\nA `boolean`. When this attribute is present the guest page will have web security disabled. Web security is enabled by default.\n\nThis value can only be modified before the first navigation.\n\n### `partition`\n\n```\n<webview src=\"https://github.com\" partition=\"persist:github\"></webview>\n<webview src=\"https://electronjs.org\" partition=\"electron\"></webview>\n```\n\nA `string` that 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.\n\nThis 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.\n\n### `allowpopups`\n\n```\n<webview src=\"https://www.github.com/\" allowpopups></webview>\n```\n\nA `boolean`. When this attribute is present the guest page will be allowed to open new windows. Popups are disabled by default.\n\n### `webpreferences`\n\n```\n<webview src=\"https://github.com\" webpreferences=\"allowRunningInsecureContent, javascript=no\"></webview>\n```\n\nA `string` which is a comma separated list of strings which specifies the web preferences to be set on the webview. The full list of supported preference strings can be found in BrowserWindow.\n\nThe 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`.\n\n### `enableblinkfeatures`\n\n```\n<webview src=\"https://www.github.com/\" enableblinkfeatures=\"PreciseMemoryInfo, CSSVariables\"></webview>\n```\n\nA `string` which is 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.\n\n### `disableblinkfeatures`\n\n```\n<webview src=\"https://www.github.com/\" disableblinkfeatures=\"PreciseMemoryInfo, CSSVariables\"></webview>\n```\n\nA `string` which is 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.",
|
|
40382
40592
|
"slug": "webview-tag",
|
|
40383
40593
|
"websiteUrl": "https://electronjs.org/docs/api/webview-tag",
|
|
40384
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
40385
|
-
"version": "37.
|
|
40594
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/webview-tag.md",
|
|
40595
|
+
"version": "37.7.0",
|
|
40386
40596
|
"type": "Element",
|
|
40387
40597
|
"process": {
|
|
40388
40598
|
"main": false,
|
|
@@ -43527,8 +43737,8 @@
|
|
|
43527
43737
|
"description": "When setting minimum or maximum window size with `minWidth`/`maxWidth`/ `minHeight`/`maxHeight`, it only constrains the users. It won't prevent you from passing a size that does not follow size constraints to `setBounds`/`setSize` or to the constructor of `BrowserWindow`.\n\nThe possible values and behaviors of the `type` option are platform dependent. Possible values are:\n\n* On Linux, possible types are `desktop`, `dock`, `toolbar`, `splash`, `notification`.\n * The `desktop` type places the window at the desktop background window level (kCGDesktopWindowLevel - 1). However, note that a desktop window will not receive focus, keyboard, or mouse events. You can still use globalShortcut to receive input sparingly.\n * The `dock` type creates a dock-like window behavior.\n * The `toolbar` type creates a window with a toolbar appearance.\n * The `splash` type behaves in a specific way. It is not draggable, even if the CSS styling of the window's body contains -webkit-app-region: drag. This type is commonly used for splash screens.\n * The `notification` type creates a window that behaves like a system notification.\n* On macOS, possible types are `desktop`, `textured`, `panel`.\n * The `textured` type adds metal gradient appearance. This option is **deprecated**.\n * The `desktop` type places the window at the desktop background window level (`kCGDesktopWindowLevel - 1`). Note that desktop window will not receive focus, keyboard or mouse events, but you can use `globalShortcut` to receive input sparingly.\n * The `panel` type enables the window to float on top of full-screened apps by adding the `NSWindowStyleMaskNonactivatingPanel` style mask, normally reserved for NSPanel, at runtime. Also, the window will appear on all spaces (desktops).\n* On Windows, possible type is `toolbar`.",
|
|
43528
43738
|
"slug": "base-window-options",
|
|
43529
43739
|
"websiteUrl": "https://electronjs.org/docs/api/structures/base-window-options",
|
|
43530
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
43531
|
-
"version": "37.
|
|
43740
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/base-window-options.md",
|
|
43741
|
+
"version": "37.7.0",
|
|
43532
43742
|
"properties": [
|
|
43533
43743
|
{
|
|
43534
43744
|
"name": "width",
|
|
@@ -44167,8 +44377,8 @@
|
|
|
44167
44377
|
"description": "",
|
|
44168
44378
|
"slug": "bluetooth-device",
|
|
44169
44379
|
"websiteUrl": "https://electronjs.org/docs/api/structures/bluetooth-device",
|
|
44170
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44171
|
-
"version": "37.
|
|
44380
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/bluetooth-device.md",
|
|
44381
|
+
"version": "37.7.0",
|
|
44172
44382
|
"properties": [
|
|
44173
44383
|
{
|
|
44174
44384
|
"name": "deviceName",
|
|
@@ -44197,8 +44407,8 @@
|
|
|
44197
44407
|
"description": "",
|
|
44198
44408
|
"slug": "browser-window-options",
|
|
44199
44409
|
"websiteUrl": "https://electronjs.org/docs/api/structures/browser-window-options",
|
|
44200
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44201
|
-
"version": "37.
|
|
44410
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/browser-window-options.md",
|
|
44411
|
+
"version": "37.7.0",
|
|
44202
44412
|
"properties": [
|
|
44203
44413
|
{
|
|
44204
44414
|
"name": "webPreferences",
|
|
@@ -44224,8 +44434,8 @@
|
|
|
44224
44434
|
"description": "",
|
|
44225
44435
|
"slug": "certificate-principal",
|
|
44226
44436
|
"websiteUrl": "https://electronjs.org/docs/api/structures/certificate-principal",
|
|
44227
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44228
|
-
"version": "37.
|
|
44437
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/certificate-principal.md",
|
|
44438
|
+
"version": "37.7.0",
|
|
44229
44439
|
"properties": [
|
|
44230
44440
|
{
|
|
44231
44441
|
"name": "commonName",
|
|
@@ -44289,8 +44499,8 @@
|
|
|
44289
44499
|
"description": "",
|
|
44290
44500
|
"slug": "certificate",
|
|
44291
44501
|
"websiteUrl": "https://electronjs.org/docs/api/structures/certificate",
|
|
44292
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44293
|
-
"version": "37.
|
|
44502
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/certificate.md",
|
|
44503
|
+
"version": "37.7.0",
|
|
44294
44504
|
"properties": [
|
|
44295
44505
|
{
|
|
44296
44506
|
"name": "data",
|
|
@@ -44385,8 +44595,8 @@
|
|
|
44385
44595
|
"description": "",
|
|
44386
44596
|
"slug": "cookie",
|
|
44387
44597
|
"websiteUrl": "https://electronjs.org/docs/api/structures/cookie",
|
|
44388
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44389
|
-
"version": "37.
|
|
44598
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/cookie.md",
|
|
44599
|
+
"version": "37.7.0",
|
|
44390
44600
|
"properties": [
|
|
44391
44601
|
{
|
|
44392
44602
|
"name": "name",
|
|
@@ -44498,8 +44708,8 @@
|
|
|
44498
44708
|
"description": "",
|
|
44499
44709
|
"slug": "cpu-usage",
|
|
44500
44710
|
"websiteUrl": "https://electronjs.org/docs/api/structures/cpu-usage",
|
|
44501
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44502
|
-
"version": "37.
|
|
44711
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/cpu-usage.md",
|
|
44712
|
+
"version": "37.7.0",
|
|
44503
44713
|
"properties": [
|
|
44504
44714
|
{
|
|
44505
44715
|
"name": "percentCPUUsage",
|
|
@@ -44533,8 +44743,8 @@
|
|
|
44533
44743
|
"description": "",
|
|
44534
44744
|
"slug": "crash-report",
|
|
44535
44745
|
"websiteUrl": "https://electronjs.org/docs/api/structures/crash-report",
|
|
44536
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44537
|
-
"version": "37.
|
|
44746
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/crash-report.md",
|
|
44747
|
+
"version": "37.7.0",
|
|
44538
44748
|
"properties": [
|
|
44539
44749
|
{
|
|
44540
44750
|
"name": "date",
|
|
@@ -44561,8 +44771,8 @@
|
|
|
44561
44771
|
"description": "",
|
|
44562
44772
|
"slug": "custom-scheme",
|
|
44563
44773
|
"websiteUrl": "https://electronjs.org/docs/api/structures/custom-scheme",
|
|
44564
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44565
|
-
"version": "37.
|
|
44774
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/custom-scheme.md",
|
|
44775
|
+
"version": "37.7.0",
|
|
44566
44776
|
"properties": [
|
|
44567
44777
|
{
|
|
44568
44778
|
"name": "scheme",
|
|
@@ -44655,8 +44865,8 @@
|
|
|
44655
44865
|
"description": "",
|
|
44656
44866
|
"slug": "desktop-capturer-source",
|
|
44657
44867
|
"websiteUrl": "https://electronjs.org/docs/api/structures/desktop-capturer-source",
|
|
44658
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44659
|
-
"version": "37.
|
|
44868
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/desktop-capturer-source.md",
|
|
44869
|
+
"version": "37.7.0",
|
|
44660
44870
|
"properties": [
|
|
44661
44871
|
{
|
|
44662
44872
|
"name": "id",
|
|
@@ -44709,8 +44919,8 @@
|
|
|
44709
44919
|
"description": "The `Display` object represents a physical display connected to the system. A fake `Display` may exist on a headless system, or a `Display` may correspond to a remote, virtual display.",
|
|
44710
44920
|
"slug": "display",
|
|
44711
44921
|
"websiteUrl": "https://electronjs.org/docs/api/structures/display",
|
|
44712
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44713
|
-
"version": "37.
|
|
44922
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/display.md",
|
|
44923
|
+
"version": "37.7.0",
|
|
44714
44924
|
"properties": [
|
|
44715
44925
|
{
|
|
44716
44926
|
"name": "accelerometerSupport",
|
|
@@ -44902,8 +45112,8 @@
|
|
|
44902
45112
|
"description": "",
|
|
44903
45113
|
"slug": "extension-info",
|
|
44904
45114
|
"websiteUrl": "https://electronjs.org/docs/api/structures/extension-info",
|
|
44905
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44906
|
-
"version": "37.
|
|
45115
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/extension-info.md",
|
|
45116
|
+
"version": "37.7.0",
|
|
44907
45117
|
"properties": [
|
|
44908
45118
|
{
|
|
44909
45119
|
"name": "name",
|
|
@@ -44931,8 +45141,8 @@
|
|
|
44931
45141
|
"description": "",
|
|
44932
45142
|
"slug": "extension",
|
|
44933
45143
|
"websiteUrl": "https://electronjs.org/docs/api/structures/extension",
|
|
44934
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44935
|
-
"version": "37.
|
|
45144
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/extension.md",
|
|
45145
|
+
"version": "37.7.0",
|
|
44936
45146
|
"properties": [
|
|
44937
45147
|
{
|
|
44938
45148
|
"name": "id",
|
|
@@ -44995,8 +45205,8 @@
|
|
|
44995
45205
|
"description": "",
|
|
44996
45206
|
"slug": "file-filter",
|
|
44997
45207
|
"websiteUrl": "https://electronjs.org/docs/api/structures/file-filter",
|
|
44998
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44999
|
-
"version": "37.
|
|
45208
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/file-filter.md",
|
|
45209
|
+
"version": "37.7.0",
|
|
45000
45210
|
"properties": [
|
|
45001
45211
|
{
|
|
45002
45212
|
"name": "name",
|
|
@@ -45024,8 +45234,8 @@
|
|
|
45024
45234
|
"description": "",
|
|
45025
45235
|
"slug": "file-path-with-headers",
|
|
45026
45236
|
"websiteUrl": "https://electronjs.org/docs/api/structures/file-path-with-headers",
|
|
45027
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45028
|
-
"version": "37.
|
|
45237
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/file-path-with-headers.md",
|
|
45238
|
+
"version": "37.7.0",
|
|
45029
45239
|
"properties": [
|
|
45030
45240
|
{
|
|
45031
45241
|
"name": "path",
|
|
@@ -45065,8 +45275,8 @@
|
|
|
45065
45275
|
"description": "",
|
|
45066
45276
|
"slug": "filesystem-permission-request",
|
|
45067
45277
|
"websiteUrl": "https://electronjs.org/docs/api/structures/filesystem-permission-request",
|
|
45068
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45069
|
-
"version": "37.
|
|
45278
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/filesystem-permission-request.md",
|
|
45279
|
+
"version": "37.7.0",
|
|
45070
45280
|
"properties": [
|
|
45071
45281
|
{
|
|
45072
45282
|
"name": "filePath",
|
|
@@ -45111,8 +45321,8 @@
|
|
|
45111
45321
|
"description": "Possible values:\n\n* `disabled_software` - Software only. Hardware acceleration disabled (yellow)\n* `disabled_off` - Disabled (red)\n* `disabled_off_ok` - Disabled (yellow)\n* `unavailable_software` - Software only, hardware acceleration unavailable (yellow)\n* `unavailable_off` - Unavailable (red)\n* `unavailable_off_ok` - Unavailable (yellow)\n* `enabled_readback` - Hardware accelerated but at reduced performance (yellow)\n* `enabled_force` - Hardware accelerated on all pages (green)\n* `enabled` - Hardware accelerated (green)\n* `enabled_on` - Enabled (green)\n* `enabled_force_on` - Force enabled (green)",
|
|
45112
45322
|
"slug": "gpu-feature-status",
|
|
45113
45323
|
"websiteUrl": "https://electronjs.org/docs/api/structures/gpu-feature-status",
|
|
45114
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45115
|
-
"version": "37.
|
|
45324
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/gpu-feature-status.md",
|
|
45325
|
+
"version": "37.7.0",
|
|
45116
45326
|
"properties": [
|
|
45117
45327
|
{
|
|
45118
45328
|
"name": "2d_canvas",
|
|
@@ -45239,8 +45449,8 @@
|
|
|
45239
45449
|
"description": "",
|
|
45240
45450
|
"slug": "hid-device",
|
|
45241
45451
|
"websiteUrl": "https://electronjs.org/docs/api/structures/hid-device",
|
|
45242
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45243
|
-
"version": "37.
|
|
45452
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/hid-device.md",
|
|
45453
|
+
"version": "37.7.0",
|
|
45244
45454
|
"properties": [
|
|
45245
45455
|
{
|
|
45246
45456
|
"name": "deviceId",
|
|
@@ -45372,8 +45582,8 @@
|
|
|
45372
45582
|
"description": "",
|
|
45373
45583
|
"slug": "input-event",
|
|
45374
45584
|
"websiteUrl": "https://electronjs.org/docs/api/structures/input-event",
|
|
45375
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45376
|
-
"version": "37.
|
|
45585
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/input-event.md",
|
|
45586
|
+
"version": "37.7.0",
|
|
45377
45587
|
"properties": [
|
|
45378
45588
|
{
|
|
45379
45589
|
"name": "type",
|
|
@@ -45632,8 +45842,8 @@
|
|
|
45632
45842
|
"description": "",
|
|
45633
45843
|
"slug": "ipc-main-event",
|
|
45634
45844
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-event",
|
|
45635
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45636
|
-
"version": "37.
|
|
45845
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/ipc-main-event.md",
|
|
45846
|
+
"version": "37.7.0",
|
|
45637
45847
|
"properties": [
|
|
45638
45848
|
{
|
|
45639
45849
|
"name": "type",
|
|
@@ -45743,8 +45953,8 @@
|
|
|
45743
45953
|
"description": "",
|
|
45744
45954
|
"slug": "ipc-main-invoke-event",
|
|
45745
45955
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-invoke-event",
|
|
45746
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45747
|
-
"version": "37.
|
|
45956
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/ipc-main-invoke-event.md",
|
|
45957
|
+
"version": "37.7.0",
|
|
45748
45958
|
"properties": [
|
|
45749
45959
|
{
|
|
45750
45960
|
"name": "type",
|
|
@@ -45812,8 +46022,8 @@
|
|
|
45812
46022
|
"description": "",
|
|
45813
46023
|
"slug": "ipc-main-service-worker-event",
|
|
45814
46024
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-service-worker-event",
|
|
45815
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45816
|
-
"version": "37.
|
|
46025
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/ipc-main-service-worker-event.md",
|
|
46026
|
+
"version": "37.7.0",
|
|
45817
46027
|
"properties": [
|
|
45818
46028
|
{
|
|
45819
46029
|
"name": "type",
|
|
@@ -45906,8 +46116,8 @@
|
|
|
45906
46116
|
"description": "",
|
|
45907
46117
|
"slug": "ipc-main-service-worker-invoke-event",
|
|
45908
46118
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-service-worker-invoke-event",
|
|
45909
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45910
|
-
"version": "37.
|
|
46119
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/ipc-main-service-worker-invoke-event.md",
|
|
46120
|
+
"version": "37.7.0",
|
|
45911
46121
|
"properties": [
|
|
45912
46122
|
{
|
|
45913
46123
|
"name": "type",
|
|
@@ -45958,8 +46168,8 @@
|
|
|
45958
46168
|
"description": "",
|
|
45959
46169
|
"slug": "ipc-renderer-event",
|
|
45960
46170
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-renderer-event",
|
|
45961
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45962
|
-
"version": "37.
|
|
46171
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/ipc-renderer-event.md",
|
|
46172
|
+
"version": "37.7.0",
|
|
45963
46173
|
"properties": [
|
|
45964
46174
|
{
|
|
45965
46175
|
"name": "sender",
|
|
@@ -45985,8 +46195,8 @@
|
|
|
45985
46195
|
"description": "> [!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`.\n\n> [!NOTE] The maximum length of a Jump List item's `description` property is 260 characters. Beyond this limit, the item will not be added to the Jump List, nor will it be displayed.",
|
|
45986
46196
|
"slug": "jump-list-category",
|
|
45987
46197
|
"websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-category",
|
|
45988
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45989
|
-
"version": "37.
|
|
46198
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/jump-list-category.md",
|
|
46199
|
+
"version": "37.7.0",
|
|
45990
46200
|
"properties": [
|
|
45991
46201
|
{
|
|
45992
46202
|
"name": "type",
|
|
@@ -46039,8 +46249,8 @@
|
|
|
46039
46249
|
"description": "",
|
|
46040
46250
|
"slug": "jump-list-item",
|
|
46041
46251
|
"websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-item",
|
|
46042
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46043
|
-
"version": "37.
|
|
46252
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/jump-list-item.md",
|
|
46253
|
+
"version": "37.7.0",
|
|
46044
46254
|
"properties": [
|
|
46045
46255
|
{
|
|
46046
46256
|
"name": "type",
|
|
@@ -46143,8 +46353,8 @@
|
|
|
46143
46353
|
"description": "",
|
|
46144
46354
|
"slug": "keyboard-event",
|
|
46145
46355
|
"websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-event",
|
|
46146
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46147
|
-
"version": "37.
|
|
46356
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/keyboard-event.md",
|
|
46357
|
+
"version": "37.7.0",
|
|
46148
46358
|
"properties": [
|
|
46149
46359
|
{
|
|
46150
46360
|
"name": "ctrlKey",
|
|
@@ -46195,8 +46405,8 @@
|
|
|
46195
46405
|
"description": "",
|
|
46196
46406
|
"slug": "keyboard-input-event",
|
|
46197
46407
|
"websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-input-event",
|
|
46198
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46199
|
-
"version": "37.
|
|
46408
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/keyboard-input-event.md",
|
|
46409
|
+
"version": "37.7.0",
|
|
46200
46410
|
"properties": [
|
|
46201
46411
|
{
|
|
46202
46412
|
"name": "type",
|
|
@@ -46242,8 +46452,8 @@
|
|
|
46242
46452
|
"description": "",
|
|
46243
46453
|
"slug": "media-access-permission-request",
|
|
46244
46454
|
"websiteUrl": "https://electronjs.org/docs/api/structures/media-access-permission-request",
|
|
46245
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46246
|
-
"version": "37.
|
|
46455
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/media-access-permission-request.md",
|
|
46456
|
+
"version": "37.7.0",
|
|
46247
46457
|
"properties": [
|
|
46248
46458
|
{
|
|
46249
46459
|
"name": "securityOrigin",
|
|
@@ -46280,8 +46490,8 @@
|
|
|
46280
46490
|
"description": "Note that all statistics are reported in Kilobytes.",
|
|
46281
46491
|
"slug": "memory-info",
|
|
46282
46492
|
"websiteUrl": "https://electronjs.org/docs/api/structures/memory-info",
|
|
46283
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46284
|
-
"version": "37.
|
|
46493
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/memory-info.md",
|
|
46494
|
+
"version": "37.7.0",
|
|
46285
46495
|
"properties": [
|
|
46286
46496
|
{
|
|
46287
46497
|
"name": "workingSetSize",
|
|
@@ -46317,8 +46527,8 @@
|
|
|
46317
46527
|
"description": "",
|
|
46318
46528
|
"slug": "memory-usage-details",
|
|
46319
46529
|
"websiteUrl": "https://electronjs.org/docs/api/structures/memory-usage-details",
|
|
46320
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46321
|
-
"version": "37.
|
|
46530
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/memory-usage-details.md",
|
|
46531
|
+
"version": "37.7.0",
|
|
46322
46532
|
"properties": [
|
|
46323
46533
|
{
|
|
46324
46534
|
"name": "count",
|
|
@@ -46352,8 +46562,8 @@
|
|
|
46352
46562
|
"description": "",
|
|
46353
46563
|
"slug": "mime-typed-buffer",
|
|
46354
46564
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mime-typed-buffer",
|
|
46355
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46356
|
-
"version": "37.
|
|
46565
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/mime-typed-buffer.md",
|
|
46566
|
+
"version": "37.7.0",
|
|
46357
46567
|
"properties": [
|
|
46358
46568
|
{
|
|
46359
46569
|
"name": "mimeType",
|
|
@@ -46390,8 +46600,8 @@
|
|
|
46390
46600
|
"description": "",
|
|
46391
46601
|
"slug": "mouse-input-event",
|
|
46392
46602
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mouse-input-event",
|
|
46393
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46394
|
-
"version": "37.
|
|
46603
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/mouse-input-event.md",
|
|
46604
|
+
"version": "37.7.0",
|
|
46395
46605
|
"properties": [
|
|
46396
46606
|
{
|
|
46397
46607
|
"name": "type",
|
|
@@ -46518,8 +46728,8 @@
|
|
|
46518
46728
|
"description": "",
|
|
46519
46729
|
"slug": "mouse-wheel-input-event",
|
|
46520
46730
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mouse-wheel-input-event",
|
|
46521
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46522
|
-
"version": "37.
|
|
46731
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/mouse-wheel-input-event.md",
|
|
46732
|
+
"version": "37.7.0",
|
|
46523
46733
|
"properties": [
|
|
46524
46734
|
{
|
|
46525
46735
|
"name": "type",
|
|
@@ -46607,8 +46817,8 @@
|
|
|
46607
46817
|
"description": "",
|
|
46608
46818
|
"slug": "navigation-entry",
|
|
46609
46819
|
"websiteUrl": "https://electronjs.org/docs/api/structures/navigation-entry",
|
|
46610
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46611
|
-
"version": "37.
|
|
46820
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/navigation-entry.md",
|
|
46821
|
+
"version": "37.7.0",
|
|
46612
46822
|
"properties": [
|
|
46613
46823
|
{
|
|
46614
46824
|
"name": "url",
|
|
@@ -46645,8 +46855,8 @@
|
|
|
46645
46855
|
"description": "",
|
|
46646
46856
|
"slug": "notification-action",
|
|
46647
46857
|
"websiteUrl": "https://electronjs.org/docs/api/structures/notification-action",
|
|
46648
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46649
|
-
"version": "37.
|
|
46858
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/notification-action.md",
|
|
46859
|
+
"version": "37.7.0",
|
|
46650
46860
|
"properties": [
|
|
46651
46861
|
{
|
|
46652
46862
|
"name": "type",
|
|
@@ -46679,8 +46889,8 @@
|
|
|
46679
46889
|
"description": "",
|
|
46680
46890
|
"slug": "notification-response",
|
|
46681
46891
|
"websiteUrl": "https://electronjs.org/docs/api/structures/notification-response",
|
|
46682
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46683
|
-
"version": "37.
|
|
46892
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/notification-response.md",
|
|
46893
|
+
"version": "37.7.0",
|
|
46684
46894
|
"properties": [
|
|
46685
46895
|
{
|
|
46686
46896
|
"name": "actionIdentifier",
|
|
@@ -46744,8 +46954,8 @@
|
|
|
46744
46954
|
"description": "",
|
|
46745
46955
|
"slug": "offscreen-shared-texture",
|
|
46746
46956
|
"websiteUrl": "https://electronjs.org/docs/api/structures/offscreen-shared-texture",
|
|
46747
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46748
|
-
"version": "37.
|
|
46957
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/offscreen-shared-texture.md",
|
|
46958
|
+
"version": "37.7.0",
|
|
46749
46959
|
"properties": [
|
|
46750
46960
|
{
|
|
46751
46961
|
"name": "textureInfo",
|
|
@@ -46952,8 +47162,8 @@
|
|
|
46952
47162
|
"description": "",
|
|
46953
47163
|
"slug": "open-external-permission-request",
|
|
46954
47164
|
"websiteUrl": "https://electronjs.org/docs/api/structures/open-external-permission-request",
|
|
46955
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46956
|
-
"version": "37.
|
|
47165
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/open-external-permission-request.md",
|
|
47166
|
+
"version": "37.7.0",
|
|
46957
47167
|
"properties": [
|
|
46958
47168
|
{
|
|
46959
47169
|
"name": "externalURL",
|
|
@@ -46972,8 +47182,8 @@
|
|
|
46972
47182
|
"description": "",
|
|
46973
47183
|
"slug": "payment-discount",
|
|
46974
47184
|
"websiteUrl": "https://electronjs.org/docs/api/structures/payment-discount",
|
|
46975
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46976
|
-
"version": "37.
|
|
47185
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/payment-discount.md",
|
|
47186
|
+
"version": "37.7.0",
|
|
46977
47187
|
"properties": [
|
|
46978
47188
|
{
|
|
46979
47189
|
"name": "identifier",
|
|
@@ -47027,8 +47237,8 @@
|
|
|
47027
47237
|
"description": "",
|
|
47028
47238
|
"slug": "permission-request",
|
|
47029
47239
|
"websiteUrl": "https://electronjs.org/docs/api/structures/permission-request",
|
|
47030
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47031
|
-
"version": "37.
|
|
47240
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/permission-request.md",
|
|
47241
|
+
"version": "37.7.0",
|
|
47032
47242
|
"properties": [
|
|
47033
47243
|
{
|
|
47034
47244
|
"name": "requestingUrl",
|
|
@@ -47055,8 +47265,8 @@
|
|
|
47055
47265
|
"description": "> [!NOTE] Both `x` and `y` must be whole integers, when providing a point object as input to an Electron API we will automatically round your `x` and `y` values to the nearest whole integer.",
|
|
47056
47266
|
"slug": "point",
|
|
47057
47267
|
"websiteUrl": "https://electronjs.org/docs/api/structures/point",
|
|
47058
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47059
|
-
"version": "37.
|
|
47268
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/point.md",
|
|
47269
|
+
"version": "37.7.0",
|
|
47060
47270
|
"properties": [
|
|
47061
47271
|
{
|
|
47062
47272
|
"name": "x",
|
|
@@ -47082,8 +47292,8 @@
|
|
|
47082
47292
|
"description": "",
|
|
47083
47293
|
"slug": "post-body",
|
|
47084
47294
|
"websiteUrl": "https://electronjs.org/docs/api/structures/post-body",
|
|
47085
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47086
|
-
"version": "37.
|
|
47295
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/post-body.md",
|
|
47296
|
+
"version": "37.7.0",
|
|
47087
47297
|
"properties": [
|
|
47088
47298
|
{
|
|
47089
47299
|
"name": "data",
|
|
@@ -47128,8 +47338,8 @@
|
|
|
47128
47338
|
"description": "",
|
|
47129
47339
|
"slug": "preload-script-registration",
|
|
47130
47340
|
"websiteUrl": "https://electronjs.org/docs/api/structures/preload-script-registration",
|
|
47131
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47132
|
-
"version": "37.
|
|
47341
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/preload-script-registration.md",
|
|
47342
|
+
"version": "37.7.0",
|
|
47133
47343
|
"properties": [
|
|
47134
47344
|
{
|
|
47135
47345
|
"name": "type",
|
|
@@ -47175,8 +47385,8 @@
|
|
|
47175
47385
|
"description": "",
|
|
47176
47386
|
"slug": "preload-script",
|
|
47177
47387
|
"websiteUrl": "https://electronjs.org/docs/api/structures/preload-script",
|
|
47178
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47179
|
-
"version": "37.
|
|
47388
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/preload-script.md",
|
|
47389
|
+
"version": "37.7.0",
|
|
47180
47390
|
"properties": [
|
|
47181
47391
|
{
|
|
47182
47392
|
"name": "type",
|
|
@@ -47222,8 +47432,8 @@
|
|
|
47222
47432
|
"description": "",
|
|
47223
47433
|
"slug": "printer-info",
|
|
47224
47434
|
"websiteUrl": "https://electronjs.org/docs/api/structures/printer-info",
|
|
47225
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47226
|
-
"version": "37.
|
|
47435
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/printer-info.md",
|
|
47436
|
+
"version": "37.7.0",
|
|
47227
47437
|
"properties": [
|
|
47228
47438
|
{
|
|
47229
47439
|
"name": "name",
|
|
@@ -47269,8 +47479,8 @@
|
|
|
47269
47479
|
"description": "",
|
|
47270
47480
|
"slug": "process-memory-info",
|
|
47271
47481
|
"websiteUrl": "https://electronjs.org/docs/api/structures/process-memory-info",
|
|
47272
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47273
|
-
"version": "37.
|
|
47482
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/process-memory-info.md",
|
|
47483
|
+
"version": "37.7.0",
|
|
47274
47484
|
"properties": [
|
|
47275
47485
|
{
|
|
47276
47486
|
"name": "residentSet",
|
|
@@ -47307,8 +47517,8 @@
|
|
|
47307
47517
|
"description": "",
|
|
47308
47518
|
"slug": "process-metric",
|
|
47309
47519
|
"websiteUrl": "https://electronjs.org/docs/api/structures/process-metric",
|
|
47310
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47311
|
-
"version": "37.
|
|
47520
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/process-metric.md",
|
|
47521
|
+
"version": "37.7.0",
|
|
47312
47522
|
"properties": [
|
|
47313
47523
|
{
|
|
47314
47524
|
"name": "pid",
|
|
@@ -47457,8 +47667,8 @@
|
|
|
47457
47667
|
"description": "",
|
|
47458
47668
|
"slug": "product-discount",
|
|
47459
47669
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product-discount",
|
|
47460
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47461
|
-
"version": "37.
|
|
47670
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/product-discount.md",
|
|
47671
|
+
"version": "37.7.0",
|
|
47462
47672
|
"properties": [
|
|
47463
47673
|
{
|
|
47464
47674
|
"name": "identifier",
|
|
@@ -47540,8 +47750,8 @@
|
|
|
47540
47750
|
"description": "",
|
|
47541
47751
|
"slug": "product-subscription-period",
|
|
47542
47752
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product-subscription-period",
|
|
47543
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47544
|
-
"version": "37.
|
|
47753
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/product-subscription-period.md",
|
|
47754
|
+
"version": "37.7.0",
|
|
47545
47755
|
"properties": [
|
|
47546
47756
|
{
|
|
47547
47757
|
"name": "numberOfUnits",
|
|
@@ -47585,8 +47795,8 @@
|
|
|
47585
47795
|
"description": "",
|
|
47586
47796
|
"slug": "product",
|
|
47587
47797
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product",
|
|
47588
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47589
|
-
"version": "37.
|
|
47798
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/product.md",
|
|
47799
|
+
"version": "37.7.0",
|
|
47590
47800
|
"properties": [
|
|
47591
47801
|
{
|
|
47592
47802
|
"name": "productIdentifier",
|
|
@@ -47707,8 +47917,8 @@
|
|
|
47707
47917
|
"description": "",
|
|
47708
47918
|
"slug": "protocol-request",
|
|
47709
47919
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-request",
|
|
47710
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47711
|
-
"version": "37.
|
|
47920
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/protocol-request.md",
|
|
47921
|
+
"version": "37.7.0",
|
|
47712
47922
|
"properties": [
|
|
47713
47923
|
{
|
|
47714
47924
|
"name": "url",
|
|
@@ -47773,8 +47983,8 @@
|
|
|
47773
47983
|
"description": "",
|
|
47774
47984
|
"slug": "protocol-response-upload-data",
|
|
47775
47985
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response-upload-data",
|
|
47776
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47777
|
-
"version": "37.
|
|
47986
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/protocol-response-upload-data.md",
|
|
47987
|
+
"version": "37.7.0",
|
|
47778
47988
|
"properties": [
|
|
47779
47989
|
{
|
|
47780
47990
|
"name": "contentType",
|
|
@@ -47811,8 +48021,8 @@
|
|
|
47811
48021
|
"description": "",
|
|
47812
48022
|
"slug": "protocol-response",
|
|
47813
48023
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response",
|
|
47814
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47815
|
-
"version": "37.
|
|
48024
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/protocol-response.md",
|
|
48025
|
+
"version": "37.7.0",
|
|
47816
48026
|
"properties": [
|
|
47817
48027
|
{
|
|
47818
48028
|
"name": "error",
|
|
@@ -47960,8 +48170,8 @@
|
|
|
47960
48170
|
"description": "When `mode` is unspecified, `pacScript` and `proxyRules` are provided together, the `proxyRules` option is ignored and `pacScript` configuration is applied.\n\nThe `proxyRules` has to follow the rules below:\n\nFor example:\n\n* `http=foopy:80;ftp=foopy2` - Use HTTP proxy `foopy:80` for `http://` URLs, and HTTP proxy `foopy2:80` for `ftp://` URLs.\n* `foopy:80` - Use HTTP proxy `foopy:80` for all URLs.\n* `foopy:80,bar,direct://` - Use HTTP proxy `foopy:80` for all URLs, failing over to `bar` if `foopy:80` is unavailable, and after that using no proxy.\n* `socks4://foopy` - Use SOCKS v4 proxy `foopy:1080` for all URLs.\n* `http=foopy,socks5://bar.com` - Use HTTP proxy `foopy` for http URLs, and fail over to the SOCKS5 proxy `bar.com` if `foopy` is unavailable.\n* `http=foopy,direct://` - Use HTTP proxy `foopy` for http URLs, and use no proxy if `foopy` is unavailable.\n* `http=foopy;socks=foopy2` - Use HTTP proxy `foopy` for http URLs, and use `socks4://foopy2` for all other URLs.\n\nThe `proxyBypassRules` is a comma separated list of rules described below:\n\n* `[ URL_SCHEME \"://\" ] HOSTNAME_PATTERN [ \":\" <port> ]`\n\nMatch all hostnames that match the pattern HOSTNAME_PATTERN.\n\nExamples: \"foobar.com\", \"*foobar.com\", \"*.foobar.com\", \"*foobar.com:99\", \"https://x.*.y.com:99\"\n* `\".\" HOSTNAME_SUFFIX_PATTERN [ \":\" PORT ]`\n\nMatch a particular domain suffix.\n\nExamples: \".google.com\", \".com\", \"http://.google.com\"\n* `[ SCHEME \"://\" ] IP_LITERAL [ \":\" PORT ]`\n\nMatch URLs which are IP address literals.\n\nExamples: \"127.0.1\", \"[0:0::1]\", \"[::1]\", \"http://[::1]:99\"\n* `IP_LITERAL \"/\" PREFIX_LENGTH_IN_BITS`\n\nMatch any URL that is to an IP literal that falls between the given range. IP range is specified using CIDR notation.\n\nExamples: \"192.168.1.1/16\", \"fefe:13::abc/33\".\n* `<local>`\n\nMatch local addresses. The meaning of `<local>` is whether the host matches one of: \"127.0.0.1\", \"::1\", \"localhost\".",
|
|
47961
48171
|
"slug": "proxy-config",
|
|
47962
48172
|
"websiteUrl": "https://electronjs.org/docs/api/structures/proxy-config",
|
|
47963
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47964
|
-
"version": "37.
|
|
48173
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/proxy-config.md",
|
|
48174
|
+
"version": "37.7.0",
|
|
47965
48175
|
"properties": [
|
|
47966
48176
|
{
|
|
47967
48177
|
"name": "mode",
|
|
@@ -48028,8 +48238,8 @@
|
|
|
48028
48238
|
"description": "",
|
|
48029
48239
|
"slug": "rectangle",
|
|
48030
48240
|
"websiteUrl": "https://electronjs.org/docs/api/structures/rectangle",
|
|
48031
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48032
|
-
"version": "37.
|
|
48241
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/rectangle.md",
|
|
48242
|
+
"version": "37.7.0",
|
|
48033
48243
|
"properties": [
|
|
48034
48244
|
{
|
|
48035
48245
|
"name": "x",
|
|
@@ -48071,8 +48281,8 @@
|
|
|
48071
48281
|
"description": "",
|
|
48072
48282
|
"slug": "referrer",
|
|
48073
48283
|
"websiteUrl": "https://electronjs.org/docs/api/structures/referrer",
|
|
48074
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48075
|
-
"version": "37.
|
|
48284
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/referrer.md",
|
|
48285
|
+
"version": "37.7.0",
|
|
48076
48286
|
"properties": [
|
|
48077
48287
|
{
|
|
48078
48288
|
"name": "url",
|
|
@@ -48133,8 +48343,8 @@
|
|
|
48133
48343
|
"description": "",
|
|
48134
48344
|
"slug": "render-process-gone-details",
|
|
48135
48345
|
"websiteUrl": "https://electronjs.org/docs/api/structures/render-process-gone-details",
|
|
48136
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48137
|
-
"version": "37.
|
|
48346
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/render-process-gone-details.md",
|
|
48347
|
+
"version": "37.7.0",
|
|
48138
48348
|
"properties": [
|
|
48139
48349
|
{
|
|
48140
48350
|
"name": "reason",
|
|
@@ -48190,8 +48400,8 @@
|
|
|
48190
48400
|
"description": "",
|
|
48191
48401
|
"slug": "resolved-endpoint",
|
|
48192
48402
|
"websiteUrl": "https://electronjs.org/docs/api/structures/resolved-endpoint",
|
|
48193
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48194
|
-
"version": "37.
|
|
48403
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/resolved-endpoint.md",
|
|
48404
|
+
"version": "37.7.0",
|
|
48195
48405
|
"properties": [
|
|
48196
48406
|
{
|
|
48197
48407
|
"name": "address",
|
|
@@ -48232,8 +48442,8 @@
|
|
|
48232
48442
|
"description": "",
|
|
48233
48443
|
"slug": "resolved-host",
|
|
48234
48444
|
"websiteUrl": "https://electronjs.org/docs/api/structures/resolved-host",
|
|
48235
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48236
|
-
"version": "37.
|
|
48445
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/resolved-host.md",
|
|
48446
|
+
"version": "37.7.0",
|
|
48237
48447
|
"properties": [
|
|
48238
48448
|
{
|
|
48239
48449
|
"name": "endpoints",
|
|
@@ -48251,8 +48461,8 @@
|
|
|
48251
48461
|
"description": "",
|
|
48252
48462
|
"slug": "scrubber-item",
|
|
48253
48463
|
"websiteUrl": "https://electronjs.org/docs/api/structures/scrubber-item",
|
|
48254
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48255
|
-
"version": "37.
|
|
48464
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/scrubber-item.md",
|
|
48465
|
+
"version": "37.7.0",
|
|
48256
48466
|
"properties": [
|
|
48257
48467
|
{
|
|
48258
48468
|
"name": "label",
|
|
@@ -48279,8 +48489,8 @@
|
|
|
48279
48489
|
"description": "",
|
|
48280
48490
|
"slug": "segmented-control-segment",
|
|
48281
48491
|
"websiteUrl": "https://electronjs.org/docs/api/structures/segmented-control-segment",
|
|
48282
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48283
|
-
"version": "37.
|
|
48492
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/segmented-control-segment.md",
|
|
48493
|
+
"version": "37.7.0",
|
|
48284
48494
|
"properties": [
|
|
48285
48495
|
{
|
|
48286
48496
|
"name": "label",
|
|
@@ -48315,8 +48525,8 @@
|
|
|
48315
48525
|
"description": "",
|
|
48316
48526
|
"slug": "serial-port",
|
|
48317
48527
|
"websiteUrl": "https://electronjs.org/docs/api/structures/serial-port",
|
|
48318
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48319
|
-
"version": "37.
|
|
48528
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/serial-port.md",
|
|
48529
|
+
"version": "37.7.0",
|
|
48320
48530
|
"properties": [
|
|
48321
48531
|
{
|
|
48322
48532
|
"name": "portId",
|
|
@@ -48402,8 +48612,8 @@
|
|
|
48402
48612
|
"description": "",
|
|
48403
48613
|
"slug": "service-worker-info",
|
|
48404
48614
|
"websiteUrl": "https://electronjs.org/docs/api/structures/service-worker-info",
|
|
48405
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48406
|
-
"version": "37.
|
|
48615
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/service-worker-info.md",
|
|
48616
|
+
"version": "37.7.0",
|
|
48407
48617
|
"properties": [
|
|
48408
48618
|
{
|
|
48409
48619
|
"name": "scriptUrl",
|
|
@@ -48447,8 +48657,8 @@
|
|
|
48447
48657
|
"description": "",
|
|
48448
48658
|
"slug": "shared-dictionary-info",
|
|
48449
48659
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shared-dictionary-info",
|
|
48450
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48451
|
-
"version": "37.
|
|
48660
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/shared-dictionary-info.md",
|
|
48661
|
+
"version": "37.7.0",
|
|
48452
48662
|
"properties": [
|
|
48453
48663
|
{
|
|
48454
48664
|
"name": "match",
|
|
@@ -48543,8 +48753,8 @@
|
|
|
48543
48753
|
"description": "",
|
|
48544
48754
|
"slug": "shared-dictionary-usage-info",
|
|
48545
48755
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shared-dictionary-usage-info",
|
|
48546
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48547
|
-
"version": "37.
|
|
48756
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/shared-dictionary-usage-info.md",
|
|
48757
|
+
"version": "37.7.0",
|
|
48548
48758
|
"properties": [
|
|
48549
48759
|
{
|
|
48550
48760
|
"name": "frameOrigin",
|
|
@@ -48580,8 +48790,8 @@
|
|
|
48580
48790
|
"description": "",
|
|
48581
48791
|
"slug": "shared-worker-info",
|
|
48582
48792
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shared-worker-info",
|
|
48583
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48584
|
-
"version": "37.
|
|
48793
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/shared-worker-info.md",
|
|
48794
|
+
"version": "37.7.0",
|
|
48585
48795
|
"properties": [
|
|
48586
48796
|
{
|
|
48587
48797
|
"name": "id",
|
|
@@ -48609,8 +48819,8 @@
|
|
|
48609
48819
|
"description": "",
|
|
48610
48820
|
"slug": "sharing-item",
|
|
48611
48821
|
"websiteUrl": "https://electronjs.org/docs/api/structures/sharing-item",
|
|
48612
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48613
|
-
"version": "37.
|
|
48822
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/sharing-item.md",
|
|
48823
|
+
"version": "37.7.0",
|
|
48614
48824
|
"properties": [
|
|
48615
48825
|
{
|
|
48616
48826
|
"name": "texts",
|
|
@@ -48647,8 +48857,8 @@
|
|
|
48647
48857
|
"description": "",
|
|
48648
48858
|
"slug": "shortcut-details",
|
|
48649
48859
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shortcut-details",
|
|
48650
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48651
|
-
"version": "37.
|
|
48860
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/shortcut-details.md",
|
|
48861
|
+
"version": "37.7.0",
|
|
48652
48862
|
"properties": [
|
|
48653
48863
|
{
|
|
48654
48864
|
"name": "target",
|
|
@@ -48729,8 +48939,8 @@
|
|
|
48729
48939
|
"description": "",
|
|
48730
48940
|
"slug": "size",
|
|
48731
48941
|
"websiteUrl": "https://electronjs.org/docs/api/structures/size",
|
|
48732
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48733
|
-
"version": "37.
|
|
48942
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/size.md",
|
|
48943
|
+
"version": "37.7.0",
|
|
48734
48944
|
"properties": [
|
|
48735
48945
|
{
|
|
48736
48946
|
"name": "width",
|
|
@@ -48756,8 +48966,8 @@
|
|
|
48756
48966
|
"description": "",
|
|
48757
48967
|
"slug": "task",
|
|
48758
48968
|
"websiteUrl": "https://electronjs.org/docs/api/structures/task",
|
|
48759
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48760
|
-
"version": "37.
|
|
48969
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/task.md",
|
|
48970
|
+
"version": "37.7.0",
|
|
48761
48971
|
"properties": [
|
|
48762
48972
|
{
|
|
48763
48973
|
"name": "program",
|
|
@@ -48829,8 +49039,8 @@
|
|
|
48829
49039
|
"description": "The `flags` is an array that can include following `string`s:\n\n* `enabled` - The button is active and available to the user.\n* `disabled` - The button is disabled. It is present, but has a visual state indicating it will not respond to user action.\n* `dismissonclick` - When the button is clicked, the thumbnail window closes immediately.\n* `nobackground` - Do not draw a button border, use only the image.\n* `hidden` - The button is not shown to the user.\n* `noninteractive` - The button is enabled but not interactive; no pressed button state is drawn. This value is intended for instances where the button is used in a notification.",
|
|
48830
49040
|
"slug": "thumbar-button",
|
|
48831
49041
|
"websiteUrl": "https://electronjs.org/docs/api/structures/thumbar-button",
|
|
48832
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48833
|
-
"version": "37.
|
|
49042
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/thumbar-button.md",
|
|
49043
|
+
"version": "37.7.0",
|
|
48834
49044
|
"properties": [
|
|
48835
49045
|
{
|
|
48836
49046
|
"name": "icon",
|
|
@@ -48876,8 +49086,8 @@
|
|
|
48876
49086
|
"description": "",
|
|
48877
49087
|
"slug": "trace-categories-and-options",
|
|
48878
49088
|
"websiteUrl": "https://electronjs.org/docs/api/structures/trace-categories-and-options",
|
|
48879
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48880
|
-
"version": "37.
|
|
49089
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/trace-categories-and-options.md",
|
|
49090
|
+
"version": "37.7.0",
|
|
48881
49091
|
"properties": [
|
|
48882
49092
|
{
|
|
48883
49093
|
"name": "categoryFilter",
|
|
@@ -48905,8 +49115,8 @@
|
|
|
48905
49115
|
"description": "An example TraceConfig that roughly matches what Chrome DevTools records:",
|
|
48906
49116
|
"slug": "trace-config",
|
|
48907
49117
|
"websiteUrl": "https://electronjs.org/docs/api/structures/trace-config",
|
|
48908
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48909
|
-
"version": "37.
|
|
49118
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/trace-config.md",
|
|
49119
|
+
"version": "37.7.0",
|
|
48910
49120
|
"properties": [
|
|
48911
49121
|
{
|
|
48912
49122
|
"name": "recording_mode",
|
|
@@ -49020,8 +49230,8 @@
|
|
|
49020
49230
|
"description": "",
|
|
49021
49231
|
"slug": "transaction",
|
|
49022
49232
|
"websiteUrl": "https://electronjs.org/docs/api/structures/transaction",
|
|
49023
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49024
|
-
"version": "37.
|
|
49233
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/transaction.md",
|
|
49234
|
+
"version": "37.7.0",
|
|
49025
49235
|
"properties": [
|
|
49026
49236
|
{
|
|
49027
49237
|
"name": "transactionIdentifier",
|
|
@@ -49149,8 +49359,8 @@
|
|
|
49149
49359
|
"description": "",
|
|
49150
49360
|
"slug": "upload-data",
|
|
49151
49361
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-data",
|
|
49152
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49153
|
-
"version": "37.
|
|
49362
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/upload-data.md",
|
|
49363
|
+
"version": "37.7.0",
|
|
49154
49364
|
"properties": [
|
|
49155
49365
|
{
|
|
49156
49366
|
"name": "bytes",
|
|
@@ -49186,8 +49396,8 @@
|
|
|
49186
49396
|
"description": "",
|
|
49187
49397
|
"slug": "upload-file",
|
|
49188
49398
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-file",
|
|
49189
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49190
|
-
"version": "37.
|
|
49399
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/upload-file.md",
|
|
49400
|
+
"version": "37.7.0",
|
|
49191
49401
|
"properties": [
|
|
49192
49402
|
{
|
|
49193
49403
|
"name": "type",
|
|
@@ -49238,8 +49448,8 @@
|
|
|
49238
49448
|
"description": "",
|
|
49239
49449
|
"slug": "upload-raw-data",
|
|
49240
49450
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-raw-data",
|
|
49241
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49242
|
-
"version": "37.
|
|
49451
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/upload-raw-data.md",
|
|
49452
|
+
"version": "37.7.0",
|
|
49243
49453
|
"properties": [
|
|
49244
49454
|
{
|
|
49245
49455
|
"name": "type",
|
|
@@ -49265,8 +49475,8 @@
|
|
|
49265
49475
|
"description": "",
|
|
49266
49476
|
"slug": "usb-device",
|
|
49267
49477
|
"websiteUrl": "https://electronjs.org/docs/api/structures/usb-device",
|
|
49268
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49269
|
-
"version": "37.
|
|
49478
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/usb-device.md",
|
|
49479
|
+
"version": "37.7.0",
|
|
49270
49480
|
"properties": [
|
|
49271
49481
|
{
|
|
49272
49482
|
"name": "deviceId",
|
|
@@ -49400,8 +49610,8 @@
|
|
|
49400
49610
|
"description": "This type is a helper alias, no object will ever exist of this type.",
|
|
49401
49611
|
"slug": "user-default-types",
|
|
49402
49612
|
"websiteUrl": "https://electronjs.org/docs/api/structures/user-default-types",
|
|
49403
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49404
|
-
"version": "37.
|
|
49613
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/user-default-types.md",
|
|
49614
|
+
"version": "37.7.0",
|
|
49405
49615
|
"properties": [
|
|
49406
49616
|
{
|
|
49407
49617
|
"name": "string",
|
|
@@ -49494,8 +49704,8 @@
|
|
|
49494
49704
|
"description": "",
|
|
49495
49705
|
"slug": "web-preferences",
|
|
49496
49706
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-preferences",
|
|
49497
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49498
|
-
"version": "37.
|
|
49707
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/web-preferences.md",
|
|
49708
|
+
"version": "37.7.0",
|
|
49499
49709
|
"properties": [
|
|
49500
49710
|
{
|
|
49501
49711
|
"name": "devTools",
|
|
@@ -50001,8 +50211,8 @@
|
|
|
50001
50211
|
"description": "",
|
|
50002
50212
|
"slug": "web-request-filter",
|
|
50003
50213
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-request-filter",
|
|
50004
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
50005
|
-
"version": "37.
|
|
50214
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/web-request-filter.md",
|
|
50215
|
+
"version": "37.7.0",
|
|
50006
50216
|
"properties": [
|
|
50007
50217
|
{
|
|
50008
50218
|
"name": "urls",
|
|
@@ -50088,8 +50298,8 @@
|
|
|
50088
50298
|
"description": "",
|
|
50089
50299
|
"slug": "web-source",
|
|
50090
50300
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-source",
|
|
50091
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
50092
|
-
"version": "37.
|
|
50301
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/web-source.md",
|
|
50302
|
+
"version": "37.7.0",
|
|
50093
50303
|
"properties": [
|
|
50094
50304
|
{
|
|
50095
50305
|
"name": "code",
|
|
@@ -50117,8 +50327,8 @@
|
|
|
50117
50327
|
"description": "",
|
|
50118
50328
|
"slug": "window-open-handler-response",
|
|
50119
50329
|
"websiteUrl": "https://electronjs.org/docs/api/structures/window-open-handler-response",
|
|
50120
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
50121
|
-
"version": "37.
|
|
50330
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/window-open-handler-response.md",
|
|
50331
|
+
"version": "37.7.0",
|
|
50122
50332
|
"properties": [
|
|
50123
50333
|
{
|
|
50124
50334
|
"name": "action",
|
|
@@ -50171,8 +50381,8 @@
|
|
|
50171
50381
|
"description": "Unfortunately, Windows does not offer a way to differentiate between a shutdown and a reboot, meaning the 'shutdown' reason is triggered in both scenarios. For more details on the `WM_ENDSESSION` message and its associated reasons, refer to the MSDN documentation.",
|
|
50172
50382
|
"slug": "window-session-end-event",
|
|
50173
50383
|
"websiteUrl": "https://electronjs.org/docs/api/structures/window-session-end-event",
|
|
50174
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
50175
|
-
"version": "37.
|
|
50384
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.7.0/docs/api/structures/window-session-end-event.md",
|
|
50385
|
+
"version": "37.7.0",
|
|
50176
50386
|
"properties": [
|
|
50177
50387
|
{
|
|
50178
50388
|
"name": "reasons",
|