Schedules
Last updated
Was this helpful?
Last updated
Was this helpful?
Handles all Asset Checkpoint Schedules related functionality
Namespace‹›
↳ Schedules
Protected
context• context: Context
Inherited from void
Protected
parentInherited from void
Calculate an abstract measure of the complexity of a given Calendar Period
Parameters:
period
Returns: BigNumber
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 Asset is redeemed, issued or transferred between portfolios. This means that on an Asset 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
Parameters:
args
opts?
▸ currentComplexity(): Promise‹BigNumber›
Returns: Promise‹BigNumber›
Retrieve all active Checkpoint Schedules
Retrieve a single Checkpoint Schedule associated to this Asset by its ID
throws
if there is no Schedule with the passed ID
Parameters:
▪ __namedParameters: object
id
BigNumber‹›
▸ maxComplexity(): Promise‹BigNumber›
Retrieve the maximum allowed Schedule complexity for this Asset
Returns: Promise‹BigNumber›
Remove the supplied Checkpoint Schedule for a given Asset
Parameters:
args
opts?
Defined in
• parent:
Defined in
▸ complexityOf(period
: ): BigNumber
Defined in
▸ create(args
: , opts?
: ): Promise‹‹››
Defined in
note
this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Returns: Promise‹‹››
Defined in
Calculate the sum of the complexity of all current Checkpoint Schedules for this Asset. The number cannot exceed the Asset's maximum complexity (obtained via )
▸ get(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ getOne(__namedParameters
: object): Promise‹›
Defined in
Returns: Promise‹›
Defined in
▸ remove(args
: , opts?
: ): Promise‹‹void››
Defined in
note
this method is of type , which means you can call on it to see whether the signing Account and Identity have the required roles and permissions to run it
Returns: Promise‹‹void››