Type Alias: IPCSender
IPCSender =
object
The part of Electron's WebContents (a renderer) that electronIPCServiceEntrypoint uses: the sender of the invocations and the receiver of the events pushed to its pages.
Methods
isDestroyed()?
optionalisDestroyed():boolean
Tell whether the renderer is destroyed; its clients are then dropped instead of receiving the events.
Returns
boolean
Whether the renderer is destroyed.
off()?
optionaloff(event,listener):unknown
Remove a 'destroyed' listener (removeListener is used without it).
Parameters
event
"destroyed"
The 'destroyed' event.
listener
() => void
The listener to remove.
Returns
unknown
once()
once(
event,listener):unknown
Listen once to the renderer's destruction, which aborts its requests in progress and removes its clients.
Parameters
event
"destroyed"
The 'destroyed' event.
listener
() => void
Called when the renderer is destroyed.
Returns
unknown
removeListener()?
optionalremoveListener(event,listener):unknown
Remove a 'destroyed' listener, when off is missing.
Parameters
event
"destroyed"
The 'destroyed' event.
listener
() => void
The listener to remove.
Returns
unknown
send()?
optionalsend(channel, ...args):void
Send a message to the renderer's main frame, used to push an event to a client without a known frame.
Parameters
channel
string
The IPC channel.
args
...unknown[]
The message's arguments.
Returns
void
sendToFrame()?
optionalsendToFrame(frame,channel, ...args):void
Send a message to a frame of the renderer, used to push an event to the page of a client.
Parameters
frame
[number, number]
The frame's process id and frame id.
channel
string
The IPC channel.
args
...unknown[]
The message's arguments.
Returns
void