TransferRestrictionBase
Last updated
Was this helpful?
Last updated
Was this helpful?
Base class for managing Transfer Restrictions
▪ T:
Namespace‹›
↳ TransferRestrictionBase
↳
↳
Protected contextInherited from void
Optional exemptedScopeIds• exemptedScopeIds? : string[]
array of Scope IDs that are exempted from the Restriction
Protected parentInherited from void
Protected Abstract type• type: T
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
Parameters:
Name
Type
args
opts?
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
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
Parameters:
Name
Type
args
void
opts?
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
Parameters:
Name
Type
args
opts?
• context:
Defined in
Defined in
• parent:
Defined in
Defined in
▸ addRestriction(args: ‹T›, opts?: ): Promise‹‹number››
Defined in
note this method is of type , which means you can call addRestriction.checkAuthorization on it to see whether the Current Account has the required permissions to run it
‹T›
Returns: Promise‹‹number››
▸ get(): Promise‹‹T››
Defined in
Returns: Promise‹‹T››
▸ removeRestrictions(args: void, opts?: ): Promise‹‹number››
Defined in
note this method is of type , which means you can call removeRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹number››
▸ setRestrictions(args: ‹T›, opts?: ): Promise‹‹number››
Defined in
note this method is of type , which means you can call setRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it
‹T›
Returns: Promise‹‹number››