kotlin-electron/electron.core/IpcMainEvent

IpcMainEvent

external interface IpcMainEvent : Event<Any> (source)

Properties

Link copied to clipboard
abstract external val defaultPrevented: Boolean
Link copied to clipboard
abstract external var frameId: Double

The ID of the renderer frame that sent this message

Link copied to clipboard
open external val params: Any
Link copied to clipboard
abstract external var ports: ReadonlyArray<MessagePortMain>

A list of MessagePorts that were transferred with this message

Link copied to clipboard
abstract external var preventDefault: () -> Unit
Link copied to clipboard
abstract external var processId: Double

The internal ID of the renderer process that sent this message

Link copied to clipboard
abstract external var reply: Function<Unit>

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.

Link copied to clipboard
abstract external var returnValue: Any?

Set this to the value to be returned in a synchronous message

Link copied to clipboard
abstract external var sender: WebContents

Returns the webContents that sent the message

Link copied to clipboard
abstract external val senderFrame: WebFrameMain?

The frame that sent this message. May be null if accessed after the frame has either navigated or been destroyed.

Link copied to clipboard
abstract external var type: String

Possible values include frame

Generated by Dokka
© 2026 Copyright