Class SpaceClient

Client for interacting with the space/* capabilities.

Hierarchy

Base
- SpaceClient

Index

Constructors

constructor

new SpaceClient(agentData: AgentData, options??: {
serviceConf: undefined | ServiceConf;
}): SpaceClient
Parameters
- agentData: AgentData
- Optional options: {
  serviceConf: undefined | ServiceConf;
  } = {}
  - serviceConf: undefined | ServiceConf
Returns SpaceClient
Inherited from Base.constructor
- Defined in src/base.js:22

Properties

`Protected` _agent

_agent: Agent

`Protected` _serviceConf

_serviceConf: ServiceConf

Methods

`Protected` _invocationConfig

_invocationConfig(abilities: Ability[]): Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:${string}:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:${string}:${string}`;
}>
Protected
Parameters
- abilities: Ability[]
Returns Promise<{
    audience: Principal<`did:${string}:${string}`>;
    issuer: Signer<`did:${string}:${string}`, SigAlg>;
    proofs: Delegation<Capabilities>[];
    with: `did:${string}:${string}`;
}>
Inherited from Base._invocationConfig
- Defined in src/base.js:36

info

info(space: `did:${string}:${string}`): Promise<Selectable<SpaceTable> & {
error?: undefined;
}>
Get information about a space.
Parameters
- 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: string): Promise<Delegation<[{
    can: "*";
    nb?: InferCaveats<{}>;
    with: URI<"did:">;
}]>[]>
Recover the current space.
Parameters
- email: string
  
  Email address to send recovery emaail to.
Returns Promise<Delegation<[{
    can: "*";
    nb?: InferCaveats<{}>;
    with: URI<"did:">;
}]>[]>
- Defined in src/capability/space.js:22

Class SpaceClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

agentData: AgentData

`Optional` options: {
serviceConf: undefined | ServiceConf;
} = {}

serviceConf: undefined | ServiceConf

Returns SpaceClient

Properties

`Protected` _agent

`Protected` _serviceConf

Methods

`Protected` _invocationConfig

Parameters

abilities: Ability[]

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

info

Parameters

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

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

recover

Parameters

email: string

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

Settings

Member Visibility

Theme

Class SpaceClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

agentData: AgentData

Optional options: { serviceConf: undefined | ServiceConf; } = {}

serviceConf: undefined | ServiceConf

Returns SpaceClient

Properties

Protected _agent

Protected _serviceConf

Methods

Protected _invocationConfig

Parameters

abilities: Ability[]

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

info

Parameters

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

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

recover

Parameters

email: string

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

Settings

Member Visibility

Theme

`Optional` options: {
serviceConf: undefined | ServiceConf;
} = {}

`Protected` _agent

`Protected` _serviceConf

`Protected` _invocationConfig

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

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

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