Last updated

Class: PeerAgent

Hierarchy

Table of contents

Properties

Methods

Constructors

Accessors

Properties

id

id: string

Inherited from

FrameAgent.id


remote

remote: boolean = false

Inherited from

FrameAgent.remote


channel

channel: Channel


onDataCallback

onDataCallback: Function

Methods

createPeer

createPeer(onDataCallback?): Promise<PeerAgent>

Parameters

NameType
onDataCallback?Function

Returns

Promise<PeerAgent>

Inherited from

FrameAgent.createPeer


loadPeer

loadPeer(peerId, peerWindow): Promise<PeerAgent>

Parameters

NameType
peerIdstring
peerWindowWindow

Returns

Promise<PeerAgent>

Inherited from

FrameAgent.loadPeer


removePeer

removePeer(peerId): void

Parameters

NameType
peerIdstring

Returns

void

Inherited from

FrameAgent.removePeer


send

send(data): void

Parameters

NameType
dataany

Returns

void

Overrides

FrameAgent.send


sendSync

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

Parameters

NameType
dataany
optionsObject
options.timeout?number

Returns

Promise<unknown>

Overrides

FrameAgent.sendSync


sendCode

sendCode(code, options?): Promise<unknown>

Parameters

NameType
codestring
optionsObject
options.timeout?number

Returns

Promise<unknown>


sendRPC

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

Parameters

NameType
dataRPCData
optionsObject
options.timeout?number

Returns

Promise<unknown>


sendEvent

sendEvent(data): void

Parameters

NameType
dataEventPayload

Returns

void


navigate(data): void

Parameters

Returns

void


connect

connect(win): Promise<void>

Parameters

NameType
winWindow

Returns

Promise<void>


destroy

destroy(): void

Returns

void

Overrides

FrameAgent.destroy

Constructors

constructor

new PeerAgent(localWin, onDataCallback?)

Parameters

NameType
localWinWindow
onDataCallback?Function

Overrides

FrameAgent.constructor

Accessors

isRegistered

get isRegistered(): boolean

Returns

boolean