Schedules

Handles all Security Token Checkpoint Schedules related functionality

Hierarchy

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from void

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

Protected parent

parent: SecurityToken

Inherited from void

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

Methods

complexityOf

complexityOf(period: CalendarPeriod): number

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:111

Calculate an abstract measure of the complexity of a given Calendar Period

Parameters:

Name

Type

period

Returns: number

create

create(args: CreateCheckpointScheduleParams, opts?: ProcedureOpts): Promise‹TransactionQueueCheckpointSchedule››

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:58

Create a schedule for Checkpoint creation (i.e. "Create a checkpoint every week for 5 weeks, starting next tuesday")

note due to chain limitations, schedules are advanced and (if appropriate) executed whenever the Security Token is redeemed, issued or transferred between portfolios. This means that on a Security Token without much movement, there may be disparities between intended Checkpoint creation dates and the actual date when they are created. This, however, has no effect on the Checkpoint's accuracy regarding to balances

note required role:

  • Security Token Owner

note this method is of type ProcedureMethod, which means you can call create.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Returns: Promise‹TransactionQueueCheckpointSchedule››

currentComplexity

currentComplexity(): Promise‹number›

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:119

Calculate the sum of the complexity of all current Checkpoint Schedules for this Security Token. The number cannot exceed the Token's maximum complexity (obtained via maxComplexity)

Returns: Promise‹number›

get

get(): Promise‹ScheduleWithDetails[]›

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:78

Retrieve all active Checkpoint Schedules

Returns: Promise‹ScheduleWithDetails[]›

maxComplexity

maxComplexity(): Promise‹number›

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:128

Retrieve the maximum allowed Schedule complexity for this Security Token

Returns: Promise‹number›

remove

remove(args: RemoveCheckpointScheduleParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹void››

Defined in src/api/entities/SecurityToken/Checkpoints/Schedules.ts:71

Remove the supplied Checkpoint Schedule for a given Security Token

note required role:

  • Security Token Owner

note this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the Current Account has the required permissions to run it

Parameters:

Returns: Promise‹TransactionQueue‹void››

Last updated