@overwolf/ow-electron 28.2.5 → 28.3.2-beta.2
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/README.md +121 -121
- package/checksums.json +10 -9
- package/electron-api.json +438 -348
- package/electron.d.ts +66 -104
- package/ow-electron.d.ts +14 -4
- package/package.json +32 -29
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/v28.
|
|
8
|
-
"version": "28.
|
|
7
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/app.md",
|
|
8
|
+
"version": "28.3.3",
|
|
9
9
|
"type": "Module",
|
|
10
10
|
"process": {
|
|
11
11
|
"main": true,
|
|
@@ -1821,6 +1821,50 @@
|
|
|
1821
1821
|
"os_macos"
|
|
1822
1822
|
],
|
|
1823
1823
|
"urlFragment": "#appsetsecurekeyboardentryenabledenabled-macos"
|
|
1824
|
+
},
|
|
1825
|
+
{
|
|
1826
|
+
"name": "setProxy",
|
|
1827
|
+
"signature": "(config)",
|
|
1828
|
+
"description": "",
|
|
1829
|
+
"parameters": [
|
|
1830
|
+
{
|
|
1831
|
+
"name": "config",
|
|
1832
|
+
"description": "",
|
|
1833
|
+
"required": true,
|
|
1834
|
+
"collection": false,
|
|
1835
|
+
"type": "ProxyConfig"
|
|
1836
|
+
}
|
|
1837
|
+
],
|
|
1838
|
+
"returns": null,
|
|
1839
|
+
"additionalTags": [],
|
|
1840
|
+
"urlFragment": "#appsetproxyconfig"
|
|
1841
|
+
},
|
|
1842
|
+
{
|
|
1843
|
+
"name": "resolveProxy",
|
|
1844
|
+
"signature": "(url)",
|
|
1845
|
+
"description": "Resolves with the proxy information for `url` that will be used when attempting to make requests using Net in the utility process.",
|
|
1846
|
+
"parameters": [
|
|
1847
|
+
{
|
|
1848
|
+
"name": "url",
|
|
1849
|
+
"description": "",
|
|
1850
|
+
"required": true,
|
|
1851
|
+
"collection": false,
|
|
1852
|
+
"type": "URL"
|
|
1853
|
+
}
|
|
1854
|
+
],
|
|
1855
|
+
"returns": {
|
|
1856
|
+
"collection": false,
|
|
1857
|
+
"type": "Promise",
|
|
1858
|
+
"innerTypes": [
|
|
1859
|
+
{
|
|
1860
|
+
"collection": false,
|
|
1861
|
+
"type": "String",
|
|
1862
|
+
"possibleValues": null
|
|
1863
|
+
}
|
|
1864
|
+
]
|
|
1865
|
+
},
|
|
1866
|
+
"additionalTags": [],
|
|
1867
|
+
"urlFragment": "#appresolveproxyurl"
|
|
1824
1868
|
}
|
|
1825
1869
|
],
|
|
1826
1870
|
"properties": [
|
|
@@ -3044,8 +3088,8 @@
|
|
|
3044
3088
|
"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**Note:** 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 the electron-winstaller, Electron Forge or the grunt-electron-installer package to generate a Windows installer.\n\nWhen using electron-winstaller or Electron Forge make sure you do not try to update your app the first time it runs (Also see this issue for more info). It's also recommended to use electron-squirrel-startup to get desktop shortcuts for your app.\n\nThe installer generated with Squirrel 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.\n\nLike Squirrel.Mac, Windows can host updates on S3 or any other static file host. You can read the documents of Squirrel.Windows to get more details about how Squirrel.Windows works.",
|
|
3045
3089
|
"slug": "auto-updater",
|
|
3046
3090
|
"websiteUrl": "https://electronjs.org/docs/api/auto-updater",
|
|
3047
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
3048
|
-
"version": "28.
|
|
3091
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/auto-updater.md",
|
|
3092
|
+
"version": "28.3.3",
|
|
3049
3093
|
"type": "Module",
|
|
3050
3094
|
"process": {
|
|
3051
3095
|
"main": true,
|
|
@@ -3261,8 +3305,8 @@
|
|
|
3261
3305
|
"description": "A `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\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\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```",
|
|
3262
3306
|
"slug": "browser-view",
|
|
3263
3307
|
"websiteUrl": "https://electronjs.org/docs/api/browser-view",
|
|
3264
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
3265
|
-
"version": "28.
|
|
3308
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/browser-view.md",
|
|
3309
|
+
"version": "28.3.3",
|
|
3266
3310
|
"type": "Class",
|
|
3267
3311
|
"process": {
|
|
3268
3312
|
"main": true,
|
|
@@ -3423,8 +3467,8 @@
|
|
|
3423
3467
|
"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 `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\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`.",
|
|
3424
3468
|
"slug": "browser-window",
|
|
3425
3469
|
"websiteUrl": "https://electronjs.org/docs/api/browser-window",
|
|
3426
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
3427
|
-
"version": "28.
|
|
3470
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/browser-window.md",
|
|
3471
|
+
"version": "28.3.3",
|
|
3428
3472
|
"type": "Class",
|
|
3429
3473
|
"process": {
|
|
3430
3474
|
"main": true,
|
|
@@ -7043,8 +7087,8 @@
|
|
|
7043
7087
|
"description": "> Make HTTP/HTTPS requests.\n\nProcess: Main, Utility<br /> _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.",
|
|
7044
7088
|
"slug": "client-request",
|
|
7045
7089
|
"websiteUrl": "https://electronjs.org/docs/api/client-request",
|
|
7046
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
7047
|
-
"version": "28.
|
|
7090
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/client-request.md",
|
|
7091
|
+
"version": "28.3.3",
|
|
7048
7092
|
"type": "Class",
|
|
7049
7093
|
"process": {
|
|
7050
7094
|
"main": true,
|
|
@@ -7083,6 +7127,36 @@
|
|
|
7083
7127
|
"type": "String",
|
|
7084
7128
|
"possibleValues": null
|
|
7085
7129
|
},
|
|
7130
|
+
{
|
|
7131
|
+
"name": "headers",
|
|
7132
|
+
"description": "Headers to be sent with the request.",
|
|
7133
|
+
"required": false,
|
|
7134
|
+
"additionalTags": [],
|
|
7135
|
+
"collection": false,
|
|
7136
|
+
"type": "Record",
|
|
7137
|
+
"innerTypes": [
|
|
7138
|
+
{
|
|
7139
|
+
"collection": false,
|
|
7140
|
+
"type": "String",
|
|
7141
|
+
"possibleValues": null
|
|
7142
|
+
},
|
|
7143
|
+
{
|
|
7144
|
+
"collection": false,
|
|
7145
|
+
"type": [
|
|
7146
|
+
{
|
|
7147
|
+
"collection": false,
|
|
7148
|
+
"type": "String",
|
|
7149
|
+
"possibleValues": null
|
|
7150
|
+
},
|
|
7151
|
+
{
|
|
7152
|
+
"collection": true,
|
|
7153
|
+
"type": "String",
|
|
7154
|
+
"possibleValues": null
|
|
7155
|
+
}
|
|
7156
|
+
]
|
|
7157
|
+
}
|
|
7158
|
+
]
|
|
7159
|
+
},
|
|
7086
7160
|
{
|
|
7087
7161
|
"name": "session",
|
|
7088
7162
|
"description": "The `Session` instance with which the request is associated.",
|
|
@@ -7708,8 +7782,8 @@
|
|
|
7708
7782
|
"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:",
|
|
7709
7783
|
"slug": "clipboard",
|
|
7710
7784
|
"websiteUrl": "https://electronjs.org/docs/api/clipboard",
|
|
7711
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
7712
|
-
"version": "28.
|
|
7785
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/clipboard.md",
|
|
7786
|
+
"version": "28.3.3",
|
|
7713
7787
|
"type": "Module",
|
|
7714
7788
|
"process": {
|
|
7715
7789
|
"main": true,
|
|
@@ -8375,8 +8449,8 @@
|
|
|
8375
8449
|
"description": "",
|
|
8376
8450
|
"slug": "command-line",
|
|
8377
8451
|
"websiteUrl": "https://electronjs.org/docs/api/command-line",
|
|
8378
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
8379
|
-
"version": "28.
|
|
8452
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/command-line.md",
|
|
8453
|
+
"version": "28.3.3",
|
|
8380
8454
|
"type": "Class",
|
|
8381
8455
|
"process": {
|
|
8382
8456
|
"main": true,
|
|
@@ -8503,8 +8577,8 @@
|
|
|
8503
8577
|
"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.",
|
|
8504
8578
|
"slug": "content-tracing",
|
|
8505
8579
|
"websiteUrl": "https://electronjs.org/docs/api/content-tracing",
|
|
8506
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
8507
|
-
"version": "28.
|
|
8580
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/content-tracing.md",
|
|
8581
|
+
"version": "28.3.3",
|
|
8508
8582
|
"type": "Module",
|
|
8509
8583
|
"process": {
|
|
8510
8584
|
"main": true,
|
|
@@ -8641,8 +8715,8 @@
|
|
|
8641
8715
|
"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.",
|
|
8642
8716
|
"slug": "context-bridge",
|
|
8643
8717
|
"websiteUrl": "https://electronjs.org/docs/api/context-bridge",
|
|
8644
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
8645
|
-
"version": "28.
|
|
8718
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/context-bridge.md",
|
|
8719
|
+
"version": "28.3.3",
|
|
8646
8720
|
"type": "Module",
|
|
8647
8721
|
"process": {
|
|
8648
8722
|
"main": false,
|
|
@@ -8718,8 +8792,8 @@
|
|
|
8718
8792
|
"description": "",
|
|
8719
8793
|
"slug": "cookies",
|
|
8720
8794
|
"websiteUrl": "https://electronjs.org/docs/api/cookies",
|
|
8721
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
8722
|
-
"version": "28.
|
|
8795
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/cookies.md",
|
|
8796
|
+
"version": "28.3.3",
|
|
8723
8797
|
"type": "Class",
|
|
8724
8798
|
"process": {
|
|
8725
8799
|
"main": true,
|
|
@@ -9068,8 +9142,8 @@
|
|
|
9068
9142
|
"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.",
|
|
9069
9143
|
"slug": "crash-reporter",
|
|
9070
9144
|
"websiteUrl": "https://electronjs.org/docs/api/crash-reporter",
|
|
9071
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
9072
|
-
"version": "28.
|
|
9145
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/crash-reporter.md",
|
|
9146
|
+
"version": "28.3.3",
|
|
9073
9147
|
"type": "Module",
|
|
9074
9148
|
"process": {
|
|
9075
9149
|
"main": true,
|
|
@@ -9332,8 +9406,8 @@
|
|
|
9332
9406
|
"description": "",
|
|
9333
9407
|
"slug": "debugger",
|
|
9334
9408
|
"websiteUrl": "https://electronjs.org/docs/api/debugger",
|
|
9335
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
9336
|
-
"version": "28.
|
|
9409
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/debugger.md",
|
|
9410
|
+
"version": "28.3.3",
|
|
9337
9411
|
"type": "Class",
|
|
9338
9412
|
"process": {
|
|
9339
9413
|
"main": true,
|
|
@@ -9504,8 +9578,8 @@
|
|
|
9504
9578
|
"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// In the main process.\nconst { BrowserWindow, desktopCapturer } = require('electron')\n\nconst mainWindow = new BrowserWindow()\n\ndesktopCapturer.getSources({ types: ['window', 'screen'] }).then(async sources => {\n for (const source of sources) {\n if (source.name === 'Electron') {\n mainWindow.webContents.send('SET_SOURCE', source.id)\n return\n }\n }\n})\n```\n\n```\n// In the preload script.\nconst { ipcRenderer } = require('electron')\n\nipcRenderer.on('SET_SOURCE', async (event, sourceId) => {\n try {\n const stream = await navigator.mediaDevices.getUserMedia({\n audio: false,\n video: {\n mandatory: {\n chromeMediaSource: 'desktop',\n chromeMediaSourceId: sourceId,\n minWidth: 1280,\n maxWidth: 1280,\n minHeight: 720,\n maxHeight: 720\n }\n }\n })\n handleStream(stream)\n } catch (e) {\n handleError(e)\n }\n})\n\nfunction handleStream (stream) {\n const video = document.querySelector('video')\n video.srcObject = stream\n video.onloadedmetadata = (e) => video.play()\n}\n\nfunction handleError (e) {\n console.log(e)\n}\n```\n\nTo capture video from a source provided by `desktopCapturer` the constraints passed to `navigator.mediaDevices.getUserMedia` must include `chromeMediaSource: 'desktop'`, and `audio: false`.\n\nTo capture both audio and video from the entire desktop the constraints passed to `navigator.mediaDevices.getUserMedia` must include `chromeMediaSource: 'desktop'`, for both `audio` and `video`, but should not include a `chromeMediaSourceId` constraint.",
|
|
9505
9579
|
"slug": "desktop-capturer",
|
|
9506
9580
|
"websiteUrl": "https://electronjs.org/docs/api/desktop-capturer",
|
|
9507
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
9508
|
-
"version": "28.
|
|
9581
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/desktop-capturer.md",
|
|
9582
|
+
"version": "28.3.3",
|
|
9509
9583
|
"type": "Module",
|
|
9510
9584
|
"process": {
|
|
9511
9585
|
"main": true,
|
|
@@ -9586,8 +9660,8 @@
|
|
|
9586
9660
|
"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:",
|
|
9587
9661
|
"slug": "dialog",
|
|
9588
9662
|
"websiteUrl": "https://electronjs.org/docs/api/dialog",
|
|
9589
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
9590
|
-
"version": "28.
|
|
9663
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/dialog.md",
|
|
9664
|
+
"version": "28.3.3",
|
|
9591
9665
|
"type": "Module",
|
|
9592
9666
|
"process": {
|
|
9593
9667
|
"main": true,
|
|
@@ -9910,7 +9984,7 @@
|
|
|
9910
9984
|
{
|
|
9911
9985
|
"name": "showSaveDialogSync",
|
|
9912
9986
|
"signature": "([browserWindow, ]options)",
|
|
9913
|
-
"description": "the path of the file chosen by the user; if the dialog is cancelled it returns
|
|
9987
|
+
"description": "the path of the file chosen by the user; if the dialog is cancelled it returns an empty string.\n\nThe `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.\n\nThe `filters` specifies an array of file types that can be displayed, see `dialog.showOpenDialog` for an example.",
|
|
9914
9988
|
"parameters": [
|
|
9915
9989
|
{
|
|
9916
9990
|
"name": "browserWindow",
|
|
@@ -10039,17 +10113,8 @@
|
|
|
10039
10113
|
],
|
|
10040
10114
|
"returns": {
|
|
10041
10115
|
"collection": false,
|
|
10042
|
-
"type":
|
|
10043
|
-
|
|
10044
|
-
"collection": false,
|
|
10045
|
-
"type": "String",
|
|
10046
|
-
"possibleValues": null
|
|
10047
|
-
},
|
|
10048
|
-
{
|
|
10049
|
-
"collection": false,
|
|
10050
|
-
"type": "undefined"
|
|
10051
|
-
}
|
|
10052
|
-
]
|
|
10116
|
+
"type": "String",
|
|
10117
|
+
"possibleValues": null
|
|
10053
10118
|
},
|
|
10054
10119
|
"additionalTags": [],
|
|
10055
10120
|
"urlFragment": "#dialogshowsavedialogsyncbrowserwindow-options"
|
|
@@ -10057,7 +10122,7 @@
|
|
|
10057
10122
|
{
|
|
10058
10123
|
"name": "showSaveDialog",
|
|
10059
10124
|
"signature": "([browserWindow, ]options)",
|
|
10060
|
-
"description": "Resolve with an object containing the following:\n\n* `canceled` boolean - whether or not the dialog was canceled.\n* `filePath` string
|
|
10125
|
+
"description": "Resolve with an object containing the following:\n\n* `canceled` boolean - whether or not the dialog was canceled.\n* `filePath` string - If the dialog is canceled, this will be an empty string.\n* `bookmark` string (optional) _macOS_ _mas_ - Base64 encoded string which contains the security scoped bookmark data for the saved file. `securityScopedBookmarks` must be enabled for this to be present. (For return values, see table here.)\n\nThe `browserWindow` argument allows the dialog to attach itself to a parent window, making it modal.\n\nThe `filters` specifies an array of file types that can be displayed, see `dialog.showOpenDialog` for an example.\n\n**Note:** On macOS, using the asynchronous version is recommended to avoid issues when expanding and collapsing the dialog.",
|
|
10061
10126
|
"parameters": [
|
|
10062
10127
|
{
|
|
10063
10128
|
"name": "browserWindow",
|
|
@@ -10202,8 +10267,8 @@
|
|
|
10202
10267
|
},
|
|
10203
10268
|
{
|
|
10204
10269
|
"name": "filePath",
|
|
10205
|
-
"description": "If the dialog is canceled, this will be
|
|
10206
|
-
"required":
|
|
10270
|
+
"description": "If the dialog is canceled, this will be an empty string.",
|
|
10271
|
+
"required": true,
|
|
10207
10272
|
"additionalTags": [],
|
|
10208
10273
|
"collection": false,
|
|
10209
10274
|
"type": "String",
|
|
@@ -10678,8 +10743,8 @@
|
|
|
10678
10743
|
"description": "",
|
|
10679
10744
|
"slug": "dock",
|
|
10680
10745
|
"websiteUrl": "https://electronjs.org/docs/api/dock",
|
|
10681
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
10682
|
-
"version": "28.
|
|
10746
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/dock.md",
|
|
10747
|
+
"version": "28.3.3",
|
|
10683
10748
|
"type": "Class",
|
|
10684
10749
|
"process": {
|
|
10685
10750
|
"main": true,
|
|
@@ -10923,8 +10988,8 @@
|
|
|
10923
10988
|
"description": "",
|
|
10924
10989
|
"slug": "download-item",
|
|
10925
10990
|
"websiteUrl": "https://electronjs.org/docs/api/download-item",
|
|
10926
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
10927
|
-
"version": "28.
|
|
10991
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/download-item.md",
|
|
10992
|
+
"version": "28.3.3",
|
|
10928
10993
|
"type": "Class",
|
|
10929
10994
|
"process": {
|
|
10930
10995
|
"main": true,
|
|
@@ -11310,8 +11375,8 @@
|
|
|
11310
11375
|
"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.",
|
|
11311
11376
|
"slug": "global-shortcut",
|
|
11312
11377
|
"websiteUrl": "https://electronjs.org/docs/api/global-shortcut",
|
|
11313
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
11314
|
-
"version": "28.
|
|
11378
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/global-shortcut.md",
|
|
11379
|
+
"version": "28.3.3",
|
|
11315
11380
|
"type": "Module",
|
|
11316
11381
|
"process": {
|
|
11317
11382
|
"main": true,
|
|
@@ -11431,8 +11496,8 @@
|
|
|
11431
11496
|
"description": "> In-app purchases on Mac App Store.\n\nProcess: Main",
|
|
11432
11497
|
"slug": "in-app-purchase",
|
|
11433
11498
|
"websiteUrl": "https://electronjs.org/docs/api/in-app-purchase",
|
|
11434
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
11435
|
-
"version": "28.
|
|
11499
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/in-app-purchase.md",
|
|
11500
|
+
"version": "28.3.3",
|
|
11436
11501
|
"type": "Module",
|
|
11437
11502
|
"process": {
|
|
11438
11503
|
"main": true,
|
|
@@ -11609,8 +11674,8 @@
|
|
|
11609
11674
|
"description": "",
|
|
11610
11675
|
"slug": "incoming-message",
|
|
11611
11676
|
"websiteUrl": "https://electronjs.org/docs/api/incoming-message",
|
|
11612
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
11613
|
-
"version": "28.
|
|
11677
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/incoming-message.md",
|
|
11678
|
+
"version": "28.3.3",
|
|
11614
11679
|
"type": "Class",
|
|
11615
11680
|
"process": {
|
|
11616
11681
|
"main": true,
|
|
@@ -11758,8 +11823,8 @@
|
|
|
11758
11823
|
"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.",
|
|
11759
11824
|
"slug": "ipc-main",
|
|
11760
11825
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-main",
|
|
11761
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
11762
|
-
"version": "28.
|
|
11826
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/ipc-main.md",
|
|
11827
|
+
"version": "28.3.3",
|
|
11763
11828
|
"type": "Module",
|
|
11764
11829
|
"process": {
|
|
11765
11830
|
"main": true,
|
|
@@ -12053,8 +12118,8 @@
|
|
|
12053
12118
|
"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.",
|
|
12054
12119
|
"slug": "ipc-renderer",
|
|
12055
12120
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-renderer",
|
|
12056
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
12057
|
-
"version": "28.
|
|
12121
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/ipc-renderer.md",
|
|
12122
|
+
"version": "28.3.3",
|
|
12058
12123
|
"type": "Module",
|
|
12059
12124
|
"process": {
|
|
12060
12125
|
"main": false,
|
|
@@ -12445,8 +12510,8 @@
|
|
|
12445
12510
|
"description": "> Add items to native application menus and context menus.\n\nProcess: Main\n\nSee `Menu` for examples.",
|
|
12446
12511
|
"slug": "menu-item",
|
|
12447
12512
|
"websiteUrl": "https://electronjs.org/docs/api/menu-item",
|
|
12448
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
12449
|
-
"version": "28.
|
|
12513
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/menu-item.md",
|
|
12514
|
+
"version": "28.3.3",
|
|
12450
12515
|
"type": "Class",
|
|
12451
12516
|
"process": {
|
|
12452
12517
|
"main": true,
|
|
@@ -13342,8 +13407,8 @@
|
|
|
13342
13407
|
"description": "\n\n### Class: Menu\n\n> Create native application menus and context menus.\n\nProcess: Main",
|
|
13343
13408
|
"slug": "menu",
|
|
13344
13409
|
"websiteUrl": "https://electronjs.org/docs/api/menu",
|
|
13345
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
13346
|
-
"version": "28.
|
|
13410
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/menu.md",
|
|
13411
|
+
"version": "28.3.3",
|
|
13347
13412
|
"type": "Class",
|
|
13348
13413
|
"process": {
|
|
13349
13414
|
"main": true,
|
|
@@ -13716,8 +13781,8 @@
|
|
|
13716
13781
|
"description": "",
|
|
13717
13782
|
"slug": "message-channel-main",
|
|
13718
13783
|
"websiteUrl": "https://electronjs.org/docs/api/message-channel-main",
|
|
13719
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
13720
|
-
"version": "28.
|
|
13784
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/message-channel-main.md",
|
|
13785
|
+
"version": "28.3.3",
|
|
13721
13786
|
"type": "Class",
|
|
13722
13787
|
"process": {
|
|
13723
13788
|
"main": true,
|
|
@@ -13757,8 +13822,8 @@
|
|
|
13757
13822
|
"description": "",
|
|
13758
13823
|
"slug": "message-port-main",
|
|
13759
13824
|
"websiteUrl": "https://electronjs.org/docs/api/message-port-main",
|
|
13760
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
13761
|
-
"version": "28.
|
|
13825
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/message-port-main.md",
|
|
13826
|
+
"version": "28.3.3",
|
|
13762
13827
|
"type": "Class",
|
|
13763
13828
|
"process": {
|
|
13764
13829
|
"main": true,
|
|
@@ -13864,8 +13929,8 @@
|
|
|
13864
13929
|
"description": "> Create tray, dock, and application icons using PNG or JPG files.\n\nProcess: Main, Renderer\n\nIn Electron, for the APIs that take images, you can pass either file paths or `NativeImage` instances. An empty image will be used when `null` is passed.\n\nFor example, when creating a tray or setting a window's icon, you can pass an image file path as a `string`:\n\n```\nconst { BrowserWindow, Tray } = require('electron')\n\nconst appIcon = new Tray('/Users/somebody/images/icon.png')\nconst win = new BrowserWindow({ icon: '/Users/somebody/images/window.png' })\nconsole.log(appIcon, win)\n```\n\nOr read the image from the clipboard, which returns a `NativeImage`:\n\n### Supported Formats\n\nCurrently `PNG` and `JPEG` image formats are supported. `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, it is recommended to include at least the following sizes in the:\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 _Size requirements_ section in this article.\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 have high-DPI support such as Apple Retina displays, you can append `@2x` after image's base filename to mark it as a 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 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. For example:\n\n```\nimages/\n├── icon.png\n├── icon@2x.png\n└── icon@3x.png\n```\n\n```\nconst { Tray } = require('electron')\nconst appIcon = new Tray('/Users/somebody/images/icon.png')\nconsole.log(appIcon)\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\n\nTemplate 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 icon, so it can adapt to both light and dark menu bars.\n\n**Note:** Template image is only supported on macOS.\n\nTo mark an image as a template image, its filename should end with the word `Template`. For example:\n\n* `xxxTemplate.png`\n* `xxxTemplate@2x.png`",
|
|
13865
13930
|
"slug": "native-image",
|
|
13866
13931
|
"websiteUrl": "https://electronjs.org/docs/api/native-image",
|
|
13867
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
13868
|
-
"version": "28.
|
|
13932
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/native-image.md",
|
|
13933
|
+
"version": "28.3.3",
|
|
13869
13934
|
"type": "Module",
|
|
13870
13935
|
"process": {
|
|
13871
13936
|
"main": true,
|
|
@@ -14111,8 +14176,8 @@
|
|
|
14111
14176
|
"description": "",
|
|
14112
14177
|
"slug": "native-image",
|
|
14113
14178
|
"websiteUrl": "https://electronjs.org/docs/api/native-image",
|
|
14114
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
14115
|
-
"version": "28.
|
|
14179
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/native-image.md",
|
|
14180
|
+
"version": "28.3.3",
|
|
14116
14181
|
"type": "Class",
|
|
14117
14182
|
"process": {
|
|
14118
14183
|
"main": true,
|
|
@@ -14534,8 +14599,8 @@
|
|
|
14534
14599
|
"description": "> Read and respond to changes in Chromium's native color theme.\n\nProcess: Main",
|
|
14535
14600
|
"slug": "native-theme",
|
|
14536
14601
|
"websiteUrl": "https://electronjs.org/docs/api/native-theme",
|
|
14537
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
14538
|
-
"version": "28.
|
|
14602
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/native-theme.md",
|
|
14603
|
+
"version": "28.3.3",
|
|
14539
14604
|
"type": "Module",
|
|
14540
14605
|
"process": {
|
|
14541
14606
|
"main": true,
|
|
@@ -14634,8 +14699,8 @@
|
|
|
14634
14699
|
"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.",
|
|
14635
14700
|
"slug": "net-log",
|
|
14636
14701
|
"websiteUrl": "https://electronjs.org/docs/api/net-log",
|
|
14637
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
14638
|
-
"version": "28.
|
|
14702
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/net-log.md",
|
|
14703
|
+
"version": "28.3.3",
|
|
14639
14704
|
"type": "Module",
|
|
14640
14705
|
"process": {
|
|
14641
14706
|
"main": true,
|
|
@@ -14750,8 +14815,8 @@
|
|
|
14750
14815
|
"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.",
|
|
14751
14816
|
"slug": "net",
|
|
14752
14817
|
"websiteUrl": "https://electronjs.org/docs/api/net",
|
|
14753
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
14754
|
-
"version": "28.
|
|
14818
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/net.md",
|
|
14819
|
+
"version": "28.3.3",
|
|
14755
14820
|
"type": "Module",
|
|
14756
14821
|
"process": {
|
|
14757
14822
|
"main": true,
|
|
@@ -14991,8 +15056,8 @@
|
|
|
14991
15056
|
"description": "> Create OS desktop notifications\n\nProcess: Main\n\n:::info Renderer process notifications\n\nIf you want to show notifications from a renderer process you should use the web Notifications API\n\n:::\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### 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",
|
|
14992
15057
|
"slug": "notification",
|
|
14993
15058
|
"websiteUrl": "https://electronjs.org/docs/api/notification",
|
|
14994
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
14995
|
-
"version": "28.
|
|
15059
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/notification.md",
|
|
15060
|
+
"version": "28.3.3",
|
|
14996
15061
|
"type": "Class",
|
|
14997
15062
|
"process": {
|
|
14998
15063
|
"main": true,
|
|
@@ -15498,8 +15563,8 @@
|
|
|
15498
15563
|
"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._",
|
|
15499
15564
|
"slug": "parent-port",
|
|
15500
15565
|
"websiteUrl": "https://electronjs.org/docs/api/parent-port",
|
|
15501
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
15502
|
-
"version": "28.
|
|
15566
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/parent-port.md",
|
|
15567
|
+
"version": "28.3.3",
|
|
15503
15568
|
"type": "Module",
|
|
15504
15569
|
"process": {
|
|
15505
15570
|
"main": false,
|
|
@@ -15570,8 +15635,8 @@
|
|
|
15570
15635
|
"description": "> Monitor power state changes.\n\nProcess: Main",
|
|
15571
15636
|
"slug": "power-monitor",
|
|
15572
15637
|
"websiteUrl": "https://electronjs.org/docs/api/power-monitor",
|
|
15573
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
15574
|
-
"version": "28.
|
|
15638
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/power-monitor.md",
|
|
15639
|
+
"version": "28.3.3",
|
|
15575
15640
|
"type": "Module",
|
|
15576
15641
|
"process": {
|
|
15577
15642
|
"main": true,
|
|
@@ -15799,8 +15864,8 @@
|
|
|
15799
15864
|
"description": "> Block the system from entering low-power (sleep) mode.\n\nProcess: Main\n\nFor example:",
|
|
15800
15865
|
"slug": "power-save-blocker",
|
|
15801
15866
|
"websiteUrl": "https://electronjs.org/docs/api/power-save-blocker",
|
|
15802
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
15803
|
-
"version": "28.
|
|
15867
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/power-save-blocker.md",
|
|
15868
|
+
"version": "28.3.3",
|
|
15804
15869
|
"type": "Module",
|
|
15805
15870
|
"process": {
|
|
15806
15871
|
"main": true,
|
|
@@ -15889,8 +15954,8 @@
|
|
|
15889
15954
|
"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* `getIOCounters()`\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`",
|
|
15890
15955
|
"slug": "process",
|
|
15891
15956
|
"websiteUrl": "https://electronjs.org/docs/api/process",
|
|
15892
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
15893
|
-
"version": "28.
|
|
15957
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/process.md",
|
|
15958
|
+
"version": "28.3.3",
|
|
15894
15959
|
"type": "Module",
|
|
15895
15960
|
"process": {
|
|
15896
15961
|
"main": true,
|
|
@@ -16421,8 +16486,8 @@
|
|
|
16421
16486
|
"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')\n\napp.whenReady().then(() => {\n protocol.handle('atom', (request) =>\n net.fetch('file://' + request.url.slice('atom://'.length)))\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.join(__dirname, filePath)).toString())\n })\n\n const mainWindow = new BrowserWindow({ webPreferences: { partition } })\n})\n```",
|
|
16422
16487
|
"slug": "protocol",
|
|
16423
16488
|
"websiteUrl": "https://electronjs.org/docs/api/protocol",
|
|
16424
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
16425
|
-
"version": "28.
|
|
16489
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/protocol.md",
|
|
16490
|
+
"version": "28.3.3",
|
|
16426
16491
|
"type": "Module",
|
|
16427
16492
|
"process": {
|
|
16428
16493
|
"main": true,
|
|
@@ -17288,8 +17353,8 @@
|
|
|
17288
17353
|
"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):",
|
|
17289
17354
|
"slug": "push-notifications",
|
|
17290
17355
|
"websiteUrl": "https://electronjs.org/docs/api/push-notifications",
|
|
17291
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
17292
|
-
"version": "28.
|
|
17356
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/push-notifications.md",
|
|
17357
|
+
"version": "28.3.3",
|
|
17293
17358
|
"type": "Module",
|
|
17294
17359
|
"process": {
|
|
17295
17360
|
"main": true,
|
|
@@ -17378,8 +17443,8 @@
|
|
|
17378
17443
|
"description": "> Allows access to simple encryption and decryption of strings for storage on the local machine.\n\nProcess: Main\n\nThis module protects data stored on disk from being accessed by other applications or users with full disk access.\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.",
|
|
17379
17444
|
"slug": "safe-storage",
|
|
17380
17445
|
"websiteUrl": "https://electronjs.org/docs/api/safe-storage",
|
|
17381
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
17382
|
-
"version": "28.
|
|
17446
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/safe-storage.md",
|
|
17447
|
+
"version": "28.3.3",
|
|
17383
17448
|
"type": "Module",
|
|
17384
17449
|
"process": {
|
|
17385
17450
|
"main": true,
|
|
@@ -17509,8 +17574,8 @@
|
|
|
17509
17574
|
"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:",
|
|
17510
17575
|
"slug": "screen",
|
|
17511
17576
|
"websiteUrl": "https://electronjs.org/docs/api/screen",
|
|
17512
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
17513
|
-
"version": "28.
|
|
17577
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/screen.md",
|
|
17578
|
+
"version": "28.3.3",
|
|
17514
17579
|
"type": "Module",
|
|
17515
17580
|
"process": {
|
|
17516
17581
|
"main": true,
|
|
@@ -17807,8 +17872,8 @@
|
|
|
17807
17872
|
"description": "",
|
|
17808
17873
|
"slug": "service-workers",
|
|
17809
17874
|
"websiteUrl": "https://electronjs.org/docs/api/service-workers",
|
|
17810
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
17811
|
-
"version": "28.
|
|
17875
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/service-workers.md",
|
|
17876
|
+
"version": "28.3.3",
|
|
17812
17877
|
"type": "Class",
|
|
17813
17878
|
"process": {
|
|
17814
17879
|
"main": true,
|
|
@@ -18038,8 +18103,8 @@
|
|
|
18038
18103
|
"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.",
|
|
18039
18104
|
"slug": "session",
|
|
18040
18105
|
"websiteUrl": "https://electronjs.org/docs/api/session",
|
|
18041
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
18042
|
-
"version": "28.
|
|
18106
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/session.md",
|
|
18107
|
+
"version": "28.3.3",
|
|
18043
18108
|
"type": "Module",
|
|
18044
18109
|
"process": {
|
|
18045
18110
|
"main": true,
|
|
@@ -18144,8 +18209,8 @@
|
|
|
18144
18209
|
"description": "",
|
|
18145
18210
|
"slug": "session",
|
|
18146
18211
|
"websiteUrl": "https://electronjs.org/docs/api/session",
|
|
18147
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
18148
|
-
"version": "28.
|
|
18212
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/session.md",
|
|
18213
|
+
"version": "28.3.3",
|
|
18149
18214
|
"type": "Class",
|
|
18150
18215
|
"process": {
|
|
18151
18216
|
"main": true,
|
|
@@ -18302,73 +18367,14 @@
|
|
|
18302
18367
|
{
|
|
18303
18368
|
"name": "setProxy",
|
|
18304
18369
|
"signature": "(config)",
|
|
18305
|
-
"description": "Resolves when the proxy setting process is complete.\n\nSets the proxy settings.\n\
|
|
18370
|
+
"description": "Resolves when the proxy setting process is complete.\n\nSets the proxy settings.\n\nYou may need `ses.closeAllConnections` to close currently in flight connections to prevent pooled sockets using previous proxy from being reused by future requests.",
|
|
18306
18371
|
"parameters": [
|
|
18307
18372
|
{
|
|
18308
18373
|
"name": "config",
|
|
18309
18374
|
"description": "",
|
|
18310
18375
|
"required": true,
|
|
18311
18376
|
"collection": false,
|
|
18312
|
-
"type": "
|
|
18313
|
-
"properties": [
|
|
18314
|
-
{
|
|
18315
|
-
"name": "mode",
|
|
18316
|
-
"description": "The proxy mode. Should be one of `direct`, `auto_detect`, `pac_script`, `fixed_servers` or `system`. If it's unspecified, it will be automatically determined based on other specified options.",
|
|
18317
|
-
"required": false,
|
|
18318
|
-
"additionalTags": [],
|
|
18319
|
-
"collection": false,
|
|
18320
|
-
"type": "String",
|
|
18321
|
-
"possibleValues": [
|
|
18322
|
-
{
|
|
18323
|
-
"value": "direct",
|
|
18324
|
-
"description": ""
|
|
18325
|
-
},
|
|
18326
|
-
{
|
|
18327
|
-
"value": "auto_detect",
|
|
18328
|
-
"description": ""
|
|
18329
|
-
},
|
|
18330
|
-
{
|
|
18331
|
-
"value": "pac_script",
|
|
18332
|
-
"description": ""
|
|
18333
|
-
},
|
|
18334
|
-
{
|
|
18335
|
-
"value": "fixed_servers",
|
|
18336
|
-
"description": ""
|
|
18337
|
-
},
|
|
18338
|
-
{
|
|
18339
|
-
"value": "system",
|
|
18340
|
-
"description": "line options influence the proxy configuration."
|
|
18341
|
-
}
|
|
18342
|
-
]
|
|
18343
|
-
},
|
|
18344
|
-
{
|
|
18345
|
-
"name": "pacScript",
|
|
18346
|
-
"description": "The URL associated with the PAC file.",
|
|
18347
|
-
"required": false,
|
|
18348
|
-
"additionalTags": [],
|
|
18349
|
-
"collection": false,
|
|
18350
|
-
"type": "String",
|
|
18351
|
-
"possibleValues": null
|
|
18352
|
-
},
|
|
18353
|
-
{
|
|
18354
|
-
"name": "proxyRules",
|
|
18355
|
-
"description": "Rules indicating which proxies to use.",
|
|
18356
|
-
"required": false,
|
|
18357
|
-
"additionalTags": [],
|
|
18358
|
-
"collection": false,
|
|
18359
|
-
"type": "String",
|
|
18360
|
-
"possibleValues": null
|
|
18361
|
-
},
|
|
18362
|
-
{
|
|
18363
|
-
"name": "proxyBypassRules",
|
|
18364
|
-
"description": "Rules indicating which URLs should bypass the proxy settings.",
|
|
18365
|
-
"required": false,
|
|
18366
|
-
"additionalTags": [],
|
|
18367
|
-
"collection": false,
|
|
18368
|
-
"type": "String",
|
|
18369
|
-
"possibleValues": null
|
|
18370
|
-
}
|
|
18371
|
-
]
|
|
18377
|
+
"type": "ProxyConfig"
|
|
18372
18378
|
}
|
|
18373
18379
|
],
|
|
18374
18380
|
"returns": {
|
|
@@ -18918,6 +18924,14 @@
|
|
|
18918
18924
|
"value": "openExternal",
|
|
18919
18925
|
"description": "Request to open links in external applications."
|
|
18920
18926
|
},
|
|
18927
|
+
{
|
|
18928
|
+
"value": "storage-access",
|
|
18929
|
+
"description": "Allows content loaded in a third-party context to request access to third-party cookies using the Storage Access API."
|
|
18930
|
+
},
|
|
18931
|
+
{
|
|
18932
|
+
"value": "top-level-storage-access",
|
|
18933
|
+
"description": " Allow top-level sites to request third-party cookie access on behalf of embedded content originating from another site in the same related website set using the Storage Access API."
|
|
18934
|
+
},
|
|
18921
18935
|
{
|
|
18922
18936
|
"value": "window-management",
|
|
18923
18937
|
"description": "Request access to enumerate screens using the `getScreenDetails` API."
|
|
@@ -19115,6 +19129,14 @@
|
|
|
19115
19129
|
"value": "serial",
|
|
19116
19130
|
"description": "Read from and write to serial devices with the Web Serial API."
|
|
19117
19131
|
},
|
|
19132
|
+
{
|
|
19133
|
+
"value": "storage-access",
|
|
19134
|
+
"description": "Allows content loaded in a third-party context to request access to third-party cookies using the Storage Access API."
|
|
19135
|
+
},
|
|
19136
|
+
{
|
|
19137
|
+
"value": "top-level-storage-access",
|
|
19138
|
+
"description": " Allow top-level sites to request third-party cookie access on behalf of embedded content originating from another site in the same related website set using the Storage Access API."
|
|
19139
|
+
},
|
|
19118
19140
|
{
|
|
19119
19141
|
"value": "usb",
|
|
19120
19142
|
"description": "Expose non-standard Universal Serial Bus (USB) compatible devices services to the web with the WebUSB API."
|
|
@@ -21255,8 +21277,8 @@
|
|
|
21255
21277
|
"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",
|
|
21256
21278
|
"slug": "share-menu",
|
|
21257
21279
|
"websiteUrl": "https://electronjs.org/docs/api/share-menu",
|
|
21258
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
21259
|
-
"version": "28.
|
|
21280
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/share-menu.md",
|
|
21281
|
+
"version": "28.3.3",
|
|
21260
21282
|
"type": "Class",
|
|
21261
21283
|
"process": {
|
|
21262
21284
|
"main": true,
|
|
@@ -21323,8 +21345,8 @@
|
|
|
21323
21345
|
"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**Note:** While the `shell` module can be used in the renderer process, it will not function in a sandboxed renderer.",
|
|
21324
21346
|
"slug": "shell",
|
|
21325
21347
|
"websiteUrl": "https://electronjs.org/docs/api/shell",
|
|
21326
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
21327
|
-
"version": "28.
|
|
21348
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/shell.md",
|
|
21349
|
+
"version": "28.3.3",
|
|
21328
21350
|
"type": "Module",
|
|
21329
21351
|
"process": {
|
|
21330
21352
|
"main": true,
|
|
@@ -21566,8 +21588,8 @@
|
|
|
21566
21588
|
"description": "> Get system preferences.\n\nProcess: Main",
|
|
21567
21589
|
"slug": "system-preferences",
|
|
21568
21590
|
"websiteUrl": "https://electronjs.org/docs/api/system-preferences",
|
|
21569
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
21570
|
-
"version": "28.
|
|
21591
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/system-preferences.md",
|
|
21592
|
+
"version": "28.3.3",
|
|
21571
21593
|
"type": "Module",
|
|
21572
21594
|
"process": {
|
|
21573
21595
|
"main": true,
|
|
@@ -22813,8 +22835,8 @@
|
|
|
22813
22835
|
"description": "> Create a button in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22814
22836
|
"slug": "touch-bar-button",
|
|
22815
22837
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-button",
|
|
22816
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
22817
|
-
"version": "28.
|
|
22838
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar-button.md",
|
|
22839
|
+
"version": "28.3.3",
|
|
22818
22840
|
"type": "Class",
|
|
22819
22841
|
"process": {
|
|
22820
22842
|
"main": true,
|
|
@@ -23005,8 +23027,8 @@
|
|
|
23005
23027
|
"description": "> Create a color picker in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23006
23028
|
"slug": "touch-bar-color-picker",
|
|
23007
23029
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-color-picker",
|
|
23008
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
23009
|
-
"version": "28.
|
|
23030
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar-color-picker.md",
|
|
23031
|
+
"version": "28.3.3",
|
|
23010
23032
|
"type": "Class",
|
|
23011
23033
|
"process": {
|
|
23012
23034
|
"main": true,
|
|
@@ -23098,8 +23120,8 @@
|
|
|
23098
23120
|
"description": "> Create a group in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23099
23121
|
"slug": "touch-bar-group",
|
|
23100
23122
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-group",
|
|
23101
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
23102
|
-
"version": "28.
|
|
23123
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar-group.md",
|
|
23124
|
+
"version": "28.3.3",
|
|
23103
23125
|
"type": "Class",
|
|
23104
23126
|
"process": {
|
|
23105
23127
|
"main": true,
|
|
@@ -23141,8 +23163,8 @@
|
|
|
23141
23163
|
"description": "> Create a label in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23142
23164
|
"slug": "touch-bar-label",
|
|
23143
23165
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-label",
|
|
23144
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
23145
|
-
"version": "28.
|
|
23166
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar-label.md",
|
|
23167
|
+
"version": "28.3.3",
|
|
23146
23168
|
"type": "Class",
|
|
23147
23169
|
"process": {
|
|
23148
23170
|
"main": true,
|
|
@@ -23234,8 +23256,8 @@
|
|
|
23234
23256
|
"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\nNote: Only one instance of this class can be added per TouchBar.\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23235
23257
|
"slug": "touch-bar-other-items-proxy",
|
|
23236
23258
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-other-items-proxy",
|
|
23237
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
23238
|
-
"version": "28.
|
|
23259
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar-other-items-proxy.md",
|
|
23260
|
+
"version": "28.3.3",
|
|
23239
23261
|
"type": "Class",
|
|
23240
23262
|
"process": {
|
|
23241
23263
|
"main": true,
|
|
@@ -23259,8 +23281,8 @@
|
|
|
23259
23281
|
"description": "> Create a popover in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23260
23282
|
"slug": "touch-bar-popover",
|
|
23261
23283
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-popover",
|
|
23262
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
23263
|
-
"version": "28.
|
|
23284
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar-popover.md",
|
|
23285
|
+
"version": "28.3.3",
|
|
23264
23286
|
"type": "Class",
|
|
23265
23287
|
"process": {
|
|
23266
23288
|
"main": true,
|
|
@@ -23347,8 +23369,8 @@
|
|
|
23347
23369
|
"description": "> Create a scrubber (a scrollable selector)\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23348
23370
|
"slug": "touch-bar-scrubber",
|
|
23349
23371
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-scrubber",
|
|
23350
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
23351
|
-
"version": "28.
|
|
23372
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar-scrubber.md",
|
|
23373
|
+
"version": "28.3.3",
|
|
23352
23374
|
"type": "Class",
|
|
23353
23375
|
"process": {
|
|
23354
23376
|
"main": true,
|
|
@@ -23597,8 +23619,8 @@
|
|
|
23597
23619
|
"description": "> Create a segmented control (a button group) where one button has a selected state\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23598
23620
|
"slug": "touch-bar-segmented-control",
|
|
23599
23621
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-segmented-control",
|
|
23600
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
23601
|
-
"version": "28.
|
|
23622
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar-segmented-control.md",
|
|
23623
|
+
"version": "28.3.3",
|
|
23602
23624
|
"type": "Class",
|
|
23603
23625
|
"process": {
|
|
23604
23626
|
"main": true,
|
|
@@ -23789,8 +23811,8 @@
|
|
|
23789
23811
|
"description": "> Create a slider in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23790
23812
|
"slug": "touch-bar-slider",
|
|
23791
23813
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-slider",
|
|
23792
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
23793
|
-
"version": "28.
|
|
23814
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar-slider.md",
|
|
23815
|
+
"version": "28.3.3",
|
|
23794
23816
|
"type": "Class",
|
|
23795
23817
|
"process": {
|
|
23796
23818
|
"main": true,
|
|
@@ -23913,8 +23935,8 @@
|
|
|
23913
23935
|
"description": "> Create a spacer between two items in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23914
23936
|
"slug": "touch-bar-spacer",
|
|
23915
23937
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-spacer",
|
|
23916
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
23917
|
-
"version": "28.
|
|
23938
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar-spacer.md",
|
|
23939
|
+
"version": "28.3.3",
|
|
23918
23940
|
"type": "Class",
|
|
23919
23941
|
"process": {
|
|
23920
23942
|
"main": true,
|
|
@@ -23994,8 +24016,8 @@
|
|
|
23994
24016
|
"description": "\n\n### Class: TouchBar\n\n> Create TouchBar layouts for native macOS applications\n\nProcess: Main",
|
|
23995
24017
|
"slug": "touch-bar",
|
|
23996
24018
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar",
|
|
23997
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
23998
|
-
"version": "28.
|
|
24019
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/touch-bar.md",
|
|
24020
|
+
"version": "28.3.3",
|
|
23999
24021
|
"type": "Class",
|
|
24000
24022
|
"process": {
|
|
24001
24023
|
"main": true,
|
|
@@ -24224,8 +24246,8 @@
|
|
|
24224
24246
|
"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**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.",
|
|
24225
24247
|
"slug": "tray",
|
|
24226
24248
|
"websiteUrl": "https://electronjs.org/docs/api/tray",
|
|
24227
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
24228
|
-
"version": "28.
|
|
24249
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/tray.md",
|
|
24250
|
+
"version": "28.3.3",
|
|
24229
24251
|
"type": "Class",
|
|
24230
24252
|
"process": {
|
|
24231
24253
|
"main": true,
|
|
@@ -25042,8 +25064,8 @@
|
|
|
25042
25064
|
"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<br />",
|
|
25043
25065
|
"slug": "utility-process",
|
|
25044
25066
|
"websiteUrl": "https://electronjs.org/docs/api/utility-process",
|
|
25045
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
25046
|
-
"version": "28.
|
|
25067
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/utility-process.md",
|
|
25068
|
+
"version": "28.3.3",
|
|
25047
25069
|
"type": "Module",
|
|
25048
25070
|
"process": {
|
|
25049
25071
|
"main": true,
|
|
@@ -25178,8 +25200,8 @@
|
|
|
25178
25200
|
"description": "",
|
|
25179
25201
|
"slug": "utility-process",
|
|
25180
25202
|
"websiteUrl": "https://electronjs.org/docs/api/utility-process",
|
|
25181
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
25182
|
-
"version": "28.
|
|
25203
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/utility-process.md",
|
|
25204
|
+
"version": "28.3.3",
|
|
25183
25205
|
"type": "Class",
|
|
25184
25206
|
"process": {
|
|
25185
25207
|
"main": true,
|
|
@@ -25332,8 +25354,8 @@
|
|
|
25332
25354
|
"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.",
|
|
25333
25355
|
"slug": "web-contents",
|
|
25334
25356
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents",
|
|
25335
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
25336
|
-
"version": "28.
|
|
25357
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/web-contents.md",
|
|
25358
|
+
"version": "28.3.3",
|
|
25337
25359
|
"type": "Module",
|
|
25338
25360
|
"process": {
|
|
25339
25361
|
"main": true,
|
|
@@ -25473,8 +25495,8 @@
|
|
|
25473
25495
|
"description": "",
|
|
25474
25496
|
"slug": "web-contents",
|
|
25475
25497
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents",
|
|
25476
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
25477
|
-
"version": "28.
|
|
25498
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/web-contents.md",
|
|
25499
|
+
"version": "28.3.3",
|
|
25478
25500
|
"type": "Class",
|
|
25479
25501
|
"process": {
|
|
25480
25502
|
"main": true,
|
|
@@ -31408,8 +31430,8 @@
|
|
|
31408
31430
|
"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`.",
|
|
31409
31431
|
"slug": "web-frame-main",
|
|
31410
31432
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
|
|
31411
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
31412
|
-
"version": "28.
|
|
31433
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/web-frame-main.md",
|
|
31434
|
+
"version": "28.3.3",
|
|
31413
31435
|
"type": "Module",
|
|
31414
31436
|
"process": {
|
|
31415
31437
|
"main": true,
|
|
@@ -31464,8 +31486,8 @@
|
|
|
31464
31486
|
"description": "",
|
|
31465
31487
|
"slug": "web-frame-main",
|
|
31466
31488
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
|
|
31467
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
31468
|
-
"version": "28.
|
|
31489
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/web-frame-main.md",
|
|
31490
|
+
"version": "28.3.3",
|
|
31469
31491
|
"type": "Class",
|
|
31470
31492
|
"process": {
|
|
31471
31493
|
"main": true,
|
|
@@ -31764,8 +31786,8 @@
|
|
|
31764
31786
|
"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%.",
|
|
31765
31787
|
"slug": "web-frame",
|
|
31766
31788
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame",
|
|
31767
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
31768
|
-
"version": "28.
|
|
31789
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/web-frame.md",
|
|
31790
|
+
"version": "28.3.3",
|
|
31769
31791
|
"type": "Module",
|
|
31770
31792
|
"process": {
|
|
31771
31793
|
"main": false,
|
|
@@ -32478,8 +32500,8 @@
|
|
|
32478
32500
|
"description": "",
|
|
32479
32501
|
"slug": "web-request",
|
|
32480
32502
|
"websiteUrl": "https://electronjs.org/docs/api/web-request",
|
|
32481
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
32482
|
-
"version": "28.
|
|
32503
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/web-request.md",
|
|
32504
|
+
"version": "28.3.3",
|
|
32483
32505
|
"type": "Class",
|
|
32484
32506
|
"process": {
|
|
32485
32507
|
"main": true,
|
|
@@ -34325,8 +34347,8 @@
|
|
|
34325
34347
|
"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`, Electron's `BrowserView`, 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<br /> _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. **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.",
|
|
34326
34348
|
"slug": "webview-tag",
|
|
34327
34349
|
"websiteUrl": "https://electronjs.org/docs/api/webview-tag",
|
|
34328
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
34329
|
-
"version": "28.
|
|
34350
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/webview-tag.md",
|
|
34351
|
+
"version": "28.3.3",
|
|
34330
34352
|
"type": "Element",
|
|
34331
34353
|
"process": {
|
|
34332
34354
|
"main": false,
|
|
@@ -37473,8 +37495,8 @@
|
|
|
37473
37495
|
"description": "",
|
|
37474
37496
|
"slug": "bluetooth-device",
|
|
37475
37497
|
"websiteUrl": "https://electronjs.org/docs/api/structures/bluetooth-device",
|
|
37476
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
37477
|
-
"version": "28.
|
|
37498
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/bluetooth-device.md",
|
|
37499
|
+
"version": "28.3.3",
|
|
37478
37500
|
"properties": [
|
|
37479
37501
|
{
|
|
37480
37502
|
"name": "deviceName",
|
|
@@ -37502,8 +37524,8 @@
|
|
|
37502
37524
|
"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 (`NSWindowStyleMaskTexturedBackground`).\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`.",
|
|
37503
37525
|
"slug": "browser-window-options",
|
|
37504
37526
|
"websiteUrl": "https://electronjs.org/docs/api/structures/browser-window-options",
|
|
37505
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
37506
|
-
"version": "28.
|
|
37527
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/browser-window-options.md",
|
|
37528
|
+
"version": "28.3.3",
|
|
37507
37529
|
"properties": [
|
|
37508
37530
|
{
|
|
37509
37531
|
"name": "width",
|
|
@@ -38138,8 +38160,8 @@
|
|
|
38138
38160
|
"description": "",
|
|
38139
38161
|
"slug": "certificate-principal",
|
|
38140
38162
|
"websiteUrl": "https://electronjs.org/docs/api/structures/certificate-principal",
|
|
38141
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38142
|
-
"version": "28.
|
|
38163
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/certificate-principal.md",
|
|
38164
|
+
"version": "28.3.3",
|
|
38143
38165
|
"properties": [
|
|
38144
38166
|
{
|
|
38145
38167
|
"name": "commonName",
|
|
@@ -38203,8 +38225,8 @@
|
|
|
38203
38225
|
"description": "",
|
|
38204
38226
|
"slug": "certificate",
|
|
38205
38227
|
"websiteUrl": "https://electronjs.org/docs/api/structures/certificate",
|
|
38206
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38207
|
-
"version": "28.
|
|
38228
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/certificate.md",
|
|
38229
|
+
"version": "28.3.3",
|
|
38208
38230
|
"properties": [
|
|
38209
38231
|
{
|
|
38210
38232
|
"name": "data",
|
|
@@ -38299,8 +38321,8 @@
|
|
|
38299
38321
|
"description": "",
|
|
38300
38322
|
"slug": "cookie",
|
|
38301
38323
|
"websiteUrl": "https://electronjs.org/docs/api/structures/cookie",
|
|
38302
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38303
|
-
"version": "28.
|
|
38324
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/cookie.md",
|
|
38325
|
+
"version": "28.3.3",
|
|
38304
38326
|
"properties": [
|
|
38305
38327
|
{
|
|
38306
38328
|
"name": "name",
|
|
@@ -38412,8 +38434,8 @@
|
|
|
38412
38434
|
"description": "",
|
|
38413
38435
|
"slug": "cpu-usage",
|
|
38414
38436
|
"websiteUrl": "https://electronjs.org/docs/api/structures/cpu-usage",
|
|
38415
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38416
|
-
"version": "28.
|
|
38437
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/cpu-usage.md",
|
|
38438
|
+
"version": "28.3.3",
|
|
38417
38439
|
"properties": [
|
|
38418
38440
|
{
|
|
38419
38441
|
"name": "percentCPUUsage",
|
|
@@ -38439,8 +38461,8 @@
|
|
|
38439
38461
|
"description": "",
|
|
38440
38462
|
"slug": "crash-report",
|
|
38441
38463
|
"websiteUrl": "https://electronjs.org/docs/api/structures/crash-report",
|
|
38442
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38443
|
-
"version": "28.
|
|
38464
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/crash-report.md",
|
|
38465
|
+
"version": "28.3.3",
|
|
38444
38466
|
"properties": [
|
|
38445
38467
|
{
|
|
38446
38468
|
"name": "date",
|
|
@@ -38467,8 +38489,8 @@
|
|
|
38467
38489
|
"description": "",
|
|
38468
38490
|
"slug": "custom-scheme",
|
|
38469
38491
|
"websiteUrl": "https://electronjs.org/docs/api/structures/custom-scheme",
|
|
38470
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38471
|
-
"version": "28.
|
|
38492
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/custom-scheme.md",
|
|
38493
|
+
"version": "28.3.3",
|
|
38472
38494
|
"properties": [
|
|
38473
38495
|
{
|
|
38474
38496
|
"name": "scheme",
|
|
@@ -38561,8 +38583,8 @@
|
|
|
38561
38583
|
"description": "",
|
|
38562
38584
|
"slug": "desktop-capturer-source",
|
|
38563
38585
|
"websiteUrl": "https://electronjs.org/docs/api/structures/desktop-capturer-source",
|
|
38564
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38565
|
-
"version": "28.
|
|
38586
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/desktop-capturer-source.md",
|
|
38587
|
+
"version": "28.3.3",
|
|
38566
38588
|
"properties": [
|
|
38567
38589
|
{
|
|
38568
38590
|
"name": "id",
|
|
@@ -38615,8 +38637,8 @@
|
|
|
38615
38637
|
"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.",
|
|
38616
38638
|
"slug": "display",
|
|
38617
38639
|
"websiteUrl": "https://electronjs.org/docs/api/structures/display",
|
|
38618
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38619
|
-
"version": "28.
|
|
38640
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/display.md",
|
|
38641
|
+
"version": "28.3.3",
|
|
38620
38642
|
"properties": [
|
|
38621
38643
|
{
|
|
38622
38644
|
"name": "accelerometerSupport",
|
|
@@ -38808,8 +38830,8 @@
|
|
|
38808
38830
|
"description": "",
|
|
38809
38831
|
"slug": "extension-info",
|
|
38810
38832
|
"websiteUrl": "https://electronjs.org/docs/api/structures/extension-info",
|
|
38811
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38812
|
-
"version": "28.
|
|
38833
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/extension-info.md",
|
|
38834
|
+
"version": "28.3.3",
|
|
38813
38835
|
"properties": [
|
|
38814
38836
|
{
|
|
38815
38837
|
"name": "name",
|
|
@@ -38837,8 +38859,8 @@
|
|
|
38837
38859
|
"description": "",
|
|
38838
38860
|
"slug": "extension",
|
|
38839
38861
|
"websiteUrl": "https://electronjs.org/docs/api/structures/extension",
|
|
38840
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38841
|
-
"version": "28.
|
|
38862
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/extension.md",
|
|
38863
|
+
"version": "28.3.3",
|
|
38842
38864
|
"properties": [
|
|
38843
38865
|
{
|
|
38844
38866
|
"name": "id",
|
|
@@ -38901,8 +38923,8 @@
|
|
|
38901
38923
|
"description": "",
|
|
38902
38924
|
"slug": "file-filter",
|
|
38903
38925
|
"websiteUrl": "https://electronjs.org/docs/api/structures/file-filter",
|
|
38904
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38905
|
-
"version": "28.
|
|
38926
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/file-filter.md",
|
|
38927
|
+
"version": "28.3.3",
|
|
38906
38928
|
"properties": [
|
|
38907
38929
|
{
|
|
38908
38930
|
"name": "name",
|
|
@@ -38930,8 +38952,8 @@
|
|
|
38930
38952
|
"description": "",
|
|
38931
38953
|
"slug": "file-path-with-headers",
|
|
38932
38954
|
"websiteUrl": "https://electronjs.org/docs/api/structures/file-path-with-headers",
|
|
38933
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38934
|
-
"version": "28.
|
|
38955
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/file-path-with-headers.md",
|
|
38956
|
+
"version": "28.3.3",
|
|
38935
38957
|
"properties": [
|
|
38936
38958
|
{
|
|
38937
38959
|
"name": "path",
|
|
@@ -38970,8 +38992,8 @@
|
|
|
38970
38992
|
"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)",
|
|
38971
38993
|
"slug": "gpu-feature-status",
|
|
38972
38994
|
"websiteUrl": "https://electronjs.org/docs/api/structures/gpu-feature-status",
|
|
38973
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
38974
|
-
"version": "28.
|
|
38995
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/gpu-feature-status.md",
|
|
38996
|
+
"version": "28.3.3",
|
|
38975
38997
|
"properties": [
|
|
38976
38998
|
{
|
|
38977
38999
|
"name": "2d_canvas",
|
|
@@ -39098,8 +39120,8 @@
|
|
|
39098
39120
|
"description": "",
|
|
39099
39121
|
"slug": "hid-device",
|
|
39100
39122
|
"websiteUrl": "https://electronjs.org/docs/api/structures/hid-device",
|
|
39101
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39102
|
-
"version": "28.
|
|
39123
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/hid-device.md",
|
|
39124
|
+
"version": "28.3.3",
|
|
39103
39125
|
"properties": [
|
|
39104
39126
|
{
|
|
39105
39127
|
"name": "deviceId",
|
|
@@ -39161,8 +39183,8 @@
|
|
|
39161
39183
|
"description": "",
|
|
39162
39184
|
"slug": "input-event",
|
|
39163
39185
|
"websiteUrl": "https://electronjs.org/docs/api/structures/input-event",
|
|
39164
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39165
|
-
"version": "28.
|
|
39186
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/input-event.md",
|
|
39187
|
+
"version": "28.3.3",
|
|
39166
39188
|
"properties": [
|
|
39167
39189
|
{
|
|
39168
39190
|
"name": "type",
|
|
@@ -39420,8 +39442,8 @@
|
|
|
39420
39442
|
"description": "",
|
|
39421
39443
|
"slug": "io-counters",
|
|
39422
39444
|
"websiteUrl": "https://electronjs.org/docs/api/structures/io-counters",
|
|
39423
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39424
|
-
"version": "28.
|
|
39445
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/io-counters.md",
|
|
39446
|
+
"version": "28.3.3",
|
|
39425
39447
|
"properties": [
|
|
39426
39448
|
{
|
|
39427
39449
|
"name": "readOperationCount",
|
|
@@ -39480,8 +39502,8 @@
|
|
|
39480
39502
|
"description": "",
|
|
39481
39503
|
"slug": "ipc-main-event",
|
|
39482
39504
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-event",
|
|
39483
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39484
|
-
"version": "28.
|
|
39505
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/ipc-main-event.md",
|
|
39506
|
+
"version": "28.3.3",
|
|
39485
39507
|
"properties": [
|
|
39486
39508
|
{
|
|
39487
39509
|
"name": "processId",
|
|
@@ -39568,8 +39590,8 @@
|
|
|
39568
39590
|
"description": "",
|
|
39569
39591
|
"slug": "ipc-main-invoke-event",
|
|
39570
39592
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-invoke-event",
|
|
39571
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39572
|
-
"version": "28.
|
|
39593
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/ipc-main-invoke-event.md",
|
|
39594
|
+
"version": "28.3.3",
|
|
39573
39595
|
"properties": [
|
|
39574
39596
|
{
|
|
39575
39597
|
"name": "processId",
|
|
@@ -39614,8 +39636,8 @@
|
|
|
39614
39636
|
"description": "",
|
|
39615
39637
|
"slug": "ipc-renderer-event",
|
|
39616
39638
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-renderer-event",
|
|
39617
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39618
|
-
"version": "28.
|
|
39639
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/ipc-renderer-event.md",
|
|
39640
|
+
"version": "28.3.3",
|
|
39619
39641
|
"properties": [
|
|
39620
39642
|
{
|
|
39621
39643
|
"name": "sender",
|
|
@@ -39641,8 +39663,8 @@
|
|
|
39641
39663
|
"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.",
|
|
39642
39664
|
"slug": "jump-list-category",
|
|
39643
39665
|
"websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-category",
|
|
39644
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39645
|
-
"version": "28.
|
|
39666
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/jump-list-category.md",
|
|
39667
|
+
"version": "28.3.3",
|
|
39646
39668
|
"properties": [
|
|
39647
39669
|
{
|
|
39648
39670
|
"name": "type",
|
|
@@ -39695,8 +39717,8 @@
|
|
|
39695
39717
|
"description": "",
|
|
39696
39718
|
"slug": "jump-list-item",
|
|
39697
39719
|
"websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-item",
|
|
39698
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39699
|
-
"version": "28.
|
|
39720
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/jump-list-item.md",
|
|
39721
|
+
"version": "28.3.3",
|
|
39700
39722
|
"properties": [
|
|
39701
39723
|
{
|
|
39702
39724
|
"name": "type",
|
|
@@ -39799,8 +39821,8 @@
|
|
|
39799
39821
|
"description": "",
|
|
39800
39822
|
"slug": "keyboard-event",
|
|
39801
39823
|
"websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-event",
|
|
39802
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39803
|
-
"version": "28.
|
|
39824
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/keyboard-event.md",
|
|
39825
|
+
"version": "28.3.3",
|
|
39804
39826
|
"properties": [
|
|
39805
39827
|
{
|
|
39806
39828
|
"name": "ctrlKey",
|
|
@@ -39851,8 +39873,8 @@
|
|
|
39851
39873
|
"description": "",
|
|
39852
39874
|
"slug": "keyboard-input-event",
|
|
39853
39875
|
"websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-input-event",
|
|
39854
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39855
|
-
"version": "28.
|
|
39876
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/keyboard-input-event.md",
|
|
39877
|
+
"version": "28.3.3",
|
|
39856
39878
|
"properties": [
|
|
39857
39879
|
{
|
|
39858
39880
|
"name": "type",
|
|
@@ -39897,8 +39919,8 @@
|
|
|
39897
39919
|
"description": "Note that all statistics are reported in Kilobytes.",
|
|
39898
39920
|
"slug": "memory-info",
|
|
39899
39921
|
"websiteUrl": "https://electronjs.org/docs/api/structures/memory-info",
|
|
39900
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39901
|
-
"version": "28.
|
|
39922
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/memory-info.md",
|
|
39923
|
+
"version": "28.3.3",
|
|
39902
39924
|
"properties": [
|
|
39903
39925
|
{
|
|
39904
39926
|
"name": "workingSetSize",
|
|
@@ -39934,8 +39956,8 @@
|
|
|
39934
39956
|
"description": "",
|
|
39935
39957
|
"slug": "memory-usage-details",
|
|
39936
39958
|
"websiteUrl": "https://electronjs.org/docs/api/structures/memory-usage-details",
|
|
39937
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39938
|
-
"version": "28.
|
|
39959
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/memory-usage-details.md",
|
|
39960
|
+
"version": "28.3.3",
|
|
39939
39961
|
"properties": [
|
|
39940
39962
|
{
|
|
39941
39963
|
"name": "count",
|
|
@@ -39969,8 +39991,8 @@
|
|
|
39969
39991
|
"description": "",
|
|
39970
39992
|
"slug": "mime-typed-buffer",
|
|
39971
39993
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mime-typed-buffer",
|
|
39972
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
39973
|
-
"version": "28.
|
|
39994
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/mime-typed-buffer.md",
|
|
39995
|
+
"version": "28.3.3",
|
|
39974
39996
|
"properties": [
|
|
39975
39997
|
{
|
|
39976
39998
|
"name": "mimeType",
|
|
@@ -40007,8 +40029,8 @@
|
|
|
40007
40029
|
"description": "",
|
|
40008
40030
|
"slug": "mouse-input-event",
|
|
40009
40031
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mouse-input-event",
|
|
40010
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40011
|
-
"version": "28.
|
|
40032
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/mouse-input-event.md",
|
|
40033
|
+
"version": "28.3.3",
|
|
40012
40034
|
"properties": [
|
|
40013
40035
|
{
|
|
40014
40036
|
"name": "type",
|
|
@@ -40135,8 +40157,8 @@
|
|
|
40135
40157
|
"description": "",
|
|
40136
40158
|
"slug": "mouse-wheel-input-event",
|
|
40137
40159
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mouse-wheel-input-event",
|
|
40138
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40139
|
-
"version": "28.
|
|
40160
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/mouse-wheel-input-event.md",
|
|
40161
|
+
"version": "28.3.3",
|
|
40140
40162
|
"properties": [
|
|
40141
40163
|
{
|
|
40142
40164
|
"name": "type",
|
|
@@ -40224,8 +40246,8 @@
|
|
|
40224
40246
|
"description": "",
|
|
40225
40247
|
"slug": "notification-action",
|
|
40226
40248
|
"websiteUrl": "https://electronjs.org/docs/api/structures/notification-action",
|
|
40227
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40228
|
-
"version": "28.
|
|
40249
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/notification-action.md",
|
|
40250
|
+
"version": "28.3.3",
|
|
40229
40251
|
"properties": [
|
|
40230
40252
|
{
|
|
40231
40253
|
"name": "type",
|
|
@@ -40258,8 +40280,8 @@
|
|
|
40258
40280
|
"description": "",
|
|
40259
40281
|
"slug": "notification-response",
|
|
40260
40282
|
"websiteUrl": "https://electronjs.org/docs/api/structures/notification-response",
|
|
40261
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40262
|
-
"version": "28.
|
|
40283
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/notification-response.md",
|
|
40284
|
+
"version": "28.3.3",
|
|
40263
40285
|
"properties": [
|
|
40264
40286
|
{
|
|
40265
40287
|
"name": "actionIdentifier",
|
|
@@ -40323,8 +40345,8 @@
|
|
|
40323
40345
|
"description": "",
|
|
40324
40346
|
"slug": "payment-discount",
|
|
40325
40347
|
"websiteUrl": "https://electronjs.org/docs/api/structures/payment-discount",
|
|
40326
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40327
|
-
"version": "28.
|
|
40348
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/payment-discount.md",
|
|
40349
|
+
"version": "28.3.3",
|
|
40328
40350
|
"properties": [
|
|
40329
40351
|
{
|
|
40330
40352
|
"name": "identifier",
|
|
@@ -40378,8 +40400,8 @@
|
|
|
40378
40400
|
"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.",
|
|
40379
40401
|
"slug": "point",
|
|
40380
40402
|
"websiteUrl": "https://electronjs.org/docs/api/structures/point",
|
|
40381
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40382
|
-
"version": "28.
|
|
40403
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/point.md",
|
|
40404
|
+
"version": "28.3.3",
|
|
40383
40405
|
"properties": [
|
|
40384
40406
|
{
|
|
40385
40407
|
"name": "x",
|
|
@@ -40405,8 +40427,8 @@
|
|
|
40405
40427
|
"description": "",
|
|
40406
40428
|
"slug": "post-body",
|
|
40407
40429
|
"websiteUrl": "https://electronjs.org/docs/api/structures/post-body",
|
|
40408
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40409
|
-
"version": "28.
|
|
40430
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/post-body.md",
|
|
40431
|
+
"version": "28.3.3",
|
|
40410
40432
|
"properties": [
|
|
40411
40433
|
{
|
|
40412
40434
|
"name": "data",
|
|
@@ -40451,8 +40473,8 @@
|
|
|
40451
40473
|
"description": "",
|
|
40452
40474
|
"slug": "printer-info",
|
|
40453
40475
|
"websiteUrl": "https://electronjs.org/docs/api/structures/printer-info",
|
|
40454
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40455
|
-
"version": "28.
|
|
40476
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/printer-info.md",
|
|
40477
|
+
"version": "28.3.3",
|
|
40456
40478
|
"properties": [
|
|
40457
40479
|
{
|
|
40458
40480
|
"name": "name",
|
|
@@ -40514,8 +40536,8 @@
|
|
|
40514
40536
|
"description": "",
|
|
40515
40537
|
"slug": "process-memory-info",
|
|
40516
40538
|
"websiteUrl": "https://electronjs.org/docs/api/structures/process-memory-info",
|
|
40517
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40518
|
-
"version": "28.
|
|
40539
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/process-memory-info.md",
|
|
40540
|
+
"version": "28.3.3",
|
|
40519
40541
|
"properties": [
|
|
40520
40542
|
{
|
|
40521
40543
|
"name": "residentSet",
|
|
@@ -40552,8 +40574,8 @@
|
|
|
40552
40574
|
"description": "",
|
|
40553
40575
|
"slug": "process-metric",
|
|
40554
40576
|
"websiteUrl": "https://electronjs.org/docs/api/structures/process-metric",
|
|
40555
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40556
|
-
"version": "28.
|
|
40577
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/process-metric.md",
|
|
40578
|
+
"version": "28.3.3",
|
|
40557
40579
|
"properties": [
|
|
40558
40580
|
{
|
|
40559
40581
|
"name": "pid",
|
|
@@ -40702,8 +40724,8 @@
|
|
|
40702
40724
|
"description": "",
|
|
40703
40725
|
"slug": "product-discount",
|
|
40704
40726
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product-discount",
|
|
40705
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40706
|
-
"version": "28.
|
|
40727
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/product-discount.md",
|
|
40728
|
+
"version": "28.3.3",
|
|
40707
40729
|
"properties": [
|
|
40708
40730
|
{
|
|
40709
40731
|
"name": "identifier",
|
|
@@ -40785,8 +40807,8 @@
|
|
|
40785
40807
|
"description": "",
|
|
40786
40808
|
"slug": "product-subscription-period",
|
|
40787
40809
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product-subscription-period",
|
|
40788
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40789
|
-
"version": "28.
|
|
40810
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/product-subscription-period.md",
|
|
40811
|
+
"version": "28.3.3",
|
|
40790
40812
|
"properties": [
|
|
40791
40813
|
{
|
|
40792
40814
|
"name": "numberOfUnits",
|
|
@@ -40830,8 +40852,8 @@
|
|
|
40830
40852
|
"description": "",
|
|
40831
40853
|
"slug": "product",
|
|
40832
40854
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product",
|
|
40833
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40834
|
-
"version": "28.
|
|
40855
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/product.md",
|
|
40856
|
+
"version": "28.3.3",
|
|
40835
40857
|
"properties": [
|
|
40836
40858
|
{
|
|
40837
40859
|
"name": "productIdentifier",
|
|
@@ -40952,8 +40974,8 @@
|
|
|
40952
40974
|
"description": "",
|
|
40953
40975
|
"slug": "protocol-request",
|
|
40954
40976
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-request",
|
|
40955
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
40956
|
-
"version": "28.
|
|
40977
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/protocol-request.md",
|
|
40978
|
+
"version": "28.3.3",
|
|
40957
40979
|
"properties": [
|
|
40958
40980
|
{
|
|
40959
40981
|
"name": "url",
|
|
@@ -41018,8 +41040,8 @@
|
|
|
41018
41040
|
"description": "",
|
|
41019
41041
|
"slug": "protocol-response-upload-data",
|
|
41020
41042
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response-upload-data",
|
|
41021
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41022
|
-
"version": "28.
|
|
41043
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/protocol-response-upload-data.md",
|
|
41044
|
+
"version": "28.3.3",
|
|
41023
41045
|
"properties": [
|
|
41024
41046
|
{
|
|
41025
41047
|
"name": "contentType",
|
|
@@ -41056,8 +41078,8 @@
|
|
|
41056
41078
|
"description": "",
|
|
41057
41079
|
"slug": "protocol-response",
|
|
41058
41080
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response",
|
|
41059
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41060
|
-
"version": "28.
|
|
41081
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/protocol-response.md",
|
|
41082
|
+
"version": "28.3.3",
|
|
41061
41083
|
"properties": [
|
|
41062
41084
|
{
|
|
41063
41085
|
"name": "error",
|
|
@@ -41199,14 +41221,82 @@
|
|
|
41199
41221
|
}
|
|
41200
41222
|
]
|
|
41201
41223
|
},
|
|
41224
|
+
{
|
|
41225
|
+
"type": "Structure",
|
|
41226
|
+
"name": "ProxyConfig",
|
|
41227
|
+
"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\".",
|
|
41228
|
+
"slug": "proxy-config",
|
|
41229
|
+
"websiteUrl": "https://electronjs.org/docs/api/structures/proxy-config",
|
|
41230
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/proxy-config.md",
|
|
41231
|
+
"version": "28.3.3",
|
|
41232
|
+
"properties": [
|
|
41233
|
+
{
|
|
41234
|
+
"name": "mode",
|
|
41235
|
+
"description": "The proxy mode. Should be one of `direct`, `auto_detect`, `pac_script`, `fixed_servers` or `system`. Defaults to `pac_script` proxy mode if `pacScript` option is specified otherwise defaults to `fixed_servers`.",
|
|
41236
|
+
"required": false,
|
|
41237
|
+
"additionalTags": [],
|
|
41238
|
+
"collection": false,
|
|
41239
|
+
"type": "String",
|
|
41240
|
+
"possibleValues": [
|
|
41241
|
+
{
|
|
41242
|
+
"value": "direct",
|
|
41243
|
+
"description": "In direct mode all connections are created directly, without any proxy involved."
|
|
41244
|
+
},
|
|
41245
|
+
{
|
|
41246
|
+
"value": "auto_detect",
|
|
41247
|
+
"description": "In auto_detect mode the proxy configuration is determined by a PAC script that can be downloaded at http://wpad/wpad.dat."
|
|
41248
|
+
},
|
|
41249
|
+
{
|
|
41250
|
+
"value": "pac_script",
|
|
41251
|
+
"description": "In pac_script mode the proxy configuration is determined by a PAC script that is retrieved from the URL specified in the `pacScript`. This is the default mode if `pacScript` is specified."
|
|
41252
|
+
},
|
|
41253
|
+
{
|
|
41254
|
+
"value": "fixed_servers",
|
|
41255
|
+
"description": "In fixed_servers mode the proxy configuration is specified in `proxyRules`. This is the default mode if `proxyRules` is specified."
|
|
41256
|
+
},
|
|
41257
|
+
{
|
|
41258
|
+
"value": "system",
|
|
41259
|
+
"description": "In system mode the proxy configuration is taken from the operating system. Note that the system mode is different from setting no proxy configuration. In the latter case, Electron falls back to the system settings only if no command-line options influence the proxy configuration."
|
|
41260
|
+
}
|
|
41261
|
+
]
|
|
41262
|
+
},
|
|
41263
|
+
{
|
|
41264
|
+
"name": "pacScript",
|
|
41265
|
+
"description": "The URL associated with the PAC file.",
|
|
41266
|
+
"required": false,
|
|
41267
|
+
"additionalTags": [],
|
|
41268
|
+
"collection": false,
|
|
41269
|
+
"type": "String",
|
|
41270
|
+
"possibleValues": null
|
|
41271
|
+
},
|
|
41272
|
+
{
|
|
41273
|
+
"name": "proxyRules",
|
|
41274
|
+
"description": "Rules indicating which proxies to use.",
|
|
41275
|
+
"required": false,
|
|
41276
|
+
"additionalTags": [],
|
|
41277
|
+
"collection": false,
|
|
41278
|
+
"type": "String",
|
|
41279
|
+
"possibleValues": null
|
|
41280
|
+
},
|
|
41281
|
+
{
|
|
41282
|
+
"name": "proxyBypassRules",
|
|
41283
|
+
"description": "Rules indicating which URLs should bypass the proxy settings.",
|
|
41284
|
+
"required": false,
|
|
41285
|
+
"additionalTags": [],
|
|
41286
|
+
"collection": false,
|
|
41287
|
+
"type": "String",
|
|
41288
|
+
"possibleValues": null
|
|
41289
|
+
}
|
|
41290
|
+
]
|
|
41291
|
+
},
|
|
41202
41292
|
{
|
|
41203
41293
|
"type": "Structure",
|
|
41204
41294
|
"name": "Rectangle",
|
|
41205
41295
|
"description": "",
|
|
41206
41296
|
"slug": "rectangle",
|
|
41207
41297
|
"websiteUrl": "https://electronjs.org/docs/api/structures/rectangle",
|
|
41208
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41209
|
-
"version": "28.
|
|
41298
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/rectangle.md",
|
|
41299
|
+
"version": "28.3.3",
|
|
41210
41300
|
"properties": [
|
|
41211
41301
|
{
|
|
41212
41302
|
"name": "x",
|
|
@@ -41248,8 +41338,8 @@
|
|
|
41248
41338
|
"description": "",
|
|
41249
41339
|
"slug": "referrer",
|
|
41250
41340
|
"websiteUrl": "https://electronjs.org/docs/api/structures/referrer",
|
|
41251
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41252
|
-
"version": "28.
|
|
41341
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/referrer.md",
|
|
41342
|
+
"version": "28.3.3",
|
|
41253
41343
|
"properties": [
|
|
41254
41344
|
{
|
|
41255
41345
|
"name": "url",
|
|
@@ -41310,8 +41400,8 @@
|
|
|
41310
41400
|
"description": "",
|
|
41311
41401
|
"slug": "render-process-gone-details",
|
|
41312
41402
|
"websiteUrl": "https://electronjs.org/docs/api/structures/render-process-gone-details",
|
|
41313
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41314
|
-
"version": "28.
|
|
41403
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/render-process-gone-details.md",
|
|
41404
|
+
"version": "28.3.3",
|
|
41315
41405
|
"properties": [
|
|
41316
41406
|
{
|
|
41317
41407
|
"name": "reason",
|
|
@@ -41367,8 +41457,8 @@
|
|
|
41367
41457
|
"description": "",
|
|
41368
41458
|
"slug": "resolved-endpoint",
|
|
41369
41459
|
"websiteUrl": "https://electronjs.org/docs/api/structures/resolved-endpoint",
|
|
41370
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41371
|
-
"version": "28.
|
|
41460
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/resolved-endpoint.md",
|
|
41461
|
+
"version": "28.3.3",
|
|
41372
41462
|
"properties": [
|
|
41373
41463
|
{
|
|
41374
41464
|
"name": "address",
|
|
@@ -41409,8 +41499,8 @@
|
|
|
41409
41499
|
"description": "",
|
|
41410
41500
|
"slug": "resolved-host",
|
|
41411
41501
|
"websiteUrl": "https://electronjs.org/docs/api/structures/resolved-host",
|
|
41412
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41413
|
-
"version": "28.
|
|
41502
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/resolved-host.md",
|
|
41503
|
+
"version": "28.3.3",
|
|
41414
41504
|
"properties": [
|
|
41415
41505
|
{
|
|
41416
41506
|
"name": "endpoints",
|
|
@@ -41428,8 +41518,8 @@
|
|
|
41428
41518
|
"description": "",
|
|
41429
41519
|
"slug": "scrubber-item",
|
|
41430
41520
|
"websiteUrl": "https://electronjs.org/docs/api/structures/scrubber-item",
|
|
41431
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41432
|
-
"version": "28.
|
|
41521
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/scrubber-item.md",
|
|
41522
|
+
"version": "28.3.3",
|
|
41433
41523
|
"properties": [
|
|
41434
41524
|
{
|
|
41435
41525
|
"name": "label",
|
|
@@ -41456,8 +41546,8 @@
|
|
|
41456
41546
|
"description": "",
|
|
41457
41547
|
"slug": "segmented-control-segment",
|
|
41458
41548
|
"websiteUrl": "https://electronjs.org/docs/api/structures/segmented-control-segment",
|
|
41459
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41460
|
-
"version": "28.
|
|
41549
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/segmented-control-segment.md",
|
|
41550
|
+
"version": "28.3.3",
|
|
41461
41551
|
"properties": [
|
|
41462
41552
|
{
|
|
41463
41553
|
"name": "label",
|
|
@@ -41492,8 +41582,8 @@
|
|
|
41492
41582
|
"description": "",
|
|
41493
41583
|
"slug": "serial-port",
|
|
41494
41584
|
"websiteUrl": "https://electronjs.org/docs/api/structures/serial-port",
|
|
41495
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41496
|
-
"version": "28.
|
|
41585
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/serial-port.md",
|
|
41586
|
+
"version": "28.3.3",
|
|
41497
41587
|
"properties": [
|
|
41498
41588
|
{
|
|
41499
41589
|
"name": "portId",
|
|
@@ -41579,8 +41669,8 @@
|
|
|
41579
41669
|
"description": "",
|
|
41580
41670
|
"slug": "service-worker-info",
|
|
41581
41671
|
"websiteUrl": "https://electronjs.org/docs/api/structures/service-worker-info",
|
|
41582
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41583
|
-
"version": "28.
|
|
41672
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/service-worker-info.md",
|
|
41673
|
+
"version": "28.3.3",
|
|
41584
41674
|
"properties": [
|
|
41585
41675
|
{
|
|
41586
41676
|
"name": "scriptUrl",
|
|
@@ -41616,8 +41706,8 @@
|
|
|
41616
41706
|
"description": "",
|
|
41617
41707
|
"slug": "shared-worker-info",
|
|
41618
41708
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shared-worker-info",
|
|
41619
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41620
|
-
"version": "28.
|
|
41709
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/shared-worker-info.md",
|
|
41710
|
+
"version": "28.3.3",
|
|
41621
41711
|
"properties": [
|
|
41622
41712
|
{
|
|
41623
41713
|
"name": "id",
|
|
@@ -41645,8 +41735,8 @@
|
|
|
41645
41735
|
"description": "",
|
|
41646
41736
|
"slug": "sharing-item",
|
|
41647
41737
|
"websiteUrl": "https://electronjs.org/docs/api/structures/sharing-item",
|
|
41648
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41649
|
-
"version": "28.
|
|
41738
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/sharing-item.md",
|
|
41739
|
+
"version": "28.3.3",
|
|
41650
41740
|
"properties": [
|
|
41651
41741
|
{
|
|
41652
41742
|
"name": "texts",
|
|
@@ -41683,8 +41773,8 @@
|
|
|
41683
41773
|
"description": "",
|
|
41684
41774
|
"slug": "shortcut-details",
|
|
41685
41775
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shortcut-details",
|
|
41686
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41687
|
-
"version": "28.
|
|
41776
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/shortcut-details.md",
|
|
41777
|
+
"version": "28.3.3",
|
|
41688
41778
|
"properties": [
|
|
41689
41779
|
{
|
|
41690
41780
|
"name": "target",
|
|
@@ -41765,8 +41855,8 @@
|
|
|
41765
41855
|
"description": "",
|
|
41766
41856
|
"slug": "size",
|
|
41767
41857
|
"websiteUrl": "https://electronjs.org/docs/api/structures/size",
|
|
41768
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41769
|
-
"version": "28.
|
|
41858
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/size.md",
|
|
41859
|
+
"version": "28.3.3",
|
|
41770
41860
|
"properties": [
|
|
41771
41861
|
{
|
|
41772
41862
|
"name": "width",
|
|
@@ -41792,8 +41882,8 @@
|
|
|
41792
41882
|
"description": "",
|
|
41793
41883
|
"slug": "task",
|
|
41794
41884
|
"websiteUrl": "https://electronjs.org/docs/api/structures/task",
|
|
41795
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41796
|
-
"version": "28.
|
|
41885
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/task.md",
|
|
41886
|
+
"version": "28.3.3",
|
|
41797
41887
|
"properties": [
|
|
41798
41888
|
{
|
|
41799
41889
|
"name": "program",
|
|
@@ -41865,8 +41955,8 @@
|
|
|
41865
41955
|
"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.",
|
|
41866
41956
|
"slug": "thumbar-button",
|
|
41867
41957
|
"websiteUrl": "https://electronjs.org/docs/api/structures/thumbar-button",
|
|
41868
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41869
|
-
"version": "28.
|
|
41958
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/thumbar-button.md",
|
|
41959
|
+
"version": "28.3.3",
|
|
41870
41960
|
"properties": [
|
|
41871
41961
|
{
|
|
41872
41962
|
"name": "icon",
|
|
@@ -41912,8 +42002,8 @@
|
|
|
41912
42002
|
"description": "",
|
|
41913
42003
|
"slug": "trace-categories-and-options",
|
|
41914
42004
|
"websiteUrl": "https://electronjs.org/docs/api/structures/trace-categories-and-options",
|
|
41915
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41916
|
-
"version": "28.
|
|
42005
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/trace-categories-and-options.md",
|
|
42006
|
+
"version": "28.3.3",
|
|
41917
42007
|
"properties": [
|
|
41918
42008
|
{
|
|
41919
42009
|
"name": "categoryFilter",
|
|
@@ -41941,8 +42031,8 @@
|
|
|
41941
42031
|
"description": "An example TraceConfig that roughly matches what Chrome DevTools records:",
|
|
41942
42032
|
"slug": "trace-config",
|
|
41943
42033
|
"websiteUrl": "https://electronjs.org/docs/api/structures/trace-config",
|
|
41944
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
41945
|
-
"version": "28.
|
|
42034
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/trace-config.md",
|
|
42035
|
+
"version": "28.3.3",
|
|
41946
42036
|
"properties": [
|
|
41947
42037
|
{
|
|
41948
42038
|
"name": "recording_mode",
|
|
@@ -42056,8 +42146,8 @@
|
|
|
42056
42146
|
"description": "",
|
|
42057
42147
|
"slug": "transaction",
|
|
42058
42148
|
"websiteUrl": "https://electronjs.org/docs/api/structures/transaction",
|
|
42059
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
42060
|
-
"version": "28.
|
|
42149
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/transaction.md",
|
|
42150
|
+
"version": "28.3.3",
|
|
42061
42151
|
"properties": [
|
|
42062
42152
|
{
|
|
42063
42153
|
"name": "transactionIdentifier",
|
|
@@ -42185,8 +42275,8 @@
|
|
|
42185
42275
|
"description": "",
|
|
42186
42276
|
"slug": "upload-data",
|
|
42187
42277
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-data",
|
|
42188
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
42189
|
-
"version": "28.
|
|
42278
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/upload-data.md",
|
|
42279
|
+
"version": "28.3.3",
|
|
42190
42280
|
"properties": [
|
|
42191
42281
|
{
|
|
42192
42282
|
"name": "bytes",
|
|
@@ -42222,8 +42312,8 @@
|
|
|
42222
42312
|
"description": "",
|
|
42223
42313
|
"slug": "upload-file",
|
|
42224
42314
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-file",
|
|
42225
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
42226
|
-
"version": "28.
|
|
42315
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/upload-file.md",
|
|
42316
|
+
"version": "28.3.3",
|
|
42227
42317
|
"properties": [
|
|
42228
42318
|
{
|
|
42229
42319
|
"name": "type",
|
|
@@ -42274,8 +42364,8 @@
|
|
|
42274
42364
|
"description": "",
|
|
42275
42365
|
"slug": "upload-raw-data",
|
|
42276
42366
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-raw-data",
|
|
42277
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
42278
|
-
"version": "28.
|
|
42367
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/upload-raw-data.md",
|
|
42368
|
+
"version": "28.3.3",
|
|
42279
42369
|
"properties": [
|
|
42280
42370
|
{
|
|
42281
42371
|
"name": "type",
|
|
@@ -42301,8 +42391,8 @@
|
|
|
42301
42391
|
"description": "",
|
|
42302
42392
|
"slug": "usb-device",
|
|
42303
42393
|
"websiteUrl": "https://electronjs.org/docs/api/structures/usb-device",
|
|
42304
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
42305
|
-
"version": "28.
|
|
42394
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/usb-device.md",
|
|
42395
|
+
"version": "28.3.3",
|
|
42306
42396
|
"properties": [
|
|
42307
42397
|
{
|
|
42308
42398
|
"name": "deviceId",
|
|
@@ -42436,8 +42526,8 @@
|
|
|
42436
42526
|
"description": "This type is a helper alias, no object will never exist of this type.",
|
|
42437
42527
|
"slug": "user-default-types",
|
|
42438
42528
|
"websiteUrl": "https://electronjs.org/docs/api/structures/user-default-types",
|
|
42439
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
42440
|
-
"version": "28.
|
|
42529
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/user-default-types.md",
|
|
42530
|
+
"version": "28.3.3",
|
|
42441
42531
|
"properties": [
|
|
42442
42532
|
{
|
|
42443
42533
|
"name": "string",
|
|
@@ -42530,8 +42620,8 @@
|
|
|
42530
42620
|
"description": "",
|
|
42531
42621
|
"slug": "web-preferences",
|
|
42532
42622
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-preferences",
|
|
42533
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
42534
|
-
"version": "28.
|
|
42623
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/web-preferences.md",
|
|
42624
|
+
"version": "28.3.3",
|
|
42535
42625
|
"properties": [
|
|
42536
42626
|
{
|
|
42537
42627
|
"name": "devTools",
|
|
@@ -42998,8 +43088,8 @@
|
|
|
42998
43088
|
"description": "",
|
|
42999
43089
|
"slug": "web-request-filter",
|
|
43000
43090
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-request-filter",
|
|
43001
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
43002
|
-
"version": "28.
|
|
43091
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/web-request-filter.md",
|
|
43092
|
+
"version": "28.3.3",
|
|
43003
43093
|
"properties": [
|
|
43004
43094
|
{
|
|
43005
43095
|
"name": "urls",
|
|
@@ -43076,8 +43166,8 @@
|
|
|
43076
43166
|
"description": "",
|
|
43077
43167
|
"slug": "web-source",
|
|
43078
43168
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-source",
|
|
43079
|
-
"repoUrl": "https://github.com/electron/electron/blob/v28.
|
|
43080
|
-
"version": "28.
|
|
43169
|
+
"repoUrl": "https://github.com/electron/electron/blob/v28.3.3/docs/api/structures/web-source.md",
|
|
43170
|
+
"version": "28.3.3",
|
|
43081
43171
|
"properties": [
|
|
43082
43172
|
{
|
|
43083
43173
|
"name": "code",
|