Class ElectronWebContentChannel

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

Hierarchy

AbstractChannel
- ElectronWebContentChannel

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ElectronWebContentChannel(sender: WebContents): ElectronWebContentChannel

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

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>

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

onError

get onError(): Event<unknown>

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

onMessage

get onMessage(): Event<MessageProvider>

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

Methods

close

close(): void

Inherited from AbstractChannel.close
- Defined in packages/core/src/common/message-rpc/channel.ts:97
Close this channel. No onClose event should be sent

Returns void

getWriteBuffer

getWriteBuffer(): WriteBuffer

Overrides AbstractChannel.getWriteBuffer
- Defined in packages/core/src/electron-main/messaging/electron-messaging-contribution.ts:129
Obtain a WriteBuffer to write a message to the channel.

Returns WriteBuffer