Schedules

Handles all Asset Checkpoint Schedules related functionality

Hierarchy

  • Namespace‹Asset

    Schedules

Index

Properties

Methods

Properties

Protected context

context: Context

Inherited from void

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


Protected parent

parent: Asset

Inherited from void

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

Methods

complexityOf

complexityOf(period: CalendarPeriod): BigNumber

Defined in src/api/entities/Asset/Checkpoints/Schedules.ts:127

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

Parameters:

Returns: BigNumber


create

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

Defined in src/api/entities/Asset/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 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‹TransactionQueueCheckpointSchedule››


currentComplexity

currentComplexity(): Promise‹BigNumber›

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

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›


get

get(): Promise‹ScheduleWithDetails[]›

Defined in src/api/entities/Asset/Checkpoints/Schedules.ts:94

Retrieve all active Checkpoint Schedules

Returns: Promise‹ScheduleWithDetails[]›


getOne

getOne(__namedParameters: object): Promise‹ScheduleWithDetails

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

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

Returns: Promise‹ScheduleWithDetails


maxComplexity

maxComplexity(): Promise‹BigNumber›

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

Retrieve the maximum allowed Schedule complexity for this Asset

Returns: Promise‹BigNumber›


remove

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

Defined in src/api/entities/Asset/Checkpoints/Schedules.ts:67

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

Last updated