Percentage
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Percentage Transfer Restriction related functionality
↳ ‹›
↳ Percentage
Protected contextInherited from void
• get: function
Retrieve all active Percentage Transfer Restrictions
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
Protected parentInherited from void
Protected typeAdd a Percentage Transfer Restriction to this Security Token
note the result is the total amount of restrictions after the procedure has run
note required role:
Security Token Owner
Parameters:
Name
Type
args
opts?
Removes all Percentage Transfer Restrictions 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 Percentage Transfer Restrictions on this Security Token
note the result is the total amount of restrictions after the procedure has run
note required role:
Security Token Owner
Parameters:
Name
Type
args
opts?
• context:
Defined in
Overrides .
Defined in
▸ (): Promise‹‹››
• parent:
Defined in
• type: = TransferRestrictionType.Percentage as const
Overrides .
Defined in
▸ addRestriction(args: Omit‹, "type"›, opts?: ): Promise‹‹number››
Overrides .
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
Omit‹, "type"›
Returns: Promise‹‹number››
▸ removeRestrictions(args: void, opts?: ): Promise‹‹number››
Overrides .
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: Omit‹, "type"›, opts?: ): Promise‹‹number››
Overrides .
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
Omit‹, "type"›
Returns: Promise‹‹number››