CheckpointSchedule
Last updated
Was this helpful?
Last updated
Was this helpful?
Represents a Schedule in which Checkpoints are created for a specific Security Token. Schedules can be set up to create checkpoints
‹UniqueIdentifiers, ›
↳ CheckpointSchedule
• complexity: number
abstract measure of the complexity of this Schedule. Shorter periods translate into more complexity
Protected context• expiryDate: Date | null
date at which the last Checkpoint will be created with this Schedule. A null value means that this Schedule never expires
• id: BigNumber
schedule identifier number
how often this Schedule creates a Checkpoint. A null value means this Schedule creates a single Checkpoint and then expires
• start: Date
first Checkpoint creation date
• ticker: string
ticker of the Security Token for which Checkpoints are scheduled
• uuid: string
Retrieve information specific to this Schedule
▸ exists(): Promise‹boolean›
Retrieve whether the Checkpoint Schedule still exists on chain
Returns: Promise‹boolean›
Retrieve all Checkpoints created by this Schedule
Whether this Entity is the same as another one
Parameters:
Name
Type
entity
Returns: boolean
Return the Schedule's ID and Token ticker
Static generateUuid▸ generateUuid‹Identifiers›(identifiers: Identifiers): string
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
Unserialize a UUID into its Unique Identifiers
Type parameters:
â–ª Identifiers
Parameters:
Name
Type
Description
serialized
string
UUID to unserialize
Returns: Identifiers
Defined in
• context:
Inherited from .
Defined in
Defined in
Defined in
• period: | null
Defined in
Defined in
Defined in
Inherited from .
Defined in
▸ details(): Promise‹›
Defined in
Returns: Promise‹›
Defined in
▸ getCheckpoints(): Promise‹[]›
Defined in
Returns: Promise‹[]›
▸ isEqual(entity: ‹unknown, unknown›): boolean
Inherited from .
Defined in
‹unknown, unknown›
â–¸ toJson():
Overrides .
Defined in
Returns:
Inherited from .
Defined in
Inherited from .
Defined in