TransferRestrictionBase

Base class for managing Transfer Restrictions

Type parameters

▪ T: TransferRestrictionType

Hierarchy

• Namespace‹SecurityToken›

  ↳ TransferRestrictionBase

  ↳ CountTransferRestriction

  ↳ PercentageTransferRestriction

Index

Properties

• addRestriction

• context

• exemptedScopeIds

• parent

• removeRestrictions

• setRestrictions

• type

Methods

• get

Properties

addRestriction

• addRestriction: ProcedureMethod‹AddRestrictionParams‹T›, number›

Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:123

Add a Transfer Restriction of the corresponding type to this Security Token

param array of Scope IDs that are exempted from the Restriction

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

note required role:

• Security Token Owner

Protected context

• context: Context

Inherited from void

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

Optional exemptedScopeIds

• exemptedScopeIds? : string[]

Defined in src/types/index.ts:858

Protected parent

• parent: SecurityToken

Inherited from void

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

removeRestrictions

• removeRestrictions: ProcedureMethod‹void, number›

Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:145

Removes all Transfer Restrictions of the corresponding type from this Security Token

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

note required role:

• Security Token Owner

setRestrictions

• setRestrictions: ProcedureMethod‹SetRestrictionsParams‹T›, number›

Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:135

Sets all Transfer Restrictions of the corresponding type on this Security Token

param array of Transfer Restrictions with their corresponding exemptions (if applicable)

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

note required role:

• Security Token Owner

Protected Abstract type

• type: T

Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:54

Methods

get

▸ get(): Promise‹GetReturnType‹T››

Defined in src/api/entities/SecurityToken/TransferRestrictions/TransferRestrictionBase.ts:154

Retrieve all active Transfer Restrictions of the corresponding type

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

Returns: Promise‹GetReturnType‹T››