Interface ILocalAgent

Hierarchy

Implemented by

LocalAgent

Properties

`Readonly` agentEnvironment

agentEnvironment: IAgentEnvironment

iceServers

iceServers: RTCIceServer[]

id

id: string

serviceCredentials

serviceCredentials: AgentCredentials

Methods

connect

connect(): void
Returns void
Inherited from IMessaging.connect
- Defined in packages/platform-sdk/src/agent/IMessaging.ts:4

disconnect

disconnect(): void
Returns void
Inherited from IMessaging.disconnect
- Defined in packages/platform-sdk/src/agent/IMessaging.ts:14

getContributions

getContributions(type, agentId?): Promise<Contribution[]>
Parameters
- type: string
- Optional agentId: string
Returns Promise<Contribution[]>
Inherited from IContributions.getContributions
- Defined in packages/platform-sdk/src/agent/IContributions.ts:16

getFromStorage

getFromStorage(key, agent?): Promise<string>
Parameters
- key: string
- Optional agent: IAgent
Returns Promise<string>
Inherited from IStorage.getFromStorage
- Defined in packages/platform-sdk/src/agent/IStorage.ts:18

getKeysFromStorage

getKeysFromStorage(agent?): Promise<StoredKey[]>
Parameters
- Optional agent: IAgent
Returns Promise<StoredKey[]>
Inherited from IStorage.getKeysFromStorage
- Defined in packages/platform-sdk/src/agent/IStorage.ts:19

getRemoteAgents

getRemoteAgents(): Promise<string[]>
Returns Promise<string[]>
Inherited from IPresence.getRemoteAgents
- Defined in packages/platform-sdk/src/agent/IPresence.ts:12

getTypesFromContributions

getTypesFromContributions(agentId?): Promise<Set<ContributionType>>
Parameters
- Optional agentId: string
Returns Promise<Set<ContributionType>>
Inherited from IContributions.getTypesFromContributions
- Defined in packages/platform-sdk/src/agent/IContributions.ts:17

makeContribution

makeContribution(contribution, agentId?): Promise<Contribution>
Parameters
- contribution: Contribution
- Optional agentId: string
Returns Promise<Contribution>
Inherited from IContributions.makeContribution
- Defined in packages/platform-sdk/src/agent/IContributions.ts:15

onConnection

onConnection(connectionHandler): any
Parameters
- connectionHandler: ((state) => void)
  - - (state): void
    - Parameters
      
      state: AgentConnectionStatus
      
      Returns void
Returns any
- Defined in packages/platform-sdk/src/agent/ILocalAgent.ts:9

removeAllFromContributions

removeAllFromContributions(agent?): Promise<Set<ContributionType>>
Parameters
- Optional agent: IAgent
Returns Promise<Set<ContributionType>>
Inherited from IContributions.removeAllFromContributions
- Defined in packages/platform-sdk/src/agent/IContributions.ts:19

removeAllFromStorage

removeAllFromStorage(agent?): Promise<StoredKey[]>
Parameters
- Optional agent: IAgent
Returns Promise<StoredKey[]>
Inherited from IStorage.removeAllFromStorage
- Defined in packages/platform-sdk/src/agent/IStorage.ts:21

removeContribution

removeContribution(contribution): Promise<Contribution>
Parameters
- contribution: Contribution
Returns Promise<Contribution>
Inherited from IContributions.removeContribution
- Defined in packages/platform-sdk/src/agent/IContributions.ts:18

removeFromStorage

removeFromStorage(key, agent?): Promise<StoredKeyValue>
Parameters
- key: string
- Optional agent: IAgent
Returns Promise<StoredKeyValue>
Inherited from IStorage.removeFromStorage
- Defined in packages/platform-sdk/src/agent/IStorage.ts:20

sendMessage

sendMessage(type, message, remoteAgent?): void
Parameters
- type: string
- message: string
- Optional remoteAgent: IAgent
Returns void
Inherited from IMessaging.sendMessage
- Defined in packages/platform-sdk/src/agent/IMessaging.ts:5

subscribeToContributions

subscribeToContributions(type, handler?, agentId?): void
Parameters
- type: string
- Optional handler: ((data) => void)
  - - (data): void
    - Parameters
      
      data: ContributionsEvent
      
      Returns void
- Optional agentId: string
Returns void
Inherited from IContributions.subscribeToContributions
- Defined in packages/platform-sdk/src/agent/IContributions.ts:20

subscribeToMessages

subscribeToMessages(type?, handlers?): void
Parameters
- Optional type: MessageTypes
- Optional handlers: {
  broadcastMessage?: ((data) => void);
  privateMessage?: ((data) => void);
  }
  - Optional broadcastMessage?: ((data) => void)
    - (data): void
      
      Parameters
      
      data: MessageEvent
      
      Returns void
  - Optional privateMessage?: ((data) => void)
    - (data): void
      
      Parameters
      
      data: MessageEvent
      
      Returns void
Returns void
Inherited from IMessaging.subscribeToMessages
- Defined in packages/platform-sdk/src/agent/IMessaging.ts:6

subscribeToPresence

subscribeToPresence(type?, handlers?): void
Parameters
- Optional type: PresenceTypes
- Optional handlers: {
  arrivals?: ((data) => void);
  departures?: ((data) => void);
  }
  - Optional arrivals?: ((data) => void)
    - (data): void
      
      Parameters
      
      data: PresenceEvent
      
      Returns void
  - Optional departures?: ((data) => void)
    - (data): void
      
      Parameters
      
      data: PresenceEvent
      
      Returns void
Returns void
Inherited from IPresence.subscribeToPresence
- Defined in packages/platform-sdk/src/agent/IPresence.ts:4

subscribeToStorage

subscribeToStorage(key, agent?, handler?): void
Parameters
- key: string
- Optional agent: IAgent
- Optional handler: ((data) => void)
  - - (data): void
    - Parameters
      
      data: StorageEvent
      
      Returns void
Returns void
Inherited from IStorage.subscribeToStorage
- Defined in packages/platform-sdk/src/agent/IStorage.ts:22

unsubscribeFromContributions

unsubscribeFromContributions(type, agent?): void
Parameters
- type: string
- Optional agent: IAgent
Returns void
Inherited from IContributions.unsubscribeFromContributions
- Defined in packages/platform-sdk/src/agent/IContributions.ts:21

unsubscribeFromMessages

unsubscribeFromMessages(handler, type?): void
Parameters
- handler: ((data) => void)
  - - (data): void
    - Parameters
      
      data: MessageEvent
      
      Returns void
- Optional type: MessageTypes
Returns void
Inherited from IMessaging.unsubscribeFromMessages
- Defined in packages/platform-sdk/src/agent/IMessaging.ts:13

unsubscribeFromPresence

unsubscribeFromPresence(type?): void
Parameters
- Optional type: PresenceTypes
Returns void
Inherited from IPresence.unsubscribeFromPresence
- Defined in packages/platform-sdk/src/agent/IPresence.ts:11

unsubscribeFromStorage

unsubscribeFromStorage(key, agent?): void
Parameters
- key: string
- Optional agent: IAgent
Returns void
Inherited from IStorage.unsubscribeFromStorage
- Defined in packages/platform-sdk/src/agent/IStorage.ts:23

writeToStorage

writeToStorage(key, value, agent?): Promise<StoredKeyValue>
Parameters
- key: string
- value: string
- Optional agent: IAgent
Returns Promise<StoredKeyValue>
Inherited from IStorage.writeToStorage
- Defined in packages/platform-sdk/src/agent/IStorage.ts:17

Interface ILocalAgent

Hierarchy

Implemented by

Index

Properties

Methods

Properties

Readonly agentEnvironment

iceServers

id

serviceCredentials

Methods

connect

Returns void

disconnect

Returns void

getContributions

Parameters

type: string

Optional agentId: string

Returns Promise<Contribution[]>

getFromStorage

Parameters

key: string

Optional agent: IAgent

Returns Promise<string>

getKeysFromStorage

Parameters

Optional agent: IAgent

Returns Promise<StoredKey[]>

getRemoteAgents

Returns Promise<string[]>

getTypesFromContributions

Parameters

Optional agentId: string

Returns Promise<Set<ContributionType>>

makeContribution

Parameters

contribution: Contribution

Optional agentId: string

Returns Promise<Contribution>

onConnection

Parameters

connectionHandler: ((state) => void)

Parameters

state: AgentConnectionStatus

Returns void

Returns any

removeAllFromContributions

Parameters

Optional agent: IAgent

Returns Promise<Set<ContributionType>>

removeAllFromStorage

Parameters

Optional agent: IAgent

Returns Promise<StoredKey[]>

removeContribution

Parameters

contribution: Contribution

Returns Promise<Contribution>

removeFromStorage

Parameters

key: string

Optional agent: IAgent

Returns Promise<StoredKeyValue>

sendMessage

Parameters

type: string

message: string

Optional remoteAgent: IAgent

Returns void

subscribeToContributions

Parameters

type: string

Optional handler: ((data) => void)

Parameters

data: ContributionsEvent

Returns void

Optional agentId: string

Returns void

`Readonly` agentEnvironment

`Optional` agentId: string

`Optional` agent: IAgent

`Optional` agent: IAgent

`Optional` agentId: string

`Optional` agentId: string

`Optional` agent: IAgent

`Optional` agent: IAgent

`Optional` agent: IAgent

`Optional` remoteAgent: IAgent

`Optional` handler: ((data) => void)

`Optional` agentId: string

`Optional` type: MessageTypes

`Optional` handlers: {
broadcastMessage?: ((data) => void);
privateMessage?: ((data) => void);
}

`Optional` broadcastMessage?: ((data) => void)

`Optional` privateMessage?: ((data) => void)

`Optional` type: PresenceTypes

`Optional` handlers: {
arrivals?: ((data) => void);
departures?: ((data) => void);
}

`Optional` arrivals?: ((data) => void)

`Optional` departures?: ((data) => void)

`Optional` agent: IAgent

`Optional` handler: ((data) => void)

`Optional` agent: IAgent

`Optional` type: MessageTypes

`Optional` type: PresenceTypes

`Optional` agent: IAgent

`Optional` agent: IAgent