Class WindowPostMessageProxy

Hierarchy

WindowPostMessageProxy

Constructors

constructor

new WindowPostMessageProxy(options?: IWindowPostMessageProxyOptions): WindowPostMessageProxy

- Defined in windowPostMessageProxy.ts:74
Parameters
- Default value options: IWindowPostMessageProxyOptions = {processTrackingProperties: {addTrackingProperties: WindowPostMessageProxy.defaultAddTrackingProperties,getTrackingProperties: WindowPostMessageProxy.defaultGetTrackingProperties},isErrorMessage: WindowPostMessageProxy.defaultIsErrorMessage,receiveWindow: window,name: WindowPostMessageProxy.createRandomString()}
Returns WindowPostMessageProxy

Properties

Private addTrackingProperties

addTrackingProperties: IAddTrackingProperties

Private eventSourceOverrideWindow

eventSourceOverrideWindow: Window

Private getTrackingProperties

getTrackingProperties: IGetTrackingProperties

Private handlers

handlers: IMessageHandler[]

Private isErrorMessage

isErrorMessage: IIsErrorMessage

Private logMessages

logMessages: boolean

Private name

name: string

Private pendingRequestPromises

pendingRequestPromises: IDeferredCache

Private receiveWindow

receiveWindow: Window

Private suppressWarnings

suppressWarnings: boolean

Private windowMessageHandler

windowMessageHandler: function

Type declaration

- (e: MessageEvent): any
- Parameters
  - e: MessageEvent
  Returns any

Static Private messagePropertyName

messagePropertyName: string = "windowPostMessageProxy"

Methods

addHandler

addHandler(handler: IMessageHandler): void

- Defined in windowPostMessageProxy.ts:111
Adds handler. If the first handler whose test method returns true will handle the message and provide a response.

Parameters
- handler: IMessageHandler
Returns void

Private onMessageReceived

onMessageReceived(event: MessageEvent): void

- Defined in windowPostMessageProxy.ts:179
Message handler.

Parameters
- event: MessageEvent
Returns void

postMessage

postMessage<T>(targetWindow: Window, message: any): Promise

- Defined in windowPostMessageProxy.ts:144
Post message to target window with tracking properties added and save deferred object referenced by tracking id.

Type parameters
- T
Parameters
- targetWindow: Window
- message: any
Returns Promise

removeHandler

removeHandler(handler: IMessageHandler): void

- Defined in windowPostMessageProxy.ts:118
Removes handler. The reference must match the original object that was provided when adding the handler.

Parameters
- handler: IMessageHandler
Returns void

Private sendResponse

sendResponse(targetWindow: Window, message: any, trackingProperties: ITrackingProperties): void

- Defined in windowPostMessageProxy.ts:165
Send response message to target window. Response messages re-use tracking properties from a previous request message.

Parameters
- targetWindow: Window
- message: any
- trackingProperties: ITrackingProperties
Returns void

start

start(): void

- Defined in windowPostMessageProxy.ts:130
Start listening to message events.

Returns void

stop

stop(): void

- Defined in windowPostMessageProxy.ts:137
Stops listening to message events.

Returns void

Static Private createDeferred

createDeferred(): IDeferred

- Defined in windowPostMessageProxy.ts:298
Utility to create a deferred object.

Returns IDeferred

Static Private createRandomString

createRandomString(): string

- Defined in windowPostMessageProxy.ts:318
Utility to generate random sequence of characters used as tracking id for promises.

Returns string

Static defaultAddTrackingProperties

defaultAddTrackingProperties<T>(message: T, trackingProperties: ITrackingProperties): T

- Defined in windowPostMessageProxy.ts:49
Type parameters
- T
Parameters
- message: T
- trackingProperties: ITrackingProperties
Returns T

Static defaultGetTrackingProperties

defaultGetTrackingProperties(message: any): ITrackingProperties

- Defined in windowPostMessageProxy.ts:53
Parameters
- message: any
Returns ITrackingProperties

Static defaultIsErrorMessage

defaultIsErrorMessage(message: any): boolean

- Defined in windowPostMessageProxy.ts:57
Parameters
- message: any
Returns boolean

Generated using TypeDoc