mirror of
https://github.com/electron/electron.git
synced 2026-10-28 11:44:46 +08:00
Shelley Vohr
37d0d2b4ce
* chore: patch webrtc to keep the ScreenCast persist mode with the restore token Carries https://webrtc-review.googlesource.com/c/src/+/505860 until it rolls. RestoreTokenManager stores the portal persist mode next to each restore token and BaseCapturerPipeWire::Start() requests that mode when restoring, so a persistent token stays persistent. Existing callers default to transient and behave as before. * feat: allow restoring a desktopCapturer source across launches on Wayland On Wayland desktopCapturer.getSources() shows the xdg-desktop-portal picker on every call, so a screen-capture app has to ask the user again on every launch even though ScreenCast v4 can persist the grant. Add `persistMode` ('transient' | 'persistent') and `restoreToken` options to getSources(), a `restoreToken` property on the returned sources, and desktopCapturer.getRestoreToken(sourceId) to read the token again after it rotates when a stream starts. With a stored persistent token the picker is skipped; a revoked or stale token falls back to the picker. Electron does not store tokens; the docs show how an app can. Other platforms ignore the options and return an empty restoreToken. * docs: say when persistMode is needed with a token and add API history * chore: update the carried webrtc patch to the latest upstream revision The persist mode enum moved to modules/portal/screencast_persist_mode.h upstream, so use it from there instead of including screencast_portal.h. * docs: say how a restored window is matched and handle a cancelled picker GNOME and KDE save a window as its app id and title and restore the open window of that app with the closest title, so a token does not always bring back the window the user picked. The sample now denies the request when the user closes the picker. * docs: format the restore token sample * fix: forward restore tokens from xdg-desktop-portal 1.22.1 Only tokens that parse as a UUID were passed to the portal. Since 1.22.1 it issues 22 character base64 tokens, and accepts those and UUIDs, so every token from a new portal was dropped and the picker came back. Forward what the portal itself accepts. * chore: drop the webrtc patch that has rolled in https://webrtc-review.googlesource.com/c/src/+/505860 is part of the WebRTC that Chromium 157.0.8085.0 pins. * fix: only look up and seed restore tokens for picker sessions Also covers an empty source list and a second request in the docs sample, and adds a round-trip spec. * fix: pass restore tokens through unchecked and require persistMode with them The portal's token grammar changed once already (1.22.1) and copying it here silently dropped valid tokens, so the token now goes to the portal as given: a value it did not issue makes getSources() reject, which the docs and the sample handle. restoreToken without persistMode restored a persistent grant as transient and ended it, so that combination is now an invalid option.
Official Guides
Please make sure that you use the documents that match your Electron version. The version number should be a part of the page URL. If it's not, you are probably using the documentation of a development branch which may contain API changes that are not compatible with your Electron version. To view older versions of the documentation, you can browse by tag on GitHub by opening the "Switch branches/tags" dropdown and selecting the tag that matches your version.
FAQ
There are questions that are asked quite often. Check this out before creating an issue:
Guides and Tutorials
Getting started
Learning the basics
- Adding Features to Your App
- Notifications
- Recent Documents
- Application Progress
- Custom Dock Menu
- Custom Windows Taskbar
- Custom Linux Desktop Actions
- Keyboard Shortcuts
- Offline/Online Detection
- Represented File for macOS BrowserWindows
- Native File Drag & Drop
- Navigation History
- Window State Persistence
- Offscreen Rendering
- Dark Mode
- Web embeds in Electron
Advanced steps
- Application Architecture
- Accessibility
- Testing and Debugging
- Distribution
- Updates
- Getting Support
Detailed Tutorials
These individual tutorials expand on topics discussed in the guide above.
- Installing Electron
- Electron Releases & Developer Feedback
API References
- Process Object
- Supported Command Line Switches
- Environment Variables
- Chrome Extensions Support
- Breaking API Changes
Custom Web Features:
Modules for the Main Process:
- app
- autoUpdater
- BaseWindow
- BrowserWindow
- contentTracing
- desktopCapturer
- dialog
- globalShortcut
- inAppPurchase
- ImageView
- ipcMain
- Menu
- MenuItem
- MessageChannelMain
- MessagePortMain
- nativeTheme
- net
- netLog
- Notification
- powerMonitor
- powerSaveBlocker
- protocol
- pushNotifications
- safeStorage
- screen
- ServiceWorkerMain
- session
- ShareMenu
- systemPreferences
- TouchBar
- Tray
- utilityProcess
- View
- webContents
- webFrameMain
- WebContentsView
Modules for the Renderer Process (Web Page):
Modules for Both Processes:
- clipboard (non-sandboxed renderers only)
- crashReporter
- nativeImage
- shell (non-sandboxed renderers only)