mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions
electron/docs/api/structures/ipc-main-event.md
Sam Maddock 8b3d70a2a3
feat: add WebFrameMain detached property (#43473) 
* feat: add WebFrameMain detached property

fix: throw instead of returning null senderFrame

test: detached frames

fix: ensure IPCs of pending deletion RFHs are dispatched

fix: lookup WFM by FTN ID to dispatch IPCs

feat: add frame.isDestroyed()

return null

fix: return undefined

docs: add null to all frame properties

refactor: option c, return null and emit warning

refactor: add routingId & processId to navigation events

test: null frame property

docs: clarify warning message

better wording

clarify null frame

fix: browserwindow spec

* maybe fix 🤷

* fix: use updated util #43722

* docs: add notice for frame change of behavior

* docs: clarify why frame properties may be null

* lint

* wip

* fix: content::FrameTreeNodeId lookup and converter

* refactor: avoid holey array deoptimization

---------

Co-authored-by: John Kleinschmidt <jkleinsc@electronjs.org>
2024-10-11 18:33:53 -04:00

1,010 B
Raw Blame History

IpcMainEvent Object extends Event

  • processId Integer - The internal ID of the renderer process that sent this message
  • frameId Integer - The ID of the renderer frame that sent this message
  • returnValue any - Set this to the value to be returned in a synchronous message
  • sender WebContents - Returns the webContents that sent the message
  • senderFrame WebFrameMain | null Readonly - The frame that sent this message. May be null if accessed after the frame has either navigated or been destroyed.
  • ports MessagePortMain[] - A list of MessagePorts that were transferred with this message
  • reply Function - A function that will send an IPC message to the renderer frame that sent the original message that you are currently handling. You should use this method to "reply" to the sent message in order to guarantee the reply will go to the correct process and frame.
    • channel string
    • ...args any[]