API Reference
classes
Neighbourhoodproxy

@coasys/ad4m / Exports / NeighbourhoodProxy

Class: NeighbourhoodProxy

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new NeighbourhoodProxy(client, pID)

Parameters

NameType
clientNeighbourhoodClient
pIDstring

Defined in

neighbourhood/NeighbourhoodProxy.ts:10

Properties

#client

Private #client: NeighbourhoodClient

Defined in

neighbourhood/NeighbourhoodProxy.ts:7


#pID

Private #pID: string

Defined in

neighbourhood/NeighbourhoodProxy.ts:8

Methods

addSignalHandler

addSignalHandler(handler): Promise<void>

Parameters

NameType
handler(payload: PerspectiveExpression) => void

Returns

Promise<void>

Defined in

neighbourhood/NeighbourhoodProxy.ts:51


hasTelepresenceAdapter

hasTelepresenceAdapter(): Promise<boolean>

Returns

Promise<boolean>

Defined in

neighbourhood/NeighbourhoodProxy.ts:19


onlineAgents

onlineAgents(): Promise<OnlineAgent[]>

Returns

Promise<OnlineAgent[]>

Defined in

neighbourhood/NeighbourhoodProxy.ts:23


otherAgents

otherAgents(): Promise<string[]>

Returns

Promise<string[]>

Defined in

neighbourhood/NeighbourhoodProxy.ts:15


removeSignalHandler

removeSignalHandler(handler): void

Parameters

NameType
handler(payload: PerspectiveExpression) => void

Returns

void

Defined in

neighbourhood/NeighbourhoodProxy.ts:55


sendBroadcast

sendBroadcast(payload, loopback?): Promise<boolean>

Parameters

NameTypeDefault value
payloadPerspectiveundefined
loopbackbooleanfalse

Returns

Promise<boolean>

Defined in

neighbourhood/NeighbourhoodProxy.ts:43


sendBroadcastU

sendBroadcastU(payload, loopback?): Promise<boolean>

Parameters

NameTypeDefault value
payloadPerspectiveUnsignedInputundefined
loopbackbooleanfalse

Returns

Promise<boolean>

Defined in

neighbourhood/NeighbourhoodProxy.ts:47


sendSignal

sendSignal(remoteAgentDid, payload): Promise<boolean>

Parameters

NameType
remoteAgentDidstring
payloadPerspective

Returns

Promise<boolean>

Defined in

neighbourhood/NeighbourhoodProxy.ts:35


sendSignalU

sendSignalU(remoteAgentDid, payload): Promise<boolean>

Parameters

NameType
remoteAgentDidstring
payloadPerspectiveUnsignedInput

Returns

Promise<boolean>

Defined in

neighbourhood/NeighbourhoodProxy.ts:39


setOnlineStatus

setOnlineStatus(status): Promise<boolean>

Parameters

NameType
statusPerspective

Returns

Promise<boolean>

Defined in

neighbourhood/NeighbourhoodProxy.ts:27


setOnlineStatusU

setOnlineStatusU(status): Promise<boolean>

Parameters

NameType
statusPerspectiveUnsignedInput

Returns

Promise<boolean>

Defined in

neighbourhood/NeighbourhoodProxy.ts:31