Percentage

Handles all Percentage Transfer Restriction related functionality

Hierarchy

TransferRestrictionBasePercentage

Percentage

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/Percentage.ts:64

Retrieve all active Percentage 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‹ActiveTransferRestrictionsPercentageTransferRestriction››

Protected parent

parent: SecurityToken

Inherited from void

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

Protected type

type: Percentage = TransferRestrictionType.Percentage as const

Overrides TransferRestrictionBase.type

Defined in src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:19

Methods

addRestriction

addRestriction(args: Omit‹AddPercentageTransferRestrictionParams, "type"›, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››

Overrides TransferRestrictionBase.addRestriction

Defined in src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:29

Add a Percentage Transfer Restriction 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:

NameType

args

opts?

Returns: Promise‹TransactionQueue‹number››

removeRestrictions

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

Overrides TransferRestrictionBase.removeRestrictions

Defined in src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:53

Removes all Percentage 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:

NameType

args

void

opts?

Returns: Promise‹TransactionQueue‹number››

setRestrictions

setRestrictions(args: Omit‹SetPercentageTransferRestrictionsParams, "type"›, opts?: ProcedureOpts): Promise‹TransactionQueue‹number››

Overrides TransferRestrictionBase.setRestrictions

Defined in src/api/entities/SecurityToken/TransferRestrictions/Percentage.ts:41

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

NameType

args

opts?

Returns: Promise‹TransactionQueue‹number››

Last updated