Class UploadClient

Client for interacting with the upload/* capabilities.

Hierarchy

Base
- UploadClient

Index

Constructors

constructor

Methods

_invocationConfig add list remove

Constructors

constructor

new UploadClient(agentData: AgentData, options??: {
serviceConf: undefined | ServiceConf;
}): UploadClient
Parameters
- agentData: AgentData
- Optional options: {
  serviceConf: undefined | ServiceConf;
  } = {}
  - serviceConf: undefined | ServiceConf
Returns UploadClient
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

add

add(root: UnknownLink, shards: CARLink[], options??: RequestOptions): Promise<UploadAddResponse>
Register an "upload" to the resource.
Parameters
- root: UnknownLink
  
  Root data CID for the DAG that was stored.
- shards: CARLink[]
  
  CIDs of CAR files that contain the DAG.
- Optional options: RequestOptions = {}
Returns Promise<UploadAddResponse>
- Defined in src/capability/upload.js:16

list

list(options??: ListRequestOptions): Promise<ListResponse<UploadListResult>>
List uploads registered to the resource.
Parameters
- Optional options: ListRequestOptions = {}
Returns Promise<ListResponse<UploadListResult>>
- Defined in src/capability/upload.js:27

remove

remove(root: UnknownLink, options??: RequestOptions): Promise<undefined | UploadRemoveResponse & {
error?: undefined;
}>
Remove an upload by root data CID.
Parameters
- root: UnknownLink
  
  Root data CID to remove.
- Optional options: RequestOptions = {}
Returns Promise<undefined | UploadRemoveResponse & {
error?: undefined;
}>
- Defined in src/capability/upload.js:39

Class UploadClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

agentData: AgentData

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

serviceConf: undefined | ServiceConf

Returns UploadClient

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}`;
}>

add

Parameters

root: UnknownLink

shards: CARLink[]

`Optional` options: RequestOptions = {}

Returns Promise<UploadAddResponse>

list

Parameters

`Optional` options: ListRequestOptions = {}

Returns Promise<ListResponse<UploadListResult>>

remove

Parameters

root: UnknownLink

`Optional` options: RequestOptions = {}

Returns Promise<undefined | UploadRemoveResponse & {
error?: undefined;
}>

Settings

Member Visibility

Theme

Class UploadClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

agentData: AgentData

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

serviceConf: undefined | ServiceConf

Returns UploadClient

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}`; }>

add

Parameters

root: UnknownLink

shards: CARLink[]

Optional options: RequestOptions = {}

Returns Promise<UploadAddResponse>

list

Parameters

Optional options: ListRequestOptions = {}

Returns Promise<ListResponse<UploadListResult>>

remove

Parameters

root: UnknownLink

Optional options: RequestOptions = {}

Returns Promise<undefined | UploadRemoveResponse & { error?: undefined; }>

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}`;
}>

`Optional` options: RequestOptions = {}

`Optional` options: ListRequestOptions = {}

`Optional` options: RequestOptions = {}

Returns Promise<undefined | UploadRemoveResponse & {
error?: undefined;
}>