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:11

Protected parent

• parent: SecurityToken

Inherited from void

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

Methods

get

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

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

Retrieve all documents linked to the Security Token

note supports pagination

Parameters:

Name	Type
paginationOpts?	PaginationOptions

Returns: Promise‹ResultSet‹TokenDocument››

set

▸ set(args: SetTokenDocumentsParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹SecurityToken››

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

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

note required role:

• Security Token Owner

note this method is of type ProcedureMethod, which means you can call set.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	SetTokenDocumentsParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹SecurityToken››