api_entities_CheckpointSchedule.CheckpointSchedule

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

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

Table of contents

Properties

Methods

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>

Defined in

api/entities/CheckpointSchedule/index.ts:123


exists

exists(): Promise<boolean>

Determine whether this Checkpoint Schedule exists on chain

Returns

Promise<boolean>

Overrides

Entity.exists

Defined in

api/entities/CheckpointSchedule/index.ts:189


getCheckpoints

getCheckpoints(): Promise<Checkpoint[]>

Retrieve all Checkpoints created by this Schedule

Returns

Promise<Checkpoint[]>

Defined in

api/entities/CheckpointSchedule/index.ts:157


isEqual

isEqual(entity): boolean

Determine whether this Entity is the same as another one

Parameters

NameType

entity

Entity<unknown, unknown>

Returns

boolean

Inherited from

Entity.isEqual

Defined in

api/entities/Entity.ts:61


toHuman

toHuman(): HumanReadable

Return the Schedule's static data

Returns

HumanReadable

Overrides

Entity.toHuman

Defined in

api/entities/CheckpointSchedule/index.ts:211


generateUuid

Static generateUuid<Identifiers>(identifiers): string

Generate the Entity's UUID from its identifying properties

Type parameters

Name

Identifiers

Parameters

NameType

identifiers

Identifiers

Returns

string

Inherited from

Entity.generateUuid

Defined in

api/entities/Entity.ts:14


unserialize

Static unserialize<Identifiers>(serialized): Identifiers

Unserialize a UUID into its Unique Identifiers

Type parameters

Name

Identifiers

Parameters

NameTypeDescription

serialized

string

UUID to unserialize

Returns

Identifiers

Inherited from

Entity.unserialize

Defined in

api/entities/Entity.ts:23

Last updated