api_entities_CheckpointSchedule.CheckpointSchedule
Last updated
Was this helpful?
Last updated
Was this helpful?
/ / / CheckpointSchedule
.CheckpointSchedule
Represents a Checkpoint Schedule for an Asset. Schedules can be set up to create Checkpoints at regular intervals
<, HumanReadable>
↳ CheckpointSchedule
Asset for which Checkpoints are scheduled
Defined in
• complexity: BigNumber
abstract measure of the complexity of this Schedule. Shorter periods translate into more complexity
Defined in
• 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
• id: BigNumber
schedule identifier number
Defined in
how often this Schedule creates a Checkpoint. A null value means this Schedule creates a single Checkpoint and then expires
Defined in
• start: Date
first Checkpoint creation date
Defined in
• uuid: string
Inherited from
Defined in
Retrieve information specific to this Schedule
Returns
Defined in
â–¸ exists(): Promise<boolean>
Determine whether this Checkpoint Schedule exists on chain
Returns
Promise<boolean>
Overrides
Defined in
Retrieve all Checkpoints created by this Schedule
Returns
Defined in
â–¸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
Parameters
entity
Returns
boolean
Inherited from
Defined in
â–¸ toHuman(): HumanReadable
Return the Schedule's static data
Returns
HumanReadable
Overrides
Defined in
â–¸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
Type parameters
Identifiers
Parameters
identifiers
Identifiers
Returns
string
Inherited from
Defined in
â–¸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
Type parameters
Identifiers
Parameters
serialized
string
UUID to unserialize
Returns
Identifiers
Inherited from
Defined in
• asset:
• period: null |
.
â–¸ details(): Promise<>
Promise<>
.
â–¸ getCheckpoints(): Promise<[]>
Promise<[]>
<unknown, unknown>
.
.
.
.