TransferRestrictionBase

Base class for managing Transfer Restrictions

Type parameters

▪ T: TransferRestrictionType

Hierarchy

• Namespace‹SecurityToken›

  ↳ TransferRestrictionBase

  ↳ Count

  ↳ Percentage

Index

Properties

• context

• exemptedScopeIds

• parent

• type

Methods

• addRestriction

• get

• removeRestrictions

• setRestrictions

Properties

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:1053

array of Scope IDs that are exempted from the Restriction

Protected parent

• parent: SecurityToken

Inherited from void

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

Protected Abstract type

• type: T

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

Methods

addRestriction

▸ addRestriction(args: AddRestrictionParams‹T›, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››

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

Add a Transfer Restriction of the corresponding type to 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 addRestriction.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	AddRestrictionParams‹T›
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹number››

get

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

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

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››

removeRestrictions

▸ removeRestrictions(args: void, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››

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

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 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
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹number››

setRestrictions

▸ setRestrictions(args: SetRestrictionsParams‹T›, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››

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

Sets all Transfer Restrictions of the corresponding type on 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 setRestrictions.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Name	Type
args	SetRestrictionsParams‹T›
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹number››