Class ReportLibMessenger

Index

Constructors

Properties

callListeners invokeCallback listeners messageListener parentOrigin parentWindow showError

Methods

deRegisterAllListeners deRegisterListener listenOnce registerListener sendToParent

Constructors

constructor

new ReportLibMessenger(): ReportLibMessenger
Returns ReportLibMessenger

Properties

`Private` callListeners

callListeners: any

`Private` invokeCallback

invokeCallback: any

`Private` listeners

listeners: any

`Private` messageListener

messageListener: any

Handler for window message events

`Private` parentOrigin

parentOrigin: any

`Private` parentWindow

parentWindow: any

`Private` showError

showError: any

Methods

deRegisterAllListeners

deRegisterAllListeners(): void
Returns void

deRegisterListener

deRegisterListener(id?, listener?): void
Parameters
- Optional id: string
- Optional listener: Listener
Returns void

listenOnce

listenOnce<T>(id?): Promise<T>
Type Parameters
- T = any
Parameters
- Optional id: string
Returns Promise<T>

registerListener

registerListener(id, listener, callOnError?): void
Call listener whenever a message with the given id (or otherwise any message) is received from the parent
Parameters
- id: string
- listener: Listener
- Optional callOnError: boolean
Returns void

sendToParent

sendToParent<S, T>(_message): void
Send a message to the parent
Type Parameters
- S
- T
Parameters
- _message: MessageFromReport<S>
Returns void
sendToParent<S, T>(_message, _returnPromise): Promise<T>
Type Parameters
- S
- T
Parameters
- _message: MessageFromReport<S>
- _returnPromise: true
Returns Promise<T>

Generated using TypeDoc