Schedules

Handles all Security Token Checkpoint Schedules related functionality

Hierarchy

• Namespace‹SecurityToken›

  ↳ Schedules

Index

Properties

• context

• parent

Methods

• complexityOf

• create

• currentComplexity

• get

• getOne

• maxComplexity

• remove

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

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

Parameters:

Name	Type
period	CalendarPeriod

Returns: number

create

▸ create(args: CreateCheckpointScheduleParams, opts?: ProcedureOpts): Promise‹TransactionQueue‹CheckpointSchedule››

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

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

Name	Type
args	CreateCheckpointScheduleParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹CheckpointSchedule››

currentComplexity

▸ currentComplexity(): Promise‹number›

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

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

Retrieve all active Checkpoint Schedules

Returns: Promise‹ScheduleWithDetails[]›

getOne

▸ getOne(__namedParameters: object): Promise‹ScheduleWithDetails›

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

Retrieve a single Checkpoint Schedule associated to this Security Token by its ID

throws if there is no Schedule with the passed ID

Parameters:

▪ __namedParameters: object

Name	Type
id	BigNumber‹›

Returns: Promise‹ScheduleWithDetails›

maxComplexity

▸ maxComplexity(): Promise‹number›

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

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

Remove the supplied Checkpoint Schedule for a given Security Token

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:

Name	Type
args	RemoveCheckpointScheduleParams
opts?	ProcedureOpts

Returns: Promise‹TransactionQueue‹void››