TransferRestrictionBase
Base class for managing Transfer Restrictions
Type parameters
Hierarchy
Namespace‹SecurityToken›
↳ TransferRestrictionBase
Index
Properties
Methods
Properties
Protected context
Protected context• context: Context
Inherited from void
Defined in src/api/entities/Namespace.ts:11
Optional exemptedScopeIds
Optional exemptedScopeIds• exemptedScopeIds? : string[]
Defined in src/types/index.ts:877
array of Scope IDs that are exempted from the Restriction
Protected parent
Protected parent• parent: SecurityToken
Inherited from void
Defined in src/api/entities/Namespace.ts:9
Protected Abstract type
Protected Abstract type• type: T
Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:55
Methods
addRestriction
▸ addRestriction(args: AddRestrictionParams‹T›): Promise‹TransactionQueue‹number››
Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:125
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 required role:
Security Token Owner
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
Returns: Promise‹TransactionQueue‹number››
get
▸ get(): Promise‹GetReturnType‹T››
Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:166
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): Promise‹TransactionQueue‹number››
Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:155
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 required role:
Security Token Owner
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
Returns: Promise‹TransactionQueue‹number››
setRestrictions
▸ setRestrictions(args: SetRestrictionsParams‹T›): Promise‹TransactionQueue‹number››
Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:140
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 required role:
Security Token Owner
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
Returns: Promise‹TransactionQueue‹number››
Last updated
Was this helpful?