Skip to main content

Class: SpaceClient

capability/space.SpaceClient

Client for interacting with the space/* capabilities.

Hierarchy

Constructors

constructor

new SpaceClient(agentData, options?)

Parameters

NameType
agentDataAgentData
options?Object
options.serviceConfundefined | ServiceConf

Inherited from

Base.constructor

Defined in

src/base.js:22

Properties

_agent

Protected _agent: Agent

Inherited from

Base._agent

Defined in

src/base.js:9


_serviceConf

Protected _serviceConf: ServiceConf

Inherited from

Base._serviceConf

Defined in

src/base.js:15

Methods

_invocationConfig

Protected _invocationConfig(abilities): Promise<{ audience: Principal<`did:${string}:${string}`> ; issuer: Signer<`did:${string}:${string}`, SigAlg> ; proofs: Delegation<Capabilities>[] ; with: `did:${string}:${string}` = resource }>

Parameters

NameType
abilitiesAbility[]

Returns

Promise<{ audience: Principal<`did:${string}:${string}`> ; issuer: Signer<`did:${string}:${string}`, SigAlg> ; proofs: Delegation<Capabilities>[] ; with: `did:${string}:${string}` = resource }>

Inherited from

Base._invocationConfig

Defined in

src/base.js:36


info

info(space): Promise<Selectable<SpaceTable> & { error?: undefined }>

Get information about a space.

Parameters

NameTypeDescription
space`did:${string}:${string}`DID of the space to retrieve info about.

Returns

Promise<Selectable<SpaceTable> & { error?: undefined }>

Defined in

src/capability/space.js:12


recover

recover(email): Promise<Delegation<[{ can: "*" ; nb?: InferCaveats<{}> ; with: URI<"did:"> }]>[]>

Recover the current space.

Parameters

NameTypeDescription
emailstringEmail address to send recovery emaail to.

Returns

Promise<Delegation<[{ can: "*" ; nb?: InferCaveats<{}> ; with: URI<"did:"> }]>[]>

Defined in

src/capability/space.js:22