Polymesh SDK API Reference
beta
beta
  • Globals
  • Classes
    • Account
    • AccountManagement
    • Asset
    • AssetHolders
    • AssetPermissions
    • Assets
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • CorporateAction
    • CorporateActionBase
    • CorporateActions
    • Count
    • CustomPermissionGroup
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identities
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • KnownPermissionGroup
    • Network
    • NumberedPortfolio
    • Offering
    • Offerings
    • Percentage
    • PermissionGroup
    • Permissions
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • Settlements
    • Subsidy
    • TickerReservation
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
  • Interfaces
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • asset
  • complexity
  • Protected context
  • expiryDate
  • id
  • period
  • start
  • uuid
  • Methods
  • details
  • exists
  • getCheckpoints
  • isEqual
  • toHuman
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

CheckpointSchedule

PreviousCheckpointNextCheckpoints

Last updated 2 years ago

Was this helpful?

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

Hierarchy

  • ‹, ›

    ↳ CheckpointSchedule

Index

Properties

Methods

Properties

asset

Asset for which Checkpoints are scheduled


complexity

• complexity: BigNumber

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


Protected context

• context: Context


expiryDate

• 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

• id: BigNumber

schedule identifier number


period

how often this Schedule creates a Checkpoint. A null value means this Schedule creates a single Checkpoint and then expires


start

• start: Date

first Checkpoint creation date


uuid

• uuid: string

Methods

details

Retrieve information specific to this Schedule


exists

▸ exists(): Promise‹boolean›

Determine whether this Checkpoint Schedule exists on chain

Returns: Promise‹boolean›


getCheckpoints

Retrieve all Checkpoints created by this Schedule


isEqual

Determine whether this Entity is the same as another one

Parameters:

Name
Type

entity

Returns: boolean


toHuman

Return the Schedule's static data


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

• asset:

Defined in

Defined in

Inherited from .

Defined in

Defined in

Defined in

• period: | null

Defined in

Defined in

Inherited from .

Defined in

▸ details(): Promise‹›

Defined in

Returns: Promise‹›

Overrides .

Defined in

▸ getCheckpoints(): Promise‹[]›

Defined in

Returns: Promise‹[]›

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

Inherited from .

Defined in

‹unknown, unknown›

▸ toHuman():

Overrides .

Defined in

Returns:

Inherited from .

Defined in

Inherited from .

Defined in

Asset
src/api/entities/CheckpointSchedule/index.ts:65
src/api/entities/CheckpointSchedule/index.ts:87
src/api/entities/Entity.ts:48
src/api/entities/CheckpointSchedule/index.ts:82
src/api/entities/CheckpointSchedule/index.ts:60
CalendarPeriod
src/api/entities/CheckpointSchedule/index.ts:71
src/api/entities/CheckpointSchedule/index.ts:76
src/api/entities/Entity.ts:46
ScheduleDetails
src/api/entities/CheckpointSchedule/index.ts:123
ScheduleDetails
src/api/entities/CheckpointSchedule/index.ts:189
Checkpoint
src/api/entities/CheckpointSchedule/index.ts:157
Checkpoint
Entity
src/api/entities/Entity.ts:61
HumanReadable
src/api/entities/CheckpointSchedule/index.ts:211
HumanReadable
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
UniqueIdentifiers
HumanReadable
asset
complexity
context
expiryDate
id
period
start
uuid
details
exists
getCheckpoints
isEqual
toHuman
generateUuid
unserialize
CheckpointSchedule
context
CheckpointSchedule
uuid
CheckpointSchedule
isEqual
CheckpointSchedule
generateUuid
CheckpointSchedule
unserialize
Entity
Entity
Entity
exists
toHuman