Class CrossWindowContainerCommunicationHandler

Handle the communications on the child component side.

Hierarchy (View Summary)

ContainerCommunicationHandler
- CrossWindowContainerCommunicationHandler

Index

Constructors

Methods

dispose handleEventCore requestContentDispose send sendData

Constructors

constructor

new CrossWindowContainerCommunicationHandler(
    communicationsManager: CrossWindowCommunicationsManager,
    embedId: string,
    containerMethods: ContainerCommunicationHandlerMethods,
): CrossWindowContainerCommunicationHandler
Constructor.
Parameters
- communicationsManager: CrossWindowCommunicationsManager
  A communications manager.
- embedId: string
  The Id of the embedded element.
- containerMethods: ContainerCommunicationHandlerMethods
  The methods to communicate with the container.
Returns CrossWindowContainerCommunicationHandler
Overrides ContainerCommunicationHandler.constructor
- Defined in core/children/crossWindow/containerCommunicationHandler.ts:23

Methods

dispose

dispose(): void
Method invoked to dispose of the handler.

Returns void
Inherited from ContainerCommunicationHandler.dispose
- Defined in core/children/communications/containerHandler.ts:84

`Protected`handleEventCore

handleEventCore(e: CommunicationsEvent): void
Core functionality for handling the incoming events.
Parameters
- e: CommunicationsEvent
  The event.
Returns void
Overrides ContainerCommunicationHandler.handleEventCore
- Defined in core/children/crossWindow/containerCommunicationHandler.ts:35

requestContentDispose

requestContentDispose(): void
Request that the content begins disposing.

Returns void
Inherited from ContainerCommunicationHandler.requestContentDispose
- Defined in core/children/communications/containerHandler.ts:118

send

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

sendData

sendData(data: unknown): void
Send data.
Parameters
- data: unknown
  The data to send.
Returns void
Inherited from ContainerCommunicationHandler.sendData
- Defined in core/children/communications/containerHandler.ts:108