# TickerReservation

Represents a reserved token symbol in the Polymesh chain. Ticker reservations expire after a set length of time, after which they can be reserved by another Identity. A Ticker must be previously reserved by an Identity for that Identity to be able create a Security Token with it

## Hierarchy

* [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/entity)‹UniqueIdentifiers›

  ↳ **TickerReservation**

## Index

### Properties

* [context](#protected-context)
* [createToken](#createtoken)
* [extend](#extend)
* [ticker](#ticker)
* [uuid](#uuid)

### Methods

* [details](#details)
* [isEqual](#isequal)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### `Protected` context

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

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*context*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#protected-context)

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

### createToken

• **createToken**: *ProcedureMethod‹*[*CreateSecurityTokenParams*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/createsecuritytokenparams)*,* [*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/securitytoken)*›*

*Defined in* [*src/api/entities/TickerReservation/index.ts:174*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/TickerReservation/index.ts#L174)

Create a Security Token using the reserved ticker

**`note`** the issuer DID will be set as the primary issuance agent

**`param`** amount of tokens that will be minted on creation

**`param`** whether a single token can be divided into decimal parts

**`param`** type of security that the token represents (i.e. Equity, Debt, Commodity, etc)

**`param`** domestic or international alphanumeric security identifiers for the token (ISIN, CUSIP, etc)

**`param`** (optional) funding round in which the token currently is (Series A, Series B, etc)

**`note`** required role:

* Ticker Owner

### extend

• **extend**: *ProcedureMethod‹void,* [*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/tickerreservation)*›*

*Defined in* [*src/api/entities/TickerReservation/index.ts:158*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/TickerReservation/index.ts#L158)

Extend the Reservation time period of the ticker for 60 days from now to later use it in the creation of a Security Token.

**`note`** required role:

* Ticker Owner

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/TickerReservation/index.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/TickerReservation/index.ts#L46)

reserved ticker

### uuid

• **uuid**: *string*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*uuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#uuid)

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

## Methods

### details

▸ **details**(): *Promise‹*[*TickerReservationDetails*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/tickerreservationdetails)*›*

*Defined in* [*src/api/entities/TickerReservation/index.ts:74*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/TickerReservation/index.ts#L74)

Retrieve the Reservation's owner, expiry date and status

**`note`** can be subscribed to

**Returns:** *Promise‹*[*TickerReservationDetails*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/tickerreservationdetails)*›*

▸ **details**(`callback`: [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹[TickerReservationDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/tickerreservationdetails)›): *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#unsubcallback)*›*

*Defined in* [*src/api/entities/TickerReservation/index.ts:75*](https://github.com/PolymathNetwork/polymesh-sdk/blob/524b0225/src/api/entities/TickerReservation/index.ts#L75)

**Parameters:**

| Name       | Type                                                                                                                                                                                                                                              |
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `callback` | [SubCallback](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#subcallback)‹[TickerReservationDetails](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/interfaces/tickerreservationdetails)› |

**Returns:** *Promise‹*[*UnsubCallback*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/globals#unsubcallback)*›*

### isEqual

▸ **isEqual**(`entity`: [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/entity)‹object›): *boolean*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*isEqual*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#isequal)

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

Whether this Entity is the same as another one

**Parameters:**

| Name     | Type                                                                                                    |
| -------- | ------------------------------------------------------------------------------------------------------- |
| `entity` | [Entity](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/entity)‹object› |

**Returns:** *boolean*

### `Static` generateUuid

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

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*generateUuid*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#static-generateuuid)

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

Generate the Entity's UUID from its identifying properties

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

| Name          | Type        | Description |
| ------------- | ----------- | ----------- |
| `identifiers` | Identifiers |             |

**Returns:** *string*

### `Static` unserialize

▸ **unserialize**‹**Identifiers**›(`serialized`: string): *Identifiers*

*Inherited from* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/classes/checkpointschedule)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v5/checkpointschedule#static-unserialize)

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

Unserialize a UUID into its Unique Identifiers

**Type parameters:**

▪ **Identifiers**: *object*

**Parameters:**

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

**Returns:** *Identifiers*