Documents
Last updated
Was this helpful?
Last updated
Was this helpful?
Namespace that handles all document Related functionality
↳ Documents
Create a new SubModule instance
Parameters:
Name
Type
securityToken
context
Protected contextProtected securityTokenRetrieve an array of all the documents attached to the security token
Retrieve a specific document's data by name
Parameters:
▪ args: object
Name
Type
name
string
Remove an existing document from the Security Token
Parameters:
▪ args: object
Name
Type
Description
name
string
should always be unique
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
+ new Documents(securityToken: , context: ):
Inherited from .
Defined in
Returns:
• context:
Inherited from .
Defined in
• securityToken:
Inherited from .
Defined in
▸ getAllDocuments(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getDocument(args: object): Promise‹›
Defined in
Returns: Promise‹›
▸ remove(args: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››
▸ set(args: object): Promise‹‹, void››
Defined in
Returns: Promise‹‹, void››