Class: Documents

Defined in: src/api/entities/Asset/Base/Documents/index.ts:16

Handles all Asset Document related functionality

Extends

• Namespace<BaseAsset>

Methods

get()

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

Defined in: src/api/entities/Asset/Base/Documents/index.ts:39

Retrieve all documents linked to the Asset

Parameters

Parameter	Type
paginationOpts?	PaginationOptions

Returns

Promise<ResultSet<AssetDocument>>

Note

supports pagination

---

set()

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

Defined in: src/api/entities/Asset/Base/Documents/index.ts:32

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

Parameters

Parameter	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