Polymesh SDK API Reference
v6.0.0
v6.0.0
  • Introduction
  • Globals
  • Classes
    • Account
    • AuthorizationRequest
    • Authorizations
    • Checkpoint
    • CheckpointSchedule
    • Checkpoints
    • Claims
    • Compliance
    • Context
    • CorporateAction
    • CorporateActions
    • Count
    • CurrentAccount
    • CurrentIdentity
    • DefaultPortfolio
    • DefaultTrustedClaimIssuer
    • Distributions
    • DividendDistribution
    • Documents
    • Entity
    • Identity
    • IdentityAuthorizations
    • Instruction
    • Issuance
    • Middleware
    • NumberedPortfolio
    • Offerings
    • Percentage
    • Polymesh
    • PolymeshError
    • PolymeshTransaction
    • PolymeshTransactionBase
    • PolymeshTransactionBatch
    • Portfolio
    • Portfolios
    • Requirements
    • Schedules
    • SecurityToken
    • Settlements
    • Sto
    • TickerReservation
    • TokenHolders
    • TransactionQueue
    • TransferRestrictionBase
    • TransferRestrictions
    • TrustedClaimIssuers
    • Venue
  • Enums
    • AffirmationStatus
    • AuthorizationType
    • CalendarUnit
    • ClaimType
    • ConditionTarget
    • ConditionType
    • CorporateActionKind
    • CountryCode
    • ErrorCode
    • InstructionStatus
    • InstructionType
    • KnownTokenType
    • ProposalStage
    • RoleType
    • ScopeType
    • StoBalanceStatus
    • StoSaleStatus
    • StoTimingStatus
    • TargetTreatment
    • TickerReservationStatus
    • TokenIdentifierType
    • TransactionArgumentType
    • TransactionQueueStatus
    • TransactionStatus
    • TransferError
    • TransferRestrictionType
    • TransferStatus
    • TxGroup
    • VenueType
  • Interfaces
    • AccountData
    • ActiveTransferRestrictions
    • AddBatchTransactionOpts
    • AddClaimsParams
    • AddInstructionParams
    • AddInstructionsParams
    • AddInvestorUniquenessClaimParams
    • AddTransactionOpts
    • AddTransactionOptsBase
    • ArrayTransactionArgument
    • Balance
    • CalendarPeriod
    • CddProviderRole
    • CheckpointWithData
    • ClaimClassicTickerParams
    • ClaimData
    • ClaimScope
    • ClaimTarget
    • ComplexTransactionArgument
    • ConditionCompliance
    • ConnectParamsBase
    • ConstructorParams
    • ConsumeParams
    • ControllerTransferParams
    • CorporateActionDefaults
    • CorporateActionTargets
    • CountTransferRestriction
    • CountTransferRestrictionInput
    • CreateCheckpointScheduleParams
    • CreateSecurityTokenParams
    • CreateVenueParams
    • DeletePortfolioParams
    • DistributionParticipant
    • DistributionPayment
    • DistributionWithDetails
    • DividendDistributionDetails
    • DividendDistributionParams
    • EditClaimsParams
    • EventIdentifier
    • ExtrinsicData
    • Fees
    • HistoricSettlement
    • IdentityBalance
    • IdentityWithClaims
    • InstructionAffirmation
    • InvestInStoParams
    • Investment
    • InviteAccountParams
    • IssueTokensParams
    • KeyringPair
    • LeaveIdentityParams
    • Leg
    • LinkCaDocsParams
    • MiddlewareConfig
    • ModifyCorporateActionsAgentParams
    • ModifyInstructionAffirmationParams
    • ModifyPrimaryIssuanceAgentParams
    • ModifySignerPermissionsParams
    • ModifyTokenTrustedClaimIssuersAddSetParams
    • ModifyTokenTrustedClaimIssuersRemoveParams
    • MoveFundsParams
    • NetworkProperties
    • PaginationOptions
    • PayDividendsParams
    • PercentageTransferRestriction
    • PercentageTransferRestrictionInput
    • Permissions
    • PermissionsLike
    • PlainTransactionArgument
    • PortfolioBalance
    • PortfolioCustodianRole
    • PortfolioMovement
    • ProcedureAuthorizationStatus
    • ProcedureMethod
    • ProposalDetails
    • ProposalTimeFrames
    • ProposalVote
    • RedeemTokenParams
    • RegisterIdentityParams
    • RemoveCheckpointScheduleParams
    • RemoveCorporateActionParams
    • RemoveSecondaryKeysParams
    • RenamePortfolioParams
    • Requirement
    • RequirementCompliance
    • ReserveTickerParams
    • ResultSet
    • RevokeClaimsParams
    • ScheduleDetails
    • ScheduleWithDetails
    • Scope
    • SecondaryKey
    • SecurityTokenDetails
    • SetAssetRequirementsParams
    • SetCountTransferRestrictionsParams
    • SetCustodianParams
    • SetPercentageTransferRestrictionsParams
    • SetTokenDocumentsParams
    • SettlementLeg
    • SimpleEnumTransactionArgument
    • StoDetails
    • StoStatus
    • StoTier
    • StoWithDetails
    • TaxWithholding
    • TickerOwnerRole
    • TickerReservationDetails
    • Tier
    • ToggleFreezeSecondaryKeysParams
    • ToggleFreezeStoParams
    • ToggleFreezeTransfersParams
    • TogglePauseRequirementsParams
    • TokenCaaRole
    • TokenDocument
    • TokenIdentifier
    • TokenOwnerRole
    • TokenPiaRole
    • TransferBreakdown
    • TransferPolyxParams
    • TransferRestriction
    • TransferRestrictionInputBase
    • TransferRestrictionResult
    • TransferTickerOwnershipParams
    • TransferTokenOwnershipParams
    • TrustedClaimIssuer
    • UiKeyring
    • UniqueIdentifiers
    • VenueDetails
    • VenueOwnerRole
Powered by GitBook
On this page
  • Hierarchy
  • Index
  • Properties
  • Methods
  • Properties
  • complexity
  • Protected context
  • expiryDate
  • id
  • period
  • start
  • ticker
  • uuid
  • Methods
  • details
  • exists
  • getCheckpoints
  • isEqual
  • Static generateUuid
  • Static unserialize

Was this helpful?

  1. Classes

CheckpointSchedule

PreviousCheckpointNextCheckpoints

Last updated 3 years ago

Was this helpful?

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

Hierarchy

  • ‹›

    ↳ CheckpointSchedule

Index

Properties

Methods

Properties

complexity

• complexity: number

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

Protected 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

ticker

• ticker: string

ticker of the Security Token for which Checkpoints are scheduled

uuid

• uuid: string

Methods

details

Retrieve information specific to this Schedule

exists

▸ exists(): Promise‹boolean›

Retrieve whether the Checkpoint Schedule still exists on chain

Returns: Promise‹boolean›

getCheckpoints

Retrieve all Checkpoints created by this Schedule

isEqual

Whether this Entity is the same as another one

Parameters:

Name

Type

entity

Returns: boolean

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›): boolean

Inherited from .

Defined in

‹unknown›

Inherited from .

Defined in

Inherited from .

Defined in

src/api/entities/CheckpointSchedule/index.ts:74
Context
src/api/entities/Entity.ts:48
src/api/entities/CheckpointSchedule/index.ts:69
src/api/entities/CheckpointSchedule/index.ts:47
CalendarPeriod
src/api/entities/CheckpointSchedule/index.ts:58
src/api/entities/CheckpointSchedule/index.ts:63
src/api/entities/CheckpointSchedule/index.ts:52
src/api/entities/Entity.ts:46
ScheduleDetails
src/api/entities/CheckpointSchedule/index.ts:110
ScheduleDetails
src/api/entities/CheckpointSchedule/index.ts:176
Checkpoint
src/api/entities/CheckpointSchedule/index.ts:144
Checkpoint
Entity
src/api/entities/Entity.ts:61
src/api/entities/Entity.ts:14
src/api/entities/Entity.ts:23
Entity
UniqueIdentifiers
complexity
context
expiryDate
id
period
start
ticker
uuid
details
exists
getCheckpoints
isEqual
generateUuid
unserialize
CheckpointSchedule
context
CheckpointSchedule
uuid
CheckpointSchedule
isEqual
CheckpointSchedule
generateUuid
CheckpointSchedule
unserialize
Entity