electron/docs/api/structures/ipc-main-event.md

# 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](../web-contents.md) - Returns the `webContents` that sent the message
* `senderFrame` [WebFrameMain](../web-frame-main.md) | null _Readonly_ - The frame that sent this message. May be `null` if accessed after the frame has either navigated or been destroyed.
* `ports` [MessagePortMain](../message-port-main.md)[] - 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[]
refactor: Split 'Event' docs/types into more specific Event types (#17038) * Event = Base event type (with preventDefault) * IpcMainEvent = Event that ipcMain emits (with sender, reply, etc.) * IpcRendererEvent = Event that ipcRenderer emits (with sender, senderId, etc.) * KeyboardEvent = Event that we emit with keyboard flags (ctrlKey, altKey, etc.) This will dramatically improve peoples TS experience with IPC events 2019-02-19 09:24:19 +00:00			# IpcMainEvent Object extends `Event`

fix: restrict sendToFrame to same-process frames by default (#26875) 2020-12-09 20:48:16 +00:00			* `processId` Integer - The internal ID of the renderer process that sent this message
refactor: Split 'Event' docs/types into more specific Event types (#17038) * Event = Base event type (with preventDefault) * IpcMainEvent = Event that ipcMain emits (with sender, reply, etc.) * IpcRendererEvent = Event that ipcRenderer emits (with sender, senderId, etc.) * KeyboardEvent = Event that we emit with keyboard flags (ctrlKey, altKey, etc.) This will dramatically improve peoples TS experience with IPC events 2019-02-19 09:24:19 +00:00			* `frameId` Integer - The ID of the renderer frame that sent this message
docs: fix spelling and grammar errors (#18910) 2019-06-21 21:19:21 +00:00			* `returnValue` any - Set this to the value to be returned in a synchronous message
docs: add links to IPC event structures (#37760) 2023-03-30 17:13:21 +00:00			* `sender` [WebContents](../web-contents.md) - Returns the `webContents` that sent the message
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 :shrug: * 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 22:33:53 +00:00			* `senderFrame` [WebFrameMain](../web-frame-main.md) \| null _Readonly_ - The frame that sent this message. May be `null` if accessed after the frame has either navigated or been destroyed.
docs: add links to IPC event structures (#37760) 2023-03-30 17:13:21 +00:00			* `ports` [MessagePortMain](../message-port-main.md)[] - A list of MessagePorts that were transferred with this message
docs: fix spelling and grammar errors (#18910) 2019-06-21 21:19:21 +00:00			* `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.
docs: type names changed from wrapper to primitive (#31752) 2021-11-16 04:13:18 +00:00			* `channel` string
refactor: Split 'Event' docs/types into more specific Event types (#17038) * Event = Base event type (with preventDefault) * IpcMainEvent = Event that ipcMain emits (with sender, reply, etc.) * IpcRendererEvent = Event that ipcRenderer emits (with sender, senderId, etc.) * KeyboardEvent = Event that we emit with keyboard flags (ctrlKey, altKey, etc.) This will dramatically improve peoples TS experience with IPC events 2019-02-19 09:24:19 +00:00			* `...args` any[]