api.entities.Asset.Base.Documents.Documents

Class: Documents

api/entities/Asset/Base/Documents.Documents

Handles all Asset Document related functionality

Hierarchy

• Namespace<BaseAsset>

  ↳ Documents

Table of contents

Methods

• get
• set

Methods

get

▸ get(paginationOpts?): Promise<ResultSet<AssetDocument>>

Retrieve all documents linked to the Asset

Parameters

Name	Type
paginationOpts?	PaginationOptions

Returns

Promise<ResultSet<AssetDocument>>

Note

supports pagination

Defined in

api/entities/Asset/Base/Documents/index.ts:47

---

set

▸ set(args, opts?): Promise<GenericPolymeshTransaction<void, void>>

Assign a new list of documents to the Asset by replacing the existing list of documents with the ones passed in the parameters

Parameters

Name	Type
args	SetAssetDocumentsParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

this method is of type ProcedureMethod, which means you can call set.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Defined in

api/entities/Asset/Base/Documents/index.ts:38