api_entities_Asset_Checkpoints_Schedules.Schedules
@polymeshassociation/polymesh-sdk / Modules / api/entities/Asset/Checkpoints/Schedules / Schedules
Class: Schedules
api/entities/Asset/Checkpoints/Schedules.Schedules
Handles all Asset Checkpoint Schedules related functionality
Hierarchy
Namespace<Asset>↳
Schedules
Table of contents
Methods
Methods
complexityOf
▸ complexityOf(period): BigNumber
Calculate an abstract measure of the complexity of a given Calendar Period
Parameters
period
Returns
BigNumber
Defined in
api/entities/Asset/Checkpoints/Schedules.ts:127
create
▸ create(args, opts?): Promise<TransactionQueue<CheckpointSchedule, CheckpointSchedule, unknown[][]>>
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
note this method is of type ProcedureMethod, which means you can call create.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Parameters
Returns
Promise<TransactionQueue<CheckpointSchedule, CheckpointSchedule, unknown[][]>>
Defined in
api/entities/Asset/Checkpoints/Schedules.ts:57
currentComplexity
▸ currentComplexity(): Promise<BigNumber>
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 maxComplexity)
Returns
Promise<BigNumber>
Defined in
api/entities/Asset/Checkpoints/Schedules.ts:135
get
▸ get(): Promise<ScheduleWithDetails[]>
Retrieve all active Checkpoint Schedules
Returns
Promise<ScheduleWithDetails[]>
Defined in
api/entities/Asset/Checkpoints/Schedules.ts:94
getOne
▸ getOne(__namedParameters): Promise<ScheduleWithDetails>
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
__namedParameters.id
BigNumber
Returns
Promise<ScheduleWithDetails>
Defined in
api/entities/Asset/Checkpoints/Schedules.ts:76
maxComplexity
▸ maxComplexity(): Promise<BigNumber>
Retrieve the maximum allowed Schedule complexity for this Asset
Returns
Promise<BigNumber>
Defined in
api/entities/Asset/Checkpoints/Schedules.ts:144
remove
▸ remove(args, opts?): Promise<TransactionQueue<void, void, unknown[][]>>
Remove the supplied Checkpoint Schedule for a given Asset
note this method is of type ProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it
Parameters
Returns
Promise<TransactionQueue<void, void, unknown[][]>>
Defined in
Last updated
Was this helpful?