Features

Namespace that handles all Feature related functionality

Hierarchy

• SubModule

  ↳ Features

Index

Constructors

• constructor

Properties

• context

• list

• securityToken

Methods

• disable

• enable

• getModuleNameFromFeature

• getStatus

• isEnabled

Constructors

constructor

+ new Features(securityToken: SecurityToken, context: Context): Features

Inherited from SubModule.constructor

Defined in src/entities/SecurityToken/SubModule.ts:10

Create a new SubModule instance

Parameters:

Name	Type
securityToken	SecurityToken
context	Context

Returns: Features

Properties

Protected context

• context: Context

Inherited from SubModule.context

Defined in src/entities/SecurityToken/SubModule.ts:10

list

• list: Feature[] = [ Feature.Permissions, Feature.Tokenholders, Feature.Dividends, Feature.TokenholderCountRestrictions, Feature.PercentageOwnershipRestrictions, ]

Defined in src/entities/SecurityToken/Features.ts:80

List of all existing features

Protected securityToken

• securityToken: SecurityToken

Inherited from SubModule.securityToken

Defined in src/entities/SecurityToken/SubModule.ts:8

Methods

disable

▸ disable(args: object): Promise‹TransactionQueue‹DisableFeatureProcedureArgs››

Defined in src/entities/SecurityToken/Features.ts:213

Disable a feature

Parameters:

▪ args: object

Name	Type
feature	Feature

Returns: Promise‹TransactionQueue‹DisableFeatureProcedureArgs››

enable

▸ enable(args: object, opts?: EnableOpts): Promise‹TransactionQueue›

Defined in src/entities/SecurityToken/Features.ts:138

Enable a feature

Parameters:

▪ args: object

Name	Type
feature	Feature

▪Optional opts: EnableOpts

Returns: Promise‹TransactionQueue›

Private getModuleNameFromFeature

▸ getModuleNameFromFeature(feature: Feature): ModuleName

Defined in src/entities/SecurityToken/Features.ts:240

Parameters:

Name	Type
feature	Feature

Returns: ModuleName

getStatus

▸ getStatus(): Promise‹FeatureStatuses›

Defined in src/entities/SecurityToken/Features.ts:111

Gets the status on all Security Token features (true = enabled, false = not enabled/disabled)

Returns: Promise‹FeatureStatuses›

isEnabled

▸ isEnabled(args: object): Promise‹boolean›

Defined in src/entities/SecurityToken/Features.ts:93

Returns whether a particular feature has been enabled or not

Parameters:

▪ args: object

Name	Type
feature	Feature

Returns: Promise‹boolean›