IpcMain

external interface IpcMain(source)

Functions

abstract fun addListener(channel: String, listener: Function<Unit>)

Alias for ipcMain.on.

abstract fun handle(channel: String, listener: Function<Any?>)

Adds a handler for an invokeable IPC. This handler will be called whenever a renderer calls ipcRenderer.invoke(channel, ...args).

handleOnce

abstract fun handleOnce(channel: String, listener: Function<Any?>)

Handles a single invokeable IPC message, then removes the listener. See ipcMain.handle(channel, listener).

off

abstract fun off(channel: String, listener: Function<Unit>)

Removes the specified listener from the listener array for the specified channel.

abstract fun on(channel: String, listener: Function<Unit>)

Listens to channel, when a new message arrives listener would be called with listener(event, args...).

once

abstract fun once(channel: String, listener: Function<Unit>)

Adds a one time listener function for the event. This listener is invoked only the next time a message is sent to channel, after which it is removed.

removeAllListeners

abstract fun removeAllListeners(channel: String = definedExternally)

Removes all listeners from the specified channel. Removes all listeners from all channels if no channel is specified.

removeHandler

abstract fun removeHandler(channel: String)

Removes any handler for channel, if present.

removeListener

abstract fun removeListener(channel: String, listener: Function<Unit>)

Alias for ipcMain.off.