Class ElectronWebContentChannel

Used to establish a connection between the ipcMain and the Electron frontend (window). Messages a transferred via electron IPC.

Hierarchy (view full)

AbstractChannel
- ElectronWebContentChannel

Index

Constructors

Properties

onCloseEmitter onErrorEmitter onMessageEmitter sender toDispose

Accessors

onClose onError onMessage

Methods

close getWriteBuffer

Constructors

constructor

new ElectronWebContentChannel(sender): ElectronWebContentChannel
Parameters
- sender: WebContents
Returns ElectronWebContentChannel
Overrides AbstractChannel.constructor
- Defined in packages/core/src/electron-main/messaging/electron-messaging-contribution.ts:127

Properties

onCloseEmitter

onCloseEmitter: Emitter<ChannelCloseEvent> = ...

onErrorEmitter

onErrorEmitter: Emitter<unknown> = ...

`Readonly` onMessageEmitter

onMessageEmitter: Emitter<MessageProvider> = ...

`Protected` `Readonly` sender

sender: WebContents

`Protected` toDispose

toDispose: DisposableCollection = ...

Accessors

onClose

get onClose(): Event<ChannelCloseEvent>
The remote side has closed the channel

Returns Event<ChannelCloseEvent>
Inherited from AbstractChannel.onClose
- Defined in packages/core/src/common/message-rpc/channel.ts:77

onError

get onError(): Event<unknown>
An error has occurred while writing to or reading from the channel

Returns Event<unknown>
Inherited from AbstractChannel.onError
- Defined in packages/core/src/common/message-rpc/channel.ts:82

onMessage

get onMessage(): Event<MessageProvider>
A message has arrived and can be read by listeners using a MessageProvider.

Returns Event<MessageProvider>
Inherited from AbstractChannel.onMessage
- Defined in packages/core/src/common/message-rpc/channel.ts:87

Methods

close

close(): void
Close this channel. No onClose event should be sent

Returns void
Inherited from AbstractChannel.close
- Defined in packages/core/src/common/message-rpc/channel.ts:97

getWriteBuffer

getWriteBuffer(): WriteBuffer
Obtain a WriteBuffer to write a message to the channel.

Returns WriteBuffer
Overrides AbstractChannel.getWriteBuffer
- Defined in packages/core/src/electron-main/messaging/electron-messaging-contribution.ts:131