CheckpointSchedule

Represents a Schedule in which Checkpoints are created for a specific Security Token. Schedules can be set up to create checkpoints

Hierarchy

• Entity‹UniqueIdentifiers, HumanReadable›

  ↳ CheckpointSchedule

Index

Properties

• complexity

• context

• expiryDate

• id

• period

• start

• ticker

• uuid

Methods

• details

• exists

• getCheckpoints

• isEqual

• toJson

• generateUuid

• unserialize

Properties

complexity

• complexity: number

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

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

Protected context

• context: Context

Inherited from Entity.context

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

expiryDate

• expiryDate: Date | null

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

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:56

schedule identifier number

period

• period: CalendarPeriod | null

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

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:72

first Checkpoint creation date

ticker

• ticker: string

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

ticker of the Security Token for which Checkpoints are scheduled

uuid

• uuid: string

Inherited from Entity.uuid

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

Methods

details

▸ details(): Promise‹ScheduleDetails›

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

Retrieve information specific to this Schedule

Returns: Promise‹ScheduleDetails›

exists

▸ exists(): Promise‹boolean›

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

Retrieve whether the Checkpoint Schedule still exists on chain

Returns: Promise‹boolean›

getCheckpoints

▸ getCheckpoints(): Promise‹Checkpoint[]›

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

Retrieve all Checkpoints created by this Schedule

Returns: Promise‹Checkpoint[]›

isEqual

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

Inherited from Entity.isEqual

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

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:207

Return the Schedule's ID and Token ticker

Returns: HumanReadable

Static generateUuid

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

Inherited from Entity.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 Entity.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