Documents

Namespace that handles all document Related functionality

Hierarchy

• SubModule

  ↳ Documents

Index

Constructors

• constructor

Properties

• context

• securityToken

Methods

• getAllDocuments

• getDocument

• remove

• set

Constructors

constructor

+ new Documents(securityToken: SecurityToken, context: Context): Documents

Inherited from SubModule.constructor

Defined in src/entities/SecurityToken/SubModule.ts:10

Create a new SubModule instance

Parameters:

Name	Type
securityToken	SecurityToken
context	Context

Returns: Documents

Properties

Protected context

• context: Context

Inherited from SubModule.context

Defined in src/entities/SecurityToken/SubModule.ts:10

Protected securityToken

• securityToken: SecurityToken

Inherited from SubModule.securityToken

Defined in src/entities/SecurityToken/SubModule.ts:8

Methods

getAllDocuments

▸ getAllDocuments(): Promise‹Document[]›

Defined in src/entities/SecurityToken/Documents.ts:90

Retrieve an array of all the documents attached to the security token

Returns: Promise‹Document[]›

getDocument

▸ getDocument(args: object): Promise‹Document›

Defined in src/entities/SecurityToken/Documents.ts:61

Retrieve a specific document's data by name

Parameters:

▪ args: object

Name	Type
name	string

Returns: Promise‹Document›

remove

▸ remove(args: object): Promise‹TransactionQueue‹RemoveDocumentProcedureArgs, void››

Defined in src/entities/SecurityToken/Documents.ts:50

Remove an existing document from the Security Token

Parameters:

▪ args: object

Name	Type	Description
name	string	should always be unique

Returns: Promise‹TransactionQueue‹RemoveDocumentProcedureArgs, void››

set

▸ set(args: object): Promise‹TransactionQueue‹SetDocumentProcedureArgs, void››

Defined in src/entities/SecurityToken/Documents.ts:37

Attach a new document to the contract, or update the URI or hash of an existing attached document

Parameters:

▪ args: object

Name	Type	Description
documentHash	string	hash of the document's contents
name	string	should always be unique
uri	string	off-chain uri of the document from where it is accessible to investors/advisors to read

Returns: Promise‹TransactionQueue‹SetDocumentProcedureArgs, void››