kotlin-electron/electron.core/IpcMain

IpcMain

external interface IpcMain : EventEmitter(source)

Functions

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

Alias for ipcMain.on.

external fun addListener(type: EventType, listener: EventListener)

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

external fun eventNames(): ReadonlyArray<EventType>

getMaxListeners

external fun getMaxListeners(): Double

abstract external 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 external fun handleOnce(channel: String, listener: Function<Any?>)

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

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

external fun listeners(type: EventType): ReadonlyArray<EventListener>

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

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

external fun off(type: EventType, listener: EventListener)

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

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

external fun on(type: EventType, listener: EventListener)

abstract external 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.

external fun once(type: EventType, listener: EventListener)

prependListener

external fun prependListener(type: EventType, listener: EventListener)

prependOnceListener

external fun prependOnceListener(type: EventType, listener: EventListener)

external fun rawListeners(type: EventType): ReadonlyArray<EventListener>

removeAllListeners

abstract external fun removeAllListeners(channel: String = definedExternally)

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

external fun removeAllListeners(type: EventType)

abstract external fun removeHandler(channel: String)

Removes any handler for channel, if present.

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

Alias for ipcMain.off.

external fun removeListener(type: EventType, listener: EventListener)

setMaxListeners

external fun setMaxListeners(n: Number)