Features
Namespace that handles all Feature related functionality
Hierarchy
↳ Features
Index
Constructors
Properties
Methods
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 |
| |
|
Returns: Features
Properties
Protected
context
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
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 |
|
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 |
|
▪Optional
opts: EnableOpts
Returns: Promise‹TransactionQueue›
Private
getModuleNameFromFeature
Private
getModuleNameFromFeature▸ getModuleNameFromFeature(feature
: Feature): ModuleName
Defined in src/entities/SecurityToken/Features.ts:240
Parameters:
Name | Type |
|
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 |
|
Returns: Promise‹boolean›
Last updated