Count

Handles all Count Transfer Restriction related functionality

Hierarchy

  • TransferRestrictionBase‹Count›

    ↳ Count

Index

Properties

Methods

Properties

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/SecurityToken/TransferRestrictions/Count.ts:66

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:

▸ (): Promise‹ActiveTransferRestrictions‹CountTransferRestriction››

Protected parent

• parent: SecurityToken

Inherited from void

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

Protected type

• type: Count = TransferRestrictionType.Count as const

Overrides TransferRestrictionBase.type

Defined in src/api/entities/SecurityToken/TransferRestrictions/Count.ts:15

Methods

addRestriction

▸ addRestriction(args: Omit‹AddCountTransferRestrictionParams, "type"›): Promise‹TransactionQueue‹number››

Overrides TransferRestrictionBase.addRestriction

Defined in src/api/entities/SecurityToken/TransferRestrictions/Count.ts:28

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

note this method is of type ProcedureMethod, which means you can call addRestriction.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

Omit‹AddCountTransferRestrictionParams, "type"›

Returns: Promise‹TransactionQueue‹number››

removeRestrictions

▸ removeRestrictions(args: void): Promise‹TransactionQueue‹number››

Overrides TransferRestrictionBase.removeRestrictions

Defined in src/api/entities/SecurityToken/TransferRestrictions/Count.ts:55

Removes all Count Transfer Restrictions from this Security Token

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

note this method is of type ProcedureMethod, which means you can call removeRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

void

Returns: Promise‹TransactionQueue‹number››

setRestrictions

▸ setRestrictions(args: Omit‹SetCountTransferRestrictionsParams, "type"›): Promise‹TransactionQueue‹number››

Overrides TransferRestrictionBase.setRestrictions

Defined in src/api/entities/SecurityToken/TransferRestrictions/Count.ts:43

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

note this method is of type ProcedureMethod, which means you can call setRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name

Type

args

Omit‹SetCountTransferRestrictionsParams, "type"›

Returns: Promise‹TransactionQueue‹number››

PreviousCorporateActionsNextCurrentAccount

Last updated