Documents

Handles all Asset Document related functionality

Hierarchy

• Namespace‹Asset›

  ↳ Documents

Index

Properties

• context

• parent

Methods

• get

• set

Properties

Protected context

• context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

---

Protected parent

• parent: Asset

Inherited from void

Defined in src/api/entities/Namespace.ts:9

Methods

get

▸ get(paginationOpts?: PaginationOptions): Promise‹ResultSet‹AssetDocument››

Defined in src/api/entities/Asset/Documents.ts:43

Retrieve all documents linked to the Asset

note supports pagination

Parameters:

Name	Type
paginationOpts?	PaginationOptions

Returns: Promise‹ResultSet‹AssetDocument››

---

set

▸ set(args: SetAssetDocumentsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹Asset››

Defined in src/api/entities/Asset/Documents.ts:34

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

This requires two transactions

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

Parameters:

Name	Type
args	SetAssetDocumentsParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹Asset››