Class LocalAgent

Hierarchy

Agent
- LocalAgent

Implements

ILocalAgent

Constructors

`Protected` constructor

new LocalAgent(agentId): LocalAgent
Parameters
- agentId: string
Returns LocalAgent
Overrides Agent.constructor
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:47

Properties

`Private` _agentEnvironment

_agentEnvironment: IAgentEnvironment

`Private` _appSyncStatus

_appSyncStatus: AppSyncStatus = AppSyncStatus.INITIALIZING

`Private` _connectionHandler

_connectionHandler: ((state) => void)

Type declaration

- (state): void
- Parameters
  - state: AgentConnectionStatus
  Returns void

`Private` _iotStatus

_iotStatus: IotStatus = IotStatus.INITIALIZING

`Private` _messaging

_messaging: Messaging

`Private` _serviceCredentials

_serviceCredentials: AgentCredentials

Accessors

agentEnvironment

get agentEnvironment(): IAgentEnvironment
Returns IAgentEnvironment
Implementation of ILocalAgent.agentEnvironment
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:238

iceServers

get iceServers(): RTCIceServer[]
Returns RTCIceServer[]
Implementation of ILocalAgent.iceServers
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:51

id

get id(): string
Returns string
Implementation of ILocalAgent.id

Inherited from Agent.id
- Defined in packages/platform-sdk/src/agent/Agent.ts:5

serviceCredentials

get serviceCredentials(): AgentCredentials
Returns AgentCredentials
Implementation of ILocalAgent.serviceCredentials
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:39
set serviceCredentials(value): void
Parameters
- value: AgentCredentials
Returns void
Implementation of ILocalAgent.serviceCredentials
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:43

Methods

connect

connect(): void
Returns void
Implementation of ILocalAgent.connect
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:162

disconnect

disconnect(): void
Returns void
Implementation of ILocalAgent.disconnect
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:167

getContributions

getContributions(type, agentId?): Promise<Contribution[]>
Parameters
- type: string
- Optional agentId: string
Returns Promise<Contribution[]>
Implementation of ILocalAgent.getContributions
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:248

getFromStorage

getFromStorage(key, agent?): Promise<string>
Parameters
- key: string
- Optional agent: IAgent
Returns Promise<string>
Implementation of ILocalAgent.getFromStorage
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:214

getKeysFromStorage

getKeysFromStorage(agent?): Promise<StoredKey[]>
Parameters
- Optional agent: IAgent
Returns Promise<StoredKey[]>
Implementation of ILocalAgent.getKeysFromStorage
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:218

getRemoteAgents

getRemoteAgents(): Promise<string[]>
Returns Promise<string[]>
Implementation of ILocalAgent.getRemoteAgents
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:206

getTypesFromContributions

getTypesFromContributions(agentId?): Promise<Set<ContributionType>>
Parameters
- Optional agentId: string
Returns Promise<Set<ContributionType>>
Implementation of ILocalAgent.getTypesFromContributions
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:251

`Protected` handleAppSyncStatusChange

handleAppSyncStatusChange(status): void
Parameters
- status: AppSyncStatus
Returns void
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:130

`Protected` handleIotStatusChange

handleIotStatusChange(status): void
Parameters
- status: IotStatus
Returns void
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:136

`Protected` initialize

initialize(agentToken): Promise<void>
Parameters
- agentToken: AgentToken
Returns Promise<void>
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:55

makeContribution

makeContribution(contribution, agentId?): Promise<Contribution>
Parameters
- contribution: Contribution
- Optional agentId: string
Returns Promise<Contribution>
Implementation of ILocalAgent.makeContribution
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:245

`Private` notifyConnectionStatusChange

notifyConnectionStatusChange(): void
Returns void
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:142

onConnection

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

removeAllFromContributions

removeAllFromContributions(agent?): Promise<Set<ContributionType>>
Parameters
- Optional agent: IAgent
Returns Promise<Set<ContributionType>>
Implementation of ILocalAgent.removeAllFromContributions
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:257

removeAllFromStorage

removeAllFromStorage(agent?): Promise<StoredKey[]>
Parameters
- Optional agent: IAgent
Returns Promise<StoredKey[]>
Implementation of ILocalAgent.removeAllFromStorage
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:226

removeContribution

removeContribution(contribution): Promise<ContributionType>
Parameters
- contribution: Contribution
Returns Promise<ContributionType>
Implementation of ILocalAgent.removeContribution
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:254

removeFromStorage

removeFromStorage(key, agent?): Promise<StoredKeyValue>
Parameters
- key: string
- Optional agent: IAgent
Returns Promise<StoredKeyValue>
Implementation of ILocalAgent.removeFromStorage
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:222

sendMessage

sendMessage(type, message, remoteAgent?): void
Parameters
- type: string
- message: string
- Optional remoteAgent: RemoteAgent
Returns void
Implementation of ILocalAgent.sendMessage
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:174

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
Implementation of ILocalAgent.subscribeToContributions
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:260

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
Implementation of ILocalAgent.subscribeToMessages
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:178

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
Implementation of ILocalAgent.subscribeToPresence
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:192

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
Implementation of ILocalAgent.subscribeToStorage
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:230

unsubscribeFromContributions

unsubscribeFromContributions(type, agent?): void
Parameters
- type: string
- Optional agent: IAgent
Returns void
Implementation of ILocalAgent.unsubscribeFromContributions
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:242

unsubscribeFromMessages

unsubscribeFromMessages(handler, type?): void
Parameters
- handler: ((data) => void)
  - - (data): void
    - Parameters
      
      data: MessageEvent
      
      Returns void
- Optional type: MessageTypes
Returns void
Implementation of ILocalAgent.unsubscribeFromMessages
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:188

unsubscribeFromPresence

unsubscribeFromPresence(type?): void
Parameters
- Optional type: PresenceTypes
Returns void
Implementation of ILocalAgent.unsubscribeFromPresence
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:202

unsubscribeFromStorage

unsubscribeFromStorage(key, agent?): void
Parameters
- key: string
- Optional agent: IAgent
Returns void
Implementation of ILocalAgent.unsubscribeFromStorage
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:234

writeToStorage

writeToStorage(key, value, agent?): Promise<StoredKeyValue>
Parameters
- key: string
- value: string
- Optional agent: IAgent
Returns Promise<StoredKeyValue>
Implementation of ILocalAgent.writeToStorage
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:210

`Static` create

create(agentToken): Promise<LocalAgent>
Parameters
- agentToken: AgentToken
Returns Promise<LocalAgent>
- Defined in packages/platform-sdk/src/agent/LocalAgent.ts:119

Class LocalAgent

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Parameters

agentId: string

Returns LocalAgent

Properties

Private _agentEnvironment

Private _appSyncStatus

Private _connectionHandler

Type declaration

Parameters

state: AgentConnectionStatus

Returns void

Private _iotStatus

Private _messaging

Private _serviceCredentials

Accessors

agentEnvironment

Returns IAgentEnvironment

iceServers

Returns RTCIceServer[]

id

Returns string

serviceCredentials

Returns AgentCredentials

Parameters

value: AgentCredentials

Returns void

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>>

Protected handleAppSyncStatusChange

Parameters

status: AppSyncStatus

Returns void

Protected handleIotStatusChange

Parameters

status: IotStatus

Returns void

Protected initialize

Parameters

agentToken: AgentToken

Returns Promise<void>

makeContribution

Parameters

contribution: Contribution

Optional agentId: string

Returns Promise<Contribution>

Private notifyConnectionStatusChange

Returns void

`Protected` constructor

`Private` _agentEnvironment

`Private` _appSyncStatus

`Private` _connectionHandler

`Private` _iotStatus

`Private` _messaging

`Private` _serviceCredentials

`Optional` agentId: string

`Optional` agent: IAgent

`Optional` agent: IAgent

`Optional` agentId: string

`Protected` handleAppSyncStatusChange

`Protected` handleIotStatusChange

`Protected` initialize

`Optional` agentId: string

`Private` notifyConnectionStatusChange

`Optional` agent: IAgent

`Optional` agent: IAgent

`Optional` agent: IAgent

`Optional` remoteAgent: RemoteAgent

`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)