api_entities_Asset_TransferRestrictions_Percentage.Percentage
@polymeshassociation/polymesh-sdk / Modules / api/entities/Asset/TransferRestrictions/Percentage / Percentage
Class: Percentage
api/entities/Asset/TransferRestrictions/Percentage.Percentage
Handles all Percentage Transfer Restriction related functionality
Hierarchy
TransferRestrictionBase
<Percentage
>↳
Percentage
Table of contents
Properties
Properties
addRestriction
• addRestriction: ProcedureMethod
<Omit
<AddPercentageTransferRestrictionParams
, "type"
>, BigNumber
, BigNumber
>
Add a Percentage Transfer Restriction to this Asset
note
the result is the total amount of restrictions after the procedure has run
Overrides
TransferRestrictionBase.addRestriction
Defined in
api/entities/Asset/TransferRestrictions/Percentage.ts:27
get
• get: () => Promise
<ActiveTransferRestrictions
<PercentageTransferRestriction
>>
Type declaration
▸ (): Promise
<ActiveTransferRestrictions
<PercentageTransferRestriction
>>
Retrieve all active Percentage Transfer Restrictions
note
there is a maximum number of restrictions allowed across all types. The availableSlots
property of the result represents how many more restrictions can be added before reaching that limit
Returns
Promise
<ActiveTransferRestrictions
<PercentageTransferRestriction
>>
Overrides
Defined in
api/entities/Asset/TransferRestrictions/Percentage.ts:56
removeRestrictions
• removeRestrictions: NoArgsProcedureMethod
<BigNumber
, BigNumber
>
Removes all Percentage Transfer Restrictions from this Asset
note
the result is the total amount of restrictions after the procedure has run
Overrides
TransferRestrictionBase.removeRestrictions
Defined in
api/entities/Asset/TransferRestrictions/Percentage.ts:47
setRestrictions
• setRestrictions: ProcedureMethod
<Omit
<SetPercentageTransferRestrictionsParams
, "type"
>, BigNumber
, BigNumber
>
Sets all Percentage Transfer Restrictions on this Asset
note
the result is the total amount of restrictions after the procedure has run
Overrides
TransferRestrictionBase.setRestrictions
Defined in
Last updated