Documents

Handles all Security Token Document related functionality

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from void

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

Protected parent

parent: SecurityToken

Inherited from void

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

Methods

get

get(paginationOpts?: PaginationOptions): Promise‹ResultSetTokenDocument››

Defined in src/api/entities/SecurityToken/Documents.ts:38

Retrieve all documents linked to the Security Token

note supports pagination

Parameters:

Name

Type

paginationOpts?

Returns: Promise‹ResultSetTokenDocument››

set

set(args: SetTokenDocumentsParams): Promise‹TransactionQueueSecurityToken››

Defined in src/api/entities/SecurityToken/Documents.ts:25

Assign a new list of documents to the Security Token by replacing the existing list of documents with the one passed in the parameters

This requires two transactions

Parameters:

Returns: Promise‹TransactionQueueSecurityToken››

Last updated