# CheckpointSchedule

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

## Hierarchy

* [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)‹UniqueIdentifiers, [HumanReadable](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/humanreadable.md)›

  ↳ **CheckpointSchedule**

## Index

### Properties

* [complexity](#complexity)
* [context](#protected-context)
* [expiryDate](#expirydate)
* [id](#id)
* [period](#period)
* [start](#start)
* [ticker](#ticker)
* [uuid](#uuid)

### Methods

* [details](#details)
* [exists](#exists)
* [getCheckpoints](#getcheckpoints)
* [isEqual](#isequal)
* [toJson](#tojson)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### complexity

• **complexity**: *number*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:83*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/CheckpointSchedule/index.ts#L83)

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

***

### `Protected` context

• **context**: [*Context*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/context)

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/entity#protected-context)

*Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L48)

***

### expiryDate

• **expiryDate**: *Date | null*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:78*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/CheckpointSchedule/index.ts#L78)

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*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/CheckpointSchedule/index.ts#L56)

schedule identifier number

***

### period

• **period**: [*CalendarPeriod*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/calendarperiod.md) *| null*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:67*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/CheckpointSchedule/index.ts#L67)

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*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/CheckpointSchedule/index.ts#L72)

first Checkpoint creation date

***

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/CheckpointSchedule/index.ts#L61)

ticker of the Security Token for which Checkpoints are scheduled

***

### uuid

• **uuid**: *string*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/entity#uuid)

*Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L46)

## Methods

### details

▸ **details**(): *Promise‹*[*ScheduleDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/scheduledetails.md)*›*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:119*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/CheckpointSchedule/index.ts#L119)

Retrieve information specific to this Schedule

**Returns:** *Promise‹*[*ScheduleDetails*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/scheduledetails.md)*›*

***

### exists

▸ **exists**(): *Promise‹boolean›*

*Overrides* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)*.*[*exists*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/entity#abstract-exists)

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:185*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/CheckpointSchedule/index.ts#L185)

Determine whether this Checkpoint Schedule exists on chain

**Returns:** *Promise‹boolean›*

***

### getCheckpoints

▸ **getCheckpoints**(): *Promise‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/checkpoint)*\[]›*

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:153*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/CheckpointSchedule/index.ts#L153)

Retrieve all Checkpoints created by this Schedule

**Returns:** *Promise‹*[*Checkpoint*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/checkpoint)*\[]›*

***

### isEqual

▸ **isEqual**(`entity`: [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)‹unknown, unknown›): *boolean*

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)*.*[*isEqual*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/entity#isequal)

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L61)

Determine whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                                                              |
| -------- | ----------------------------------------------------------------------------------------------------------------- |
| `entity` | [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)‹unknown, unknown› |

**Returns:** *boolean*

***

### toJson

▸ **toJson**(): [*HumanReadable*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/humanreadable.md)

*Overrides* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)*.*[*toJson*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/entity#abstract-tojson)

*Defined in* [*src/api/entities/CheckpointSchedule/index.ts:207*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/CheckpointSchedule/index.ts#L207)

Return the Schedule's ID and Token ticker

**Returns:** [*HumanReadable*](https://github.com/PolymathNetwork/polymesh-sdk/blob/docs/v13/docs/interfaces/humanreadable.md)

***

### `Static` generateUuid

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

*Inherited from* [*Entity*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)*.*[*generateUuid*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/entity#static-generateuuid)

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L14)

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*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/classes/entity)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/v13.0.0/entity#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/108d588b/src/api/entities/Entity.ts#L23)

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**

**Parameters:**

| Name         | Type   | Description         |
| ------------ | ------ | ------------------- |
| `serialized` | string | UUID to unserialize |

**Returns:** *Identifiers*