Polymesh SDK API Reference
beta
beta
  • 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

Count

PreviousCorporateActionsNextCustomPermissionGroup

Last updated 2 years ago

Was this helpful?

Handles all Count Transfer Restriction related functionality

Hierarchy

  • TransferRestrictionBase‹›

    ↳ Count

Index

Properties

Properties

addRestriction

Add a Count 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


get

• get: function

Retrieve all active Count 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:


Protected parent

Inherited from void


removeRestrictions

Removes all Count Transfer Restrictions from this Asset

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


setRestrictions

Sets all Count Transfer Restrictions on this Asset

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


Protected type

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

Overrides .

Defined in

Defined in

Overrides .

Defined in

▸ (): Promise‹‹››

• parent:

Defined in

• removeRestrictions: ‹BigNumber›

Overrides .

Defined in

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

Overrides .

Defined in

• type: = TransferRestrictionType.Count as const

Overrides .

Defined in

src/api/entities/Asset/TransferRestrictions/Count.ts:27
src/api/entities/Namespace.ts:11
src/api/entities/Asset/TransferRestrictions/Count.ts:56
ActiveTransferRestrictions
CountTransferRestriction
Asset
src/api/entities/Namespace.ts:9
NoArgsProcedureMethod
src/api/entities/Asset/TransferRestrictions/Count.ts:47
ProcedureMethod
SetCountTransferRestrictionsParams
src/api/entities/Asset/TransferRestrictions/Count.ts:37
Count
src/api/entities/Asset/TransferRestrictions/Count.ts:20
Count
addRestriction
context
get
parent
removeRestrictions
setRestrictions
type
ProcedureMethod
TransferRestrictionBase
TransferRestrictionBase
TransferRestrictionBase
TransferRestrictionBase
TransferRestrictionBase
addRestriction
get
removeRestrictions
setRestrictions
type
AddCountTransferRestrictionParams