kotlin-electron/electron.core/IpcMain

IpcMain

external interface IpcMain : EventEmitter(source)

Functions

fun addListener(type: EventType, listener: EventListener)

fun emit(type: EventType, vararg args: Any?): Boolean

fun eventNames(): Array<EventType>

getMaxListeners

fun getMaxListeners(): Double

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).

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

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

fun listenerCount(type: EventType, listener: EventListener): Double

fun listeners(type: EventType): Array<EventListener>

fun off(type: EventType, listener: EventListener)

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

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

fun on(type: EventType, listener: EventListener)

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.

fun once(type: EventType, listener: EventListener)

prependListener

fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

fun prependOnceListener(type: EventType, listener: EventListener)

fun rawListeners(type: EventType): Array<EventListener>

removeAllListeners

abstract fun removeAllListeners(channel: String = definedExternally)

Removes listeners of the specified channel.

fun removeAllListeners(type: EventType)

abstract fun removeHandler(channel: String)

Removes any handler for channel, if present.

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

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

fun removeListener(type: EventType, listener: EventListener)

setMaxListeners

fun setMaxListeners(n: Number)