-
Notifications
You must be signed in to change notification settings - Fork 12
api.entities.CheckpointSchedule.CheckpointSchedule
api/entities/CheckpointSchedule.CheckpointSchedule
Represents a Checkpoint Schedule for an Asset. Schedules can be set up to create Checkpoints at regular intervals
-
Entity<UniqueIdentifiers,HumanReadable>↳
CheckpointSchedule
• asset: FungibleAsset
Asset for which Checkpoints are scheduled
api/entities/CheckpointSchedule/index.ts:53
• expiryDate: Date
date at which the last Checkpoint will be created with this Schedule.
api/entities/CheckpointSchedule/index.ts:63
• id: BigNumber
schedule identifier number
api/entities/CheckpointSchedule/index.ts:48
• pendingPoints: Date[]
dates in the future where checkpoints are schedule to be created
api/entities/CheckpointSchedule/index.ts:58
• uuid: string
▸ details(): Promise<ScheduleDetails>
Retrieve information specific to this Schedule
Promise<ScheduleDetails>
api/entities/CheckpointSchedule/index.ts:85
▸ exists(): Promise<boolean>
Determine whether this Checkpoint Schedule exists on chain
Promise<boolean>
api/entities/CheckpointSchedule/index.ts:156
▸ getCheckpoints(): Promise<Checkpoint[]>
Retrieve all Checkpoints created by this Schedule
Promise<Checkpoint[]>
api/entities/CheckpointSchedule/index.ts:123
▸ isEqual(entity): boolean
Determine whether this Entity is the same as another one
| Name | Type |
|---|---|
entity |
Entity<unknown, unknown> |
boolean
▸ toHuman(): HumanReadable
Return the Schedule's static data
api/entities/CheckpointSchedule/index.ts:181
▸ Static generateUuid<Identifiers>(identifiers): string
Generate the Entity's UUID from its identifying properties
| Name |
|---|
Identifiers |
| Name | Type |
|---|---|
identifiers |
Identifiers |
string
▸ Static unserialize<Identifiers>(serialized): Identifiers
Unserialize a UUID into its Unique Identifiers
| Name |
|---|
Identifiers |
| Name | Type | Description |
|---|---|---|
serialized |
string |
UUID to unserialize |
Identifiers
Entities
- Account
- Asset
- Authorization Request
- Checkpoint
- Checkpoint Schedule
- Corporate Action
- Corporate Action Base
- Corporate Ballot
- Custom Permission Group
- Default Portfolio
- Default Trusted Claim Issuer
- Dividend Distribution
- Entity
- Identity
- Instruction
- Known Permission Group
- Metadata Entry
- Multi Sig Proposal
- Numbered Portfolio
- Offering
- Permission Group
- Portfolio
- Subsidies
- Subsidy
- Ticker Reservation
- Venue
- Authorizations
- Types