electron/docs/api/structures/ipc-renderer-event.md
Milan Burda 3df6d337f3
feat: add senderIsMainFrame to messages sent via ipcRenderer.sendTo() (#38868)
* feat: add isMainFrame to events emitted via ipcRenderer.sendTo()

* chore: rename isMainFrame to senderIsMainFrame
2023-07-24 14:27:30 +02:00

1,008 B

IpcRendererEvent Object extends Event

  • sender IpcRenderer - The IpcRenderer instance that emitted the event originally
  • senderId Integer - The webContents.id that sent the message, you can call event.sender.sendTo(event.senderId, ...) to reply to the message, see ipcRenderer.sendTo for more information. This only applies to messages sent from a different renderer. Messages sent directly from the main process set event.senderId to 0.
  • senderIsMainFrame boolean (optional) - Whether the message sent via ipcRenderer.sendTo was sent by the main frame. This is relevant when nodeIntegrationInSubFrames is enabled in the originating webContents.
  • ports MessagePort[] - A list of MessagePorts that were transferred with this message