Documents

Handles all Security Token Document related functionality

Hierarchy

• Namespace‹SecurityToken›

  ↳ Documents

Index

Properties

• context

• parent

Methods

• get

• set

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‹ResultSet‹TokenDocument››

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

Retrieve all documents linked to the Security Token

note supports pagination

Parameters:

Name	Type
paginationOpts?	PaginationOptions

Returns: Promise‹ResultSet‹TokenDocument››

set

▸ set(args: SetTokenDocumentsParams): Promise‹TransactionQueue‹SecurityToken››

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:

Name	Type
args	SetTokenDocumentsParams

Returns: Promise‹TransactionQueue‹SecurityToken››