@coasys/ad4m / Exports / AgentClient

Class: AgentClient

Provides access to all functions regarding the local agent, such as generating, locking, unlocking, importing the DID keystore, as well as updating the publicly shared Agent expression.

Table of contents

Constructors

• constructor

Properties

• #agentStatusChangedCallbacks
• #apolloClient
• #appsChangedCallback
• #updatedCallbacks

Methods

• addAgentStatusChangedListener
• addAppChangedListener
• addEntanglementProofs
• addUpdatedListener
• byDID
• deleteEntanglementProofs
• entanglementProofPreFlight
• generate
• generateJwt
• getApps
• getEntanglementProofs
• import
• isLocked
• lock
• me
• mutatePublicPerspective
• permitCapability
• removeApp
• requestCapability
• revokeToken
• signMessage
• status
• subscribeAgentStatusChanged
• subscribeAgentUpdated
• subscribeAppsChanged
• unlock
• updateDirectMessageLanguage
• updatePublicPerspective

Constructors

constructor

• new AgentClient(client, subscribe?)

Parameters

Defined in

agent/AgentClient.ts:93

Properties

#agentStatusChangedCallbacks

• Private #agentStatusChangedCallbacks: AgentStatusChangedCallback[]

Defined in

agent/AgentClient.ts:91

#apolloClient

• Private #apolloClient: ApolloClient<any>

Defined in

agent/AgentClient.ts:88

#appsChangedCallback

• Private #appsChangedCallback: AgentAppsUpdatedCallback[]

Defined in

agent/AgentClient.ts:89

#updatedCallbacks

• Private #updatedCallbacks: AgentUpdatedCallback[]

Defined in

agent/AgentClient.ts:90

Methods

addAgentStatusChangedListener

▸ addAgentStatusChangedListener(listener): void

Parameters

Returns

void

Defined in

agent/AgentClient.ts:399

addAppChangedListener

▸ addAppChangedListener(listener): void

Parameters

Returns

void

Defined in

agent/AgentClient.ts:356

addEntanglementProofs

▸ addEntanglementProofs(proofs): Promise<EntanglementProof[]>

Parameters

Returns

Promise<EntanglementProof[]>

Defined in

agent/AgentClient.ts:290

addUpdatedListener

▸ addUpdatedListener(listener): void

Parameters

Returns

void

Defined in

agent/AgentClient.ts:352

byDID

▸ byDID(did): Promise<Agent>

Parameters

Returns

Promise<Agent>

Defined in

agent/AgentClient.ts:200

deleteEntanglementProofs

▸ deleteEntanglementProofs(proofs): Promise<EntanglementProof[]>

Parameters

Returns

Promise<EntanglementProof[]>

Defined in

agent/AgentClient.ts:306

entanglementProofPreFlight

▸ entanglementProofPreFlight(deviceKey, deviceKeyType): Promise<EntanglementProof>

Parameters

Returns

Promise<EntanglementProof>

Defined in

agent/AgentClient.ts:335

generate

▸ generate(passphrase): Promise<AgentStatus>

Parameters

Returns

Promise<AgentStatus>

Defined in

agent/AgentClient.ts:136

generateJwt

▸ generateJwt(requestId, rand): Promise<string>

Parameters

Returns

Promise<string>

Defined in

agent/AgentClient.ts:450

getApps

▸ getApps(): Promise<Apps[]>

Returns

Promise<Apps[]>

Defined in

agent/AgentClient.ts:464

getEntanglementProofs

▸ getEntanglementProofs(): Promise<string[]>

Returns

Promise<string[]>

Defined in

agent/AgentClient.ts:322

import

▸ import(args): Promise<AgentStatus>

Parameters

Returns

Promise<AgentStatus>

Defined in

agent/AgentClient.ts:152

isLocked

▸ isLocked(): Promise<boolean>

Returns

Promise<boolean>

Defined in

agent/AgentClient.ts:505

lock

▸ lock(passphrase): Promise<AgentStatus>

Parameters

Returns

Promise<AgentStatus>

Defined in

agent/AgentClient.ts:172

me

▸ me(): Promise<Agent>

Returns the Agent expression of the local agent as it is shared publicly via the AgentLanguage.

I.e. this is the users profile.

Returns

Promise<Agent>

Defined in

agent/AgentClient.ts:112

mutatePublicPerspective

▸ mutatePublicPerspective(mutations): Promise<Agent>

Parameters

Returns

Promise<Agent>

Defined in

agent/AgentClient.ts:240

permitCapability

▸ permitCapability(auth): Promise<string>

Parameters

Returns

Promise<string>

Defined in

agent/AgentClient.ts:436

removeApp

▸ removeApp(requestId): Promise<Apps[]>

Parameters

Returns

Promise<Apps[]>

Defined in

agent/AgentClient.ts:477

requestCapability

▸ requestCapability(authInfo): Promise<string>

Parameters

Returns

Promise<string>

Defined in

agent/AgentClient.ts:422

revokeToken

▸ revokeToken(requestId): Promise<Apps[]>

Parameters

Returns

Promise<Apps[]>

Defined in

agent/AgentClient.ts:491

signMessage

▸ signMessage(message): Promise<string>

Parameters

Returns

Promise<string>

Defined in

agent/AgentClient.ts:518

status

▸ status(): Promise<AgentStatus>

Returns

Promise<AgentStatus>

Defined in

agent/AgentClient.ts:123

subscribeAgentStatusChanged

▸ subscribeAgentStatusChanged(): void

Returns

void

Defined in

agent/AgentClient.ts:403

subscribeAgentUpdated

▸ subscribeAgentUpdated(): void

Returns

void

Defined in

agent/AgentClient.ts:360

subscribeAppsChanged

▸ subscribeAppsChanged(): void

Returns

void

Defined in

agent/AgentClient.ts:379

unlock

▸ unlock(passphrase, holochain?): Promise<AgentStatus>

Parameters

Returns

Promise<AgentStatus>

Defined in

agent/AgentClient.ts:186

updateDirectMessageLanguage

▸ updateDirectMessageLanguage(directMessageLanguage): Promise<Agent>

Parameters

Returns

Promise<Agent>

Defined in

agent/AgentClient.ts:271

updatePublicPerspective

▸ updatePublicPerspective(perspective): Promise<Agent>

Parameters

Returns

Promise<Agent>

Defined in

agent/AgentClient.ts:214