Polymesh SDK API Reference
v14.1.0
alphabetav10.0.0v2.0.0v3.0.0v4.0.0v5.0.0v6.0.0v7.0.0v8.0.0v9.0.0v11.0.2v12.0.2v13.0.0v14.1.0
v14.1.0
alphabetav10.0.0v2.0.0v3.0.0v4.0.0v5.0.0v6.0.0v7.0.0v8.0.0v9.0.0v11.0.2v12.0.2v13.0.0v14.1.0
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Properties
  • addRestriction
  • Protected context
  • get
  • Protected parent
  • removeRestrictions
  • setRestrictions
  • Protected type

Was this helpful?

  1. Classes

Percentage

Handles all Percentage Transfer Restriction related functionality

Hierarchy

  • TransferRestrictionBase‹Percentage›

    ↳ Percentage

Index

Properties

  • addRestriction

  • context

  • get

  • parent

  • removeRestrictions

  • setRestrictions

  • type

Properties

addRestriction

• addRestriction: ProcedureMethod‹Omit‹AddPercentageTransferRestrictionParams, "type"›, BigNumber›

Overrides TransferRestrictionBase.addRestriction

Defined in src/api/entities/Asset/TransferRestrictions/Percentage.ts:27

Add a Percentage Transfer Restriction to this Asset

note the result is the total amount of restrictions after the procedure has run

Protected context

• context: Context

Inherited from void

Defined in src/api/entities/Namespace.ts:11

get

• get: function

Overrides TransferRestrictionBase.get

Defined in src/api/entities/Asset/TransferRestrictions/Percentage.ts:56

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

Type declaration:

▸ (): Promise‹ActiveTransferRestrictions‹PercentageTransferRestriction››

Protected parent

• parent: Asset

Inherited from void

Defined in src/api/entities/Namespace.ts:9

removeRestrictions

• removeRestrictions: NoArgsProcedureMethod‹BigNumber›

Overrides TransferRestrictionBase.removeRestrictions

Defined in src/api/entities/Asset/TransferRestrictions/Percentage.ts:47

Removes all Percentage Transfer Restrictions from this Asset

note the result is the total amount of restrictions after the procedure has run

setRestrictions

• setRestrictions: ProcedureMethod‹Omit‹SetPercentageTransferRestrictionsParams, "type"›, BigNumber›

Overrides TransferRestrictionBase.setRestrictions

Defined in src/api/entities/Asset/TransferRestrictions/Percentage.ts:37

Sets all Percentage Transfer Restrictions on this Asset

note the result is the total amount of restrictions after the procedure has run

Protected type

• type: Percentage = TransferRestrictionType.Percentage as const

Overrides TransferRestrictionBase.type

Defined in src/api/entities/Asset/TransferRestrictions/Percentage.ts:20

PreviousOfferingsNextPermissionGroup

Last updated 2 years ago

Was this helpful?