@polymeshassociation/polymesh-sdk / api/entities/CheckpointSchedule

Defined in: api/entities/CheckpointSchedule/index.ts:34

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

• Entity<UniqueIdentifiers, HumanReadable>

asset: FungibleAsset

Defined in: api/entities/CheckpointSchedule/index.ts:53

Asset for which Checkpoints are scheduled

expiryDate: Date

Defined in: api/entities/CheckpointSchedule/index.ts:63

date at which the last Checkpoint will be created with this Schedule.

id: BigNumber

Defined in: api/entities/CheckpointSchedule/index.ts:48

schedule identifier number

pendingPoints: Date[]

Defined in: api/entities/CheckpointSchedule/index.ts:58

dates in the future where checkpoints are schedule to be created

uuid: string

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

Entity.uuid

details(): Promise<ScheduleDetails>

Defined in: api/entities/CheckpointSchedule/index.ts:85

Retrieve information specific to this Schedule

Promise<ScheduleDetails>

exists(): Promise<boolean>

Defined in: api/entities/CheckpointSchedule/index.ts:165

Determine whether this Checkpoint Schedule exists on chain

Promise<boolean>

Entity.exists

getCheckpoints(): Promise<Checkpoint[]>

Defined in: api/entities/CheckpointSchedule/index.ts:132

Retrieve all Checkpoints created by this Schedule

Promise<Checkpoint[]>

isEqual(entity): boolean

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

Determine whether this Entity is the same as another one

Parameter	Type
entity	Entity<unknown, unknown>

boolean

Entity.isEqual

toHuman(): HumanReadable

Defined in: api/entities/CheckpointSchedule/index.ts:190

Return the Schedule's static data

HumanReadable

Entity.toHuman

static generateUuid<Identifiers>(identifiers): string

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

Generate the Entity's UUID from its identifying properties

Type Parameter
Identifiers

Parameter	Type	Description
identifiers	Identifiers	-

string

Entity.generateUuid

static unserialize<Identifiers>(serialized): Identifiers

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

Unserialize a UUID into its Unique Identifiers

Type Parameter
Identifiers

Parameter	Type	Description
serialized	string	UUID to unserialize

Identifiers

Entity.unserialize

Defined in: api/entities/CheckpointSchedule/index.ts:18

assetId: string

Defined in: api/entities/CheckpointSchedule/index.ts:20

expiryDate: string | null

Defined in: api/entities/CheckpointSchedule/index.ts:22

id: string

Defined in: api/entities/CheckpointSchedule/index.ts:19

pendingPoints: string[]

Defined in: api/entities/CheckpointSchedule/index.ts:21

---

Defined in: api/entities/CheckpointSchedule/index.ts:25

pendingPoints: Date[]

Defined in: api/entities/CheckpointSchedule/index.ts:26

---

Defined in: api/entities/CheckpointSchedule/index.ts:13

assetId: string

Defined in: api/entities/CheckpointSchedule/index.ts:15

id: BigNumber

Defined in: api/entities/CheckpointSchedule/index.ts:14