TransferRestrictionBase
Base class for managing Transfer Restrictions

Type parameters

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context
Inherited from void

Optional exemptedScopeIds

exemptedScopeIds? : string[]
array of Scope IDs that are exempted from the Restriction

Protected parent

parent: SecurityToken
Inherited from void

Protected Abstract type

type: T

Methods

addRestriction

addRestriction(args: AddRestrictionParams‹T›, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››
Add a Transfer Restriction of the corresponding type to this Security Token
note the result is the total amount of restrictions after the procedure has run
note this method is of type ProcedureMethod, which means you can call addRestriction.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
opts?
Returns: Promise‹TransactionQueue‹number››

get

get(): Promise‹GetReturnType‹T››
Retrieve all active Transfer Restrictions of the corresponding type
note there is a maximum number of restrictions allowed accross all types. The availableSlots property of the result represents how many more restrictions can be added before reaching that limit
Returns: Promise‹GetReturnType‹T››

removeRestrictions

removeRestrictions(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››
Removes all Transfer Restrictions of the corresponding type from this Security Token
note the result is the total amount of restrictions after the procedure has run
note this method is of type ProcedureMethod, which means you can call removeRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
void
opts?
Returns: Promise‹TransactionQueue‹number››

setRestrictions

setRestrictions(args: SetRestrictionsParams‹T›, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››
Sets all Transfer Restrictions of the corresponding type on this Security Token
note the result is the total amount of restrictions after the procedure has run
note this method is of type ProcedureMethod, which means you can call setRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Parameters:
Name
Type
args
opts?
Returns: Promise‹TransactionQueue‹number››
Last modified 26d ago