Class AgentData

Implements

Hierarchy

AgentData

Implements

AgentDataModel

Index

Constructors

constructor

new AgentData(data: AgentDataModel, options?: AgentDataOptions): AgentData
Parameters
- data: AgentDataModel
- Optional options: AgentDataOptions
Returns AgentData
- Defined in node_modules/@web3-storage/access/dist/src/agent-data.d.ts:22

Properties

`Private` #private

#private: any

currentSpace

currentSpace: undefined | `did:${string}:${string}`

delegations

delegations: Map<string, {
delegation: Delegation<Capabilities>;
meta: DelegationMeta;
}>

principal

principal: Signer<`did:${string}:${string}`, SigAlg>

spaces

spaces: Map<`did:${string}:${string}`, SpaceMeta>

Methods

addDelegation

addDelegation(delegation: Delegation<Capabilities>, meta?: DelegationMeta): Promise<void>
Parameters
- delegation: Delegation<Capabilities>
- Optional meta: DelegationMeta
Returns Promise<void>
- Defined in node_modules/@web3-storage/access/dist/src/agent-data.d.ts:49

addSpace

addSpace(did: `did:${string}:${string}`, meta: SpaceMeta, proof?: Delegation<Capabilities>): Promise<void>
Parameters
- did: `did:${string}:${string}`
- meta: SpaceMeta
- Optional proof: Delegation<Capabilities>
Returns Promise<void>
- Defined in node_modules/@web3-storage/access/dist/src/agent-data.d.ts:40

export

export(): AgentDataExport
Export data in a format safe to pass to structuredClone().

Returns AgentDataExport
- Defined in node_modules/@web3-storage/access/dist/src/agent-data.d.ts:34

removeDelegation

removeDelegation(cid: Link<Capabilities, MulticodecCode<number, string>, SigAlg>): Promise<void>
Parameters
- cid: Link<Capabilities, MulticodecCode<number, string>, SigAlg>
Returns Promise<void>
- Defined in node_modules/@web3-storage/access/dist/src/agent-data.d.ts:53

setCurrentSpace

setCurrentSpace(did: `did:${string}:${string}`): Promise<void>
Parameters
- did: `did:${string}:${string}`
Returns Promise<void>
- Defined in node_modules/@web3-storage/access/dist/src/agent-data.d.ts:44

`Static` create

create(init?: Partial<AgentDataModel>, options?: AgentDataOptions): Promise<AgentData>
Create a new AgentData instance from the passed initialization data.
Parameters
- Optional init: Partial<AgentDataModel>
- Optional options: AgentDataOptions
Returns Promise<AgentData>
- Defined in node_modules/@web3-storage/access/dist/src/agent-data.d.ts:10

`Static` fromExport

fromExport(raw: AgentDataExport, options?: AgentDataOptions): AgentData
Instantiate AgentData from previously exported data.
Parameters
- raw: AgentDataExport
- Optional options: AgentDataOptions
Returns AgentData
- Defined in node_modules/@web3-storage/access/dist/src/agent-data.d.ts:17

Class AgentData

Implements

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

data: AgentDataModel

Optional options: AgentDataOptions

Returns AgentData

Properties

Private #private

currentSpace

delegations

meta

principal

spaces

Methods

addDelegation

Parameters

delegation: Delegation<Capabilities>

Optional meta: DelegationMeta

Returns Promise<void>

addSpace

Parameters

did: `did:${string}:${string}`

meta: SpaceMeta

Optional proof: Delegation<Capabilities>

Returns Promise<void>

export

Returns AgentDataExport

removeDelegation

Parameters

cid: Link<Capabilities, MulticodecCode<number, string>, SigAlg>

Returns Promise<void>

setCurrentSpace

Parameters

did: `did:${string}:${string}`

Returns Promise<void>

Static create

Parameters

Optional init: Partial<AgentDataModel>

Optional options: AgentDataOptions

Returns Promise<AgentData>

Static fromExport

Parameters

raw: AgentDataExport

Optional options: AgentDataOptions

Returns AgentData

Settings

Member Visibility

Theme

`Optional` options: AgentDataOptions

`Private` #private

`Optional` meta: DelegationMeta

`Optional` proof: Delegation<Capabilities>

`Static` create

`Optional` init: Partial<AgentDataModel>

`Optional` options: AgentDataOptions

`Static` fromExport

`Optional` options: AgentDataOptions