Skip to main content
Version: 21.0.x

Class: CheckpointSchedule

api/entities/CheckpointSchedule.CheckpointSchedule

Represents a Checkpoint Schedule for an Asset. Schedules can be set up to create Checkpoints at regular intervals

Hierarchy

Properties

asset

asset: Asset

Asset for which Checkpoints are scheduled

Defined in

api/entities/CheckpointSchedule/index.ts:65


complexity

complexity: BigNumber

abstract measure of the complexity of this Schedule. Shorter periods translate into more complexity

Defined in

api/entities/CheckpointSchedule/index.ts:87


expiryDate

expiryDate: null | Date

date at which the last Checkpoint will be created with this Schedule. A null value means that this Schedule never expires

Defined in

api/entities/CheckpointSchedule/index.ts:82


id

id: BigNumber

schedule identifier number

Defined in

api/entities/CheckpointSchedule/index.ts:60


period

period: null | CalendarPeriod

how often this Schedule creates a Checkpoint. A null value means this Schedule creates a single Checkpoint and then expires

Defined in

api/entities/CheckpointSchedule/index.ts:71


start

start: Date

first Checkpoint creation date

Defined in

api/entities/CheckpointSchedule/index.ts:76


uuid

uuid: string

Inherited from

Entity.uuid

Defined in

api/entities/Entity.ts:46

Methods

details

details(): Promise<ScheduleDetails>

Retrieve information specific to this Schedule

Returns

Promise<ScheduleDetails>


exists

exists(): Promise<boolean>

Determine whether this Checkpoint Schedule exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists


getCheckpoints

getCheckpoints(): Promise<Checkpoint[]>

Retrieve all Checkpoints created by this Schedule

Returns

Promise<Checkpoint[]>


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

NameType
entityEntity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual


toHuman

toHuman(): HumanReadable

Return the Schedule's static data

Returns

HumanReadable

Overrides

Entity.toHuman


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name
Identifiers

Parameters

NameType
identifiersIdentifiers

Returns

string

Inherited from

Entity.generateUuid


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name
Identifiers

Parameters

NameTypeDescription
serializedstringUUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize