@coasys/ad4m / Exports / NeighbourhoodProxy
Class: NeighbourhoodProxy
Table of contents
Constructors
Properties
Methods
- addSignalHandler
- hasTelepresenceAdapter
- onlineAgents
- otherAgents
- removeSignalHandler
- sendBroadcast
- sendBroadcastU
- sendSignal
- sendSignalU
- setOnlineStatus
- setOnlineStatusU
Constructors
constructor
• new NeighbourhoodProxy(client, pID)
Parameters
| Name | Type |
|---|---|
client | NeighbourhoodClient |
pID | string |
Defined in
neighbourhood/NeighbourhoodProxy.ts:10 (opens in a new tab)
Properties
#client
• Private #client: NeighbourhoodClient
Defined in
neighbourhood/NeighbourhoodProxy.ts:7 (opens in a new tab)
#pID
• Private #pID: string
Defined in
neighbourhood/NeighbourhoodProxy.ts:8 (opens in a new tab)
Methods
addSignalHandler
▸ addSignalHandler(handler): Promise<void>
Parameters
| Name | Type |
|---|---|
handler | (payload: PerspectiveExpression) => void |
Returns
Promise<void>
Defined in
neighbourhood/NeighbourhoodProxy.ts:51 (opens in a new tab)
hasTelepresenceAdapter
▸ hasTelepresenceAdapter(): Promise<boolean>
Returns
Promise<boolean>
Defined in
neighbourhood/NeighbourhoodProxy.ts:19 (opens in a new tab)
onlineAgents
▸ onlineAgents(): Promise<OnlineAgent[]>
Returns
Promise<OnlineAgent[]>
Defined in
neighbourhood/NeighbourhoodProxy.ts:23 (opens in a new tab)
otherAgents
▸ otherAgents(): Promise<string[]>
Returns
Promise<string[]>
Defined in
neighbourhood/NeighbourhoodProxy.ts:15 (opens in a new tab)
removeSignalHandler
▸ removeSignalHandler(handler): void
Parameters
| Name | Type |
|---|---|
handler | (payload: PerspectiveExpression) => void |
Returns
void
Defined in
neighbourhood/NeighbourhoodProxy.ts:55 (opens in a new tab)
sendBroadcast
▸ sendBroadcast(payload): Promise<boolean>
Parameters
| Name | Type |
|---|---|
payload | Perspective |
Returns
Promise<boolean>
Defined in
neighbourhood/NeighbourhoodProxy.ts:43 (opens in a new tab)
sendBroadcastU
▸ sendBroadcastU(payload): Promise<boolean>
Parameters
| Name | Type |
|---|---|
payload | PerspectiveUnsignedInput |
Returns
Promise<boolean>
Defined in
neighbourhood/NeighbourhoodProxy.ts:47 (opens in a new tab)
sendSignal
▸ sendSignal(remoteAgentDid, payload): Promise<boolean>
Parameters
| Name | Type |
|---|---|
remoteAgentDid | string |
payload | Perspective |
Returns
Promise<boolean>
Defined in
neighbourhood/NeighbourhoodProxy.ts:35 (opens in a new tab)
sendSignalU
▸ sendSignalU(remoteAgentDid, payload): Promise<boolean>
Parameters
| Name | Type |
|---|---|
remoteAgentDid | string |
payload | PerspectiveUnsignedInput |
Returns
Promise<boolean>
Defined in
neighbourhood/NeighbourhoodProxy.ts:39 (opens in a new tab)
setOnlineStatus
▸ setOnlineStatus(status): Promise<boolean>
Parameters
| Name | Type |
|---|---|
status | Perspective |
Returns
Promise<boolean>
Defined in
neighbourhood/NeighbourhoodProxy.ts:27 (opens in a new tab)
setOnlineStatusU
▸ setOnlineStatusU(status): Promise<boolean>
Parameters
| Name | Type |
|---|---|
status | PerspectiveUnsignedInput |
Returns
Promise<boolean>