Last updated

Class: FrameAgent

Hierarchy

Table of contents

Properties

Constructors

Methods

Properties

id

id: string


remote

remote: boolean = false

Constructors

constructor

new FrameAgent(win?)

Parameters

NameType
win?Window

Overrides

EventEmitter.constructor

Methods

send

send(data, peerId?): void

Parameters

NameTypeDefault value
dataanyundefined
peerIdstringnull

Returns

void


sendSync

sendSync(data, options?): Promise<unknown>

Parameters

NameType
dataany
optionsObject
options.timeout?number
options.peerId?string

Returns

Promise<unknown>


createPeer

createPeer(onDataCallback?): Promise<PeerAgent>

Parameters

NameType
onDataCallback?Function

Returns

Promise<PeerAgent>


loadPeer

loadPeer(peerId, peerWindow): Promise<PeerAgent>

Parameters

NameType
peerIdstring
peerWindowWindow

Returns

Promise<PeerAgent>


removePeer

removePeer(peerId): void

Parameters

NameType
peerIdstring

Returns

void


destroy

destroy(peerId?): void

Parameters

NameType
peerId?string

Returns

void