Browser-Window-Message

@aeternity/aepp-sdk/es/utils/aepp-wallet-communication/connection/browser-window-message

Browser window Post Message connector module

This is the complement to @aeternity/aepp-sdk/es/utils/aepp-wallet-communication/connection.

Example

import BrowserWindowMessageConnection from '@aeternity/aepp-sdk/es/utils/aepp-wallet-communication/connection/browser-window-message'

• @aeternity/aepp-sdk/es/utils/aepp-wallet-communication/connection/browser-window-message
  • exports.BrowserWindowMessageConnection([params]) ⇒ Object ⏏
    • .connect(onMessage) ⇒ void
    • .disconnect() ⇒ void
    • .sendMessage(msg) ⇒ void

exports.BrowserWindowMessageConnection([params]) ⇒ Object ⏏

BrowserWindowMessageConnection

Kind: Exported function
rtype: Stamp

Param	Type	Default	Description
[params]	Object	{}	Initializer object
[params.target]	Object	window.parent	Target window for message
[params.self]	Object	window	Host window for message
[params.origin]	Object		Origin of receiver
[params.sendDirection]	Object		Optional field for wrapping messages in additional structure({ type: 'to_aepp'
[params.receiveDirection]	Object	'to_aepp'	Optional(default: 'to_aepp') field for unwrapping messages from additional structure({ type: 'to_aepp'
[params.connectionInfo]	Object	{}	Connection info object
[params.debug]	Boolean	false	Debug flag

exports.BrowserWindowMessageConnection.connect(onMessage) ⇒ void

Connect

Kind: instance method of exports.BrowserWindowMessageConnection
rtype: (onMessage: Function) => void

Param	Type	Description
onMessage	function	Message handler

exports.BrowserWindowMessageConnection.disconnect() ⇒ void

Disconnect

Kind: instance method of exports.BrowserWindowMessageConnection
rtype: () => void

exports.BrowserWindowMessageConnection.sendMessage(msg) ⇒ void

Send message

Kind: instance method of exports.BrowserWindowMessageConnection
rtype: (msg: Object) => void

Param	Type	Description
msg	Object	Message