Polymesh SDK API Reference
v11.0.2
v11.0.2
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TokenPermissions
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • Protected context
  • get
  • Protected parent
  • Protected type
  • Methods
  • addRestriction
  • removeRestrictions
  • setRestrictions

Was this helpful?

  1. Classes

Count

PreviousCorporateActionsNextCustomPermissionGroup

Last updated 3 years ago

Was this helpful?

Handles all Count Transfer Restriction related functionality

Hierarchy

↳ ‹›

↳ Count

Index

Properties

Methods

Properties

Protected context

Inherited from void


get

• get: function

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

Type declaration:


Protected parent

Inherited from void


Protected type

Methods

addRestriction

Add a Count Transfer Restriction to this Security Token

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

Parameters:

Name
Type

args

opts?


removeRestrictions

Removes all Count 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?


setRestrictions

Sets all Count Transfer Restrictions 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

Overrides .

Defined in

▸ (): Promise‹‹››

• parent:

Defined in

• type: = TransferRestrictionType.Count 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››

Context
src/api/entities/Namespace.ts:11
src/api/entities/SecurityToken/TransferRestrictions/Count.ts:61
ActiveTransferRestrictions
CountTransferRestriction
SecurityToken
src/api/entities/Namespace.ts:9
Count
src/api/entities/SecurityToken/TransferRestrictions/Count.ts:16
src/api/entities/SecurityToken/TransferRestrictions/Count.ts:26
ProcedureMethod
TransactionQueue
ProcedureOpts
TransactionQueue
src/api/entities/SecurityToken/TransferRestrictions/Count.ts:50
ProcedureMethod
TransactionQueue
SetCountTransferRestrictionsParams
ProcedureOpts
TransactionQueue
src/api/entities/SecurityToken/TransferRestrictions/Count.ts:38
ProcedureMethod
TransactionQueue
TransferRestrictionBase
Count
context
get
parent
type
addRestriction
removeRestrictions
setRestrictions
ProcedureOpts
ProcedureOpts
SetCountTransferRestrictionsParams
ProcedureOpts
TransferRestrictionBase
TransferRestrictionBase
ProcedureOpts
TransactionQueue
TransferRestrictionBase
TransferRestrictionBase
TransferRestrictionBase
get
type
addRestriction
removeRestrictions
setRestrictions
AddCountTransferRestrictionParams
AddCountTransferRestrictionParams