main/overlays
Functions
Section titled “Functions”existingOverlay()
Section titled “existingOverlay()”existingOverlay(
window):WindowOverlay|undefined
Defined in: app/src/main/overlays.ts:75
The overlay of a window, if it has one already.
Parameters
Section titled “Parameters”window
Section titled “window”The window.
Returns
Section titled “Returns”WindowOverlay | undefined
overlayBySender()
Section titled “overlayBySender()”overlayBySender(
senderId):WindowOverlay|undefined
Defined in: app/src/main/overlays.ts:55
The overlay whose page sent a request.
Parameters
Section titled “Parameters”senderId
Section titled “senderId”number
The id of the sending web contents.
Returns
Section titled “Returns”WindowOverlay | undefined
overlayOf()
Section titled “overlayOf()”overlayOf(
window,options,router):WindowOverlay
Defined in: app/src/main/overlays.ts:17
The overlay of a window, made with its first popover or prompt. The first overlay connects the channels that every overlay page uses.
Parameters
Section titled “Parameters”window
Section titled “window”The window.
options
Section titled “options”What the overlays of all windows share.
router
Section titled “router”IPC router.
Returns
Section titled “Returns”track()
Section titled “track()”track(
window,overlay):void
Defined in: app/src/main/overlays.ts:43
Remembers which page belongs to an overlay that is open, so its requests find it.
Parameters
Section titled “Parameters”window
Section titled “window”The overlay’s window.
overlay
Section titled “overlay”The overlay, after it opened.
Returns
Section titled “Returns”void
windowOfOverlay()
Section titled “windowOfOverlay()”windowOfOverlay(
windows,overlay):BrowserWindowController|undefined
Defined in: app/src/main/overlays.ts:64
The window of an overlay.
Parameters
Section titled “Parameters”windows
Section titled “windows”readonly BrowserWindowController[]
The open windows.
overlay
Section titled “overlay”The overlay.
Returns
Section titled “Returns”BrowserWindowController | undefined