Class: SpaceClient
capability/space.SpaceClient
Client for interacting with the space/*
capabilities.
Hierarchy
↳
SpaceClient
Constructors
constructor
• new SpaceClient(agentData
, options?
)
Parameters
Name | Type |
---|---|
agentData | AgentData |
options? | Object |
options.serviceConf | undefined | ServiceConf |
Inherited from
Defined in
Properties
_agent
• Protected
_agent: Agent
Inherited from
Defined in
_serviceConf
• Protected
_serviceConf: ServiceConf
Inherited from
Defined in
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
Name | Type |
---|---|
abilities | Ability [] |
Returns
Promise
<{ audience
: Principal
<`did:${string}:${string}`> ; issuer
: Signer
<`did:${string}:${string}`, SigAlg
> ; proofs
: Delegation
<Capabilities
>[] ; with
: `did:${string}:${string}` = resource }>
Inherited from
Defined in
info
▸ info(space
): Promise
<Selectable
<SpaceTable
> & { error?
: undefined
}>
Get information about a space.
Parameters
Name | Type | Description |
---|---|---|
space | `did:${string}:${string}` | DID of the space to retrieve info about. |
Returns
Promise
<Selectable
<SpaceTable
> & { error?
: undefined
}>
Defined in
recover
▸ recover(email
): Promise
<Delegation
<[{ can
: "*"
; nb?
: InferCaveats
<{}> ; with
: URI
<"did:"
> }]>[]>
Recover the current space.
Parameters
Name | Type | Description |
---|---|---|
email | string | Email address to send recovery emaail to. |
Returns
Promise
<Delegation
<[{ can
: "*"
; nb?
: InferCaveats
<{}> ; with
: URI
<"did:"
> }]>[]>