Schedules
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Security Token Checkpoint Schedules related functionality
Namespace‹›
↳ Schedules
Protected contextInherited from void
Protected parentInherited from void
Calculate an abstract measure of the complexity of a given Calendar Period
Parameters:
Name
Type
period
Returns: number
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
Parameters:
Name
Type
args
▸ currentComplexity(): Promise‹number›
Returns: Promise‹number›
Retrieve all active Checkpoint Schedules
▸ maxComplexity(): Promise‹number›
Retrieve the maximum allowed Schedule complexity for this Security Token
Returns: Promise‹number›
Remove the supplied Checkpoint Schedule for a given Security Token
note required role:
Security Token Owner
Parameters:
Name
Type
args
• context:
Defined in
• parent:
Defined in
▸ complexityOf(period: ): number
Defined in
▸ create(args: ): Promise‹‹››
Defined in
note this method is of type , which means you can call create.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹››
Defined in
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 )
▸ get(): Promise‹[]›
Defined in
Returns: Promise‹[]›
Defined in
▸ remove(args: ): Promise‹‹void››
Defined in
note this method is of type , which means you can call remove.checkAuthorization on it to see whether the Current Account has the required permissions to run it
Returns: Promise‹‹void››