Class Communicator

use to communicate between browser (runtime-connector) and extension (dataverse-kernel)

Index

Constructors

Properties

allowOrigins callbackFunctions destroyed handleRequestMessage handleResponseMessage methodClass postMessageTo responseSequenceIds sequenceId sourceOrigin targetOrigin

Methods

_onmessage destroy onRequestMessage onResponseMessage sendRequest sendResponse

Constructors

constructor

new Communicator(__namedParameters): Communicator
Parameters
- __namedParameters: {
      methodClass?: any;
      source: Window;
      target: Window;
  }
  - Optional methodClass?: any
  - source: Window
  - target: Window
Returns Communicator
- Defined in communicator.ts:31

Properties

`Protected` allowOrigins

allowOrigins: string = "*"

`Protected` callbackFunctions

callbackFunctions: Record<string, Function> = {}

`Protected` destroyed

destroyed: boolean = false

`Private` handleRequestMessage

handleRequestMessage: Function

`Private` handleResponseMessage

handleResponseMessage: Function

`Protected` methodClass

methodClass: any

`Protected` postMessageTo

postMessageTo: PostMessageTo

`Protected` responseSequenceIds

responseSequenceIds: Record<string, boolean> = {}

`Protected` sequenceId

sequenceId: string = ...

`Protected` sourceOrigin

sourceOrigin: Window

`Protected` targetOrigin

targetOrigin: Window

Methods

`Private` _onmessage

_onmessage(event): Promise<void>
Parameters
- event: MessageEvent<any>
Returns Promise<void>
- Defined in communicator.ts:83

destroy

destroy(): void
Returns void
- Defined in communicator.ts:166

onRequestMessage

onRequestMessage(fn): void
Parameters
- fn: ((event) => void)
  - - (event): void
    - Parameters
      event: MessageEvent<any>
      Returns void
Returns void
- Defined in communicator.ts:157

onResponseMessage

onResponseMessage(fn): void
Parameters
- fn: ((event) => void)
  - - (event): void
    - Parameters
      event: MessageEvent<any>
      Returns void
Returns void
- Defined in communicator.ts:162

sendRequest

sendRequest(args): Promise<unknown>
Parameters
- args: RequestInputs
Returns Promise<unknown>
- Defined in communicator.ts:46

sendResponse

sendResponse(args): void
Parameters
- args: ResponseArguments & {
  origin: string;
  }
Returns void
- Defined in communicator.ts:70

Generated using TypeDoc