Documents

Handles all Security Token Document related functionality

Hierarchy

• Namespace‹SecurityToken›

  ↳ Documents

Index

Properties

• context

• parent

• set

Methods

• get

Properties

Protected context

• context: Context

Inherited from void

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

Protected parent

• parent: SecurityToken

Inherited from void

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

set

• set: ProcedureMethod‹SetTokenDocumentsParams, SecurityToken›

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

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

param new list of documents

note required role:

• Security Token Owner

Methods

get

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

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

Retrieve all documents linked to the Security Token

note supports pagination

Parameters:

Name	Type
paginationOpts?	PaginationOptions

Returns: Promise‹ResultSet‹TokenDocument››