AssignSecurityTokenRole
Procedure that assigns a Security Token Role to a delegate address. Roles grant said delegate permissions over certain Security Token Features
Type parameters
▪ ReturnType
Hierarchy
Procedure‹AssignSecurityTokenRoleProcedureArgs›
↳ AssignSecurityTokenRole
Index
Constructors
constructor
Properties
args
context
type
Methods
addProcedure
addSignatureRequest
addTransaction
prepare
prepareTransactions
Constructors
constructor
+ new AssignSecurityTokenRole(args: AssignSecurityTokenRoleProcedureArgs, context: Context): AssignSecurityTokenRole
Inherited from void
Parameters:
Name
Type
args
context
Returns: AssignSecurityTokenRole
Properties
Protected args
Protected args• args: AssignSecurityTokenRoleProcedureArgs
Inherited from void
Protected context
Protected context• context: Context
Inherited from void
type
• type: ProcedureType = ProcedureType.AssignSecurityTokenRole
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
If the delegate does not exist, the delegate address will be added
The specified Role will be assigned/revoked to/from the delegate
Note this procedure will fail if:
You attempt to assign a Role related to a Feature that hasn't been enabled
The Permissions Feature hasn't been enabled on the Security Token
You attempt to assign/revoke a Role that has already been assigned/revoked
Returns: Promise‹void›
Last updated
Was this helpful?