Class HTMLElementCommunicationsManager

Communications manager base class.

Hierarchy (View Summary)

CommunicationsManagerOf<HTMLElement>
- HTMLElementCommunicationsManager

Index

Constructors

constructor

new HTMLElementCommunicationsManager(
    inboundEndpoint: HTMLElement,
    inboundEventType: string,
    outboundEndpoint: HTMLElement,
    outboundEventType: string,
): HTMLElementCommunicationsManager
Constructor
Parameters
- inboundEndpoint: HTMLElement
  The endpoint for receiving messages.
- inboundEventType: string
  The types of messages to receive.
- outboundEndpoint: HTMLElement
  The endpoint to sent messages.
- outboundEventType: string
  The messages to send.
Returns HTMLElementCommunicationsManager
Inherited from CommunicationsManagerOf.constructor
- Defined in core/children/communications/manager.ts:83

Properties

`Protected`inboundEventType

inboundEventType: string

`Protected`outboundEventType

outboundEventType: string

Methods

dispose

dispose(): void
Dispose of the manager.

Returns void
Inherited from CommunicationsManagerOf.dispose
- Defined in core/children/communications/manager.ts:56

`Protected`disposeCore

disposeCore(): void
Clean any resources before the manager is disposed.

Returns void
Inherited from CommunicationsManagerOf.disposeCore
- Defined in core/children/communications/manager.ts:127

initialize

initialize(): void
Initialize the manager.

Returns void
Inherited from CommunicationsManagerOf.initialize
- Defined in core/children/communications/manager.ts:46

`Protected`initializeCore

initializeCore(): void
Initialize the manager.

Returns void
Inherited from CommunicationsManagerOf.initializeCore
- Defined in core/children/communications/manager.ts:117

`Protected`readEvent

readEvent(e: Event): CommunicationsEvent | null
Read the event and extract the message.
Parameters
- e: Event
Returns CommunicationsEvent | null
Overrides CommunicationsManagerOf.readEvent
- Defined in core/children/communications/htmlElementManager.ts:14

send

send(event: CommunicationsEvent): void
Send a message.
Parameters
- event: CommunicationsEvent
  The message.
Returns void
Inherited from CommunicationsManagerOf.send
- Defined in core/children/communications/manager.ts:170

`Protected`sendEvent

sendEvent(outboundEndpoint: HTMLElement, event: CommunicationsEvent): void
Send a message.
Parameters
- outboundEndpoint: HTMLElement
  The outbound endpoint.
- event: CommunicationsEvent
  The message.
Returns void
Overrides CommunicationsManagerOf.sendEvent
- Defined in core/children/communications/htmlElementManager.ts:38

setEventReceivedCallback

setEventReceivedCallback(callback: (event: CommunicationsEvent) => void): void
The the callback to handle any incoming messages.
Parameters
- callback: (event: CommunicationsEvent) => void
  The callback.
Returns void
Inherited from CommunicationsManagerOf.setEventReceivedCallback
- Defined in core/children/communications/manager.ts:180

`Protected`startReceiving

startReceiving(inboundEndpoint: HTMLElement, handler: (e: Event) => void): void
Start to receive messages
Parameters
- inboundEndpoint: HTMLElement
  The inbound endpoint
- handler: (e: Event) => void
  The event handler
Returns void
Overrides CommunicationsManagerOf.startReceiving
- Defined in core/children/communications/htmlElementManager.ts:24

`Protected`stopReceiving

stopReceiving(inboundEndpoint: HTMLElement, handler: (e: Event) => void): void
Stop receiving messages
Parameters
- inboundEndpoint: HTMLElement
  The inbound endpoint
- handler: (e: Event) => void
  The event handler
Returns void
Overrides CommunicationsManagerOf.stopReceiving
- Defined in core/children/communications/htmlElementManager.ts:31

Class HTMLElementCommunicationsManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HTMLElementCommunicationsManager

Properties

ProtectedinboundEventType

ProtectedoutboundEventType

Methods

dispose

Returns void

ProtecteddisposeCore

Returns void

initialize

Returns void

ProtectedinitializeCore

Returns void

ProtectedreadEvent

Parameters

Returns CommunicationsEvent | null

send

Parameters

Returns void

ProtectedsendEvent

Parameters

Returns void

setEventReceivedCallback

Parameters

Returns void

ProtectedstartReceiving

Parameters

Returns void

ProtectedstopReceiving

Parameters

Returns void

Settings

On This Page

`Protected`inboundEventType

`Protected`outboundEventType

`Protected`disposeCore

`Protected`initializeCore

`Protected`readEvent

`Protected`sendEvent

`Protected`startReceiving

`Protected`stopReceiving