CheckpointSchedule

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

Hierarchy

• Entity‹UniqueIdentifiers, HumanReadable›

  ↳ CheckpointSchedule

Index

Properties

• asset

• complexity

• context

• expiryDate

• id

• period

• start

• uuid

Methods

• details

• exists

• getCheckpoints

• isEqual

• toJson

• generateUuid

• unserialize

Properties

asset

• asset: Asset

Defined in src/api/entities/CheckpointSchedule/index.ts:65

Asset for which Checkpoints are scheduled

---

complexity

• complexity: BigNumber

Defined in src/api/entities/CheckpointSchedule/index.ts:87

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

---

Protected context

• context: Context

Inherited from CheckpointSchedule.context

Defined in src/api/entities/Entity.ts:48

---

expiryDate

• expiryDate: Date | null

Defined in src/api/entities/CheckpointSchedule/index.ts:82

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

---

id

• id: BigNumber

Defined in src/api/entities/CheckpointSchedule/index.ts:60

schedule identifier number

---

period

• period: CalendarPeriod | null

Defined in src/api/entities/CheckpointSchedule/index.ts:71

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

---

start

• start: Date

Defined in src/api/entities/CheckpointSchedule/index.ts:76

first Checkpoint creation date

---

uuid

• uuid: string

Inherited from CheckpointSchedule.uuid

Defined in src/api/entities/Entity.ts:46

Methods

details

▸ details(): Promise‹ScheduleDetails›

Defined in src/api/entities/CheckpointSchedule/index.ts:123

Retrieve information specific to this Schedule

Returns: Promise‹ScheduleDetails›

---

exists

▸ exists(): Promise‹boolean›

Overrides Entity.exists

Defined in src/api/entities/CheckpointSchedule/index.ts:189

Determine whether this Checkpoint Schedule exists on chain

Returns: Promise‹boolean›

---

getCheckpoints

▸ getCheckpoints(): Promise‹Checkpoint[]›

Defined in src/api/entities/CheckpointSchedule/index.ts:157

Retrieve all Checkpoints created by this Schedule

Returns: Promise‹Checkpoint[]›

---

isEqual

▸ isEqual(entity: Entity‹unknown, unknown›): boolean

Inherited from CheckpointSchedule.isEqual

Defined in src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters:

Name	Type
entity	Entity‹unknown, unknown›

Returns: boolean

---

toJson

▸ toJson(): HumanReadable

Overrides Entity.toJson

Defined in src/api/entities/CheckpointSchedule/index.ts:211

Return the Schedule's static data

Returns: HumanReadable

---

Static generateUuid

▸ generateUuid‹Identifiers›(identifiers: Identifiers): string

Inherited from CheckpointSchedule.generateUuid

Defined in src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
identifiers	Identifiers

Returns: string

---

Static unserialize

▸ unserialize‹Identifiers›(serialized: string): Identifiers

Inherited from CheckpointSchedule.unserialize

Defined in src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type parameters:

▪ Identifiers

Parameters:

Name	Type	Description
serialized	string	UUID to unserialize

Returns: Identifiers