SetDocument
Procedure that adds a document to a Security Token
Type parameters
▪ ReturnType
Hierarchy
Procedure‹SetDocumentProcedureArgs›
↳ SetDocument
Index
Constructors
constructor
Properties
args
context
type
Methods
addProcedure
addSignatureRequest
addTransaction
prepare
prepareTransactions
Constructors
constructor
+ new SetDocument(args: SetDocumentProcedureArgs, context: Context): SetDocument
Inherited from void
Parameters:
Name
Type
args
context
Returns: SetDocument
Properties
Protected args
Protected args• args: SetDocumentProcedureArgs
Inherited from void
Protected context
Protected context• context: Context
Inherited from void
type
• type: ProcedureType = ProcedureType.SetDocument
Overrides void
Methods
addProcedure
▸ addProcedure<A, R>(Proc: ProcedureClass‹A, R›): (Anonymous function)
Inherited from void
Appends a Procedure into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.
Type parameters:
▪ A
▪ R: any
Parameters:
Name
Type
Description
Proc
A Procedure that will be run in the Procedure's TransactionQueue
Returns: (Anonymous function)
whichever value is returned by the Procedure
addSignatureRequest
Inherited from void
Appends a signature request into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.
Type parameters:
▪ A
Parameters:
Name
Type
Description
request
A signature request that will be run in the Procedure's TransactionQueue
Returns: (Anonymous function)
a PostTransactionResolver that resolves to the signed data
addTransaction
Inherited from void
Appends a method or future method into the TransactionQueue's queue. This defines what will be run by the TransactionQueue when it is started.
Type parameters:
▪ A
▪ R: any[]
▪ V: any
Parameters:
A method (or future method) that will be run in the Procedure's TransactionQueue. A future method is a transaction that doesn't exist at prepare time (for example a transaction on a module that hasn't been attached but will be by the time the previous transactions are run)
▪Default value __namedParameters: object= {}
Name
Type
Default
fees
-
resolvers
object
([] as unknown) as ResolverArray
tag
-
Returns: (Anonymous function)
a PostTransactionResolver that resolves to the value returned by the resolver function, or undefined if no resolver function was passed
prepare
▸ prepare(): Promise‹TransactionQueue‹Args, ReturnType››
Inherited from void
Mandatory method that builds a list of transactions that will be run
Returns: Promise‹TransactionQueue‹Args, ReturnType››
prepareTransactions
▸ prepareTransactions(): Promise‹void›
Overrides void
Set a document on the Security Token
Note that this procedure will fail if:
The current wallet is not the Security Token owner
The name of the document is less than 1 or more than 32 characters long
The document hash is less than 1 or more than 32 characters long
Returns: Promise‹void›
Last updated
Was this helpful?