# 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-v6/classes/entity)‹UniqueIdentifiers›

  ↳ **TickerReservation**

## Index

### Properties

* [context](#protected-context)
* [ticker](#ticker)
* [uuid](#uuid)

### Methods

* [createToken](#createtoken)
* [details](#details)
* [extend](#extend)
* [isEqual](#isequal)
* [transferOwnership](#transferownership)
* [generateUuid](#static-generateuuid)
* [unserialize](#static-unserialize)

## Properties

### `Protected` context

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

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

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

### ticker

• **ticker**: *string*

*Defined in* [*src/api/entities/TickerReservation/index.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/TickerReservation/index.ts#L48)

reserved ticker

### uuid

• **uuid**: *string*

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

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

## Methods

### createToken

▸ **createToken**(`args`: [CreateSecurityTokenParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/createsecuritytokenparams)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue)*‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/securitytoken)*››*

*Defined in* [*src/api/entities/TickerReservation/index.ts:183*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/TickerReservation/index.ts#L183)

Create a Security Token using the reserved ticker

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

**`note`** required role:

* Ticker Owner

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod), which means you can call `createToken.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name   | Type                                                                                                                                     |
| ------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `args` | [CreateSecurityTokenParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/createsecuritytokenparams) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue)*‹*[*SecurityToken*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/securitytoken)*››*

### details

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

*Defined in* [*src/api/entities/TickerReservation/index.ts:81*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/TickerReservation/index.ts#L81)

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-v6/interfaces/tickerreservationdetails)*›*

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

*Defined in* [*src/api/entities/TickerReservation/index.ts:82*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/TickerReservation/index.ts#L82)

**Parameters:**

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

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

### extend

▸ **extend**(`args`: void): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue)*‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/tickerreservation)*››*

*Defined in* [*src/api/entities/TickerReservation/index.ts:168*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/TickerReservation/index.ts#L168)

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

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod), which means you can call `extend.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name   | Type |
| ------ | ---- |
| `args` | void |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue)*‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/tickerreservation)*››*

### isEqual

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

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

*Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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-v6/classes/entity)‹unknown› |

**Returns:** *boolean*

### transferOwnership

▸ **transferOwnership**(`args`: [TransferTickerOwnershipParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/transfertickerownershipparams)): *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue)*‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/tickerreservation)*››*

*Defined in* [*src/api/entities/TickerReservation/index.ts:201*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/src/api/entities/TickerReservation/index.ts#L201)

Transfer ownership of the Ticker Reservation to another Identity. This generates an authorization request that must be accepted by the destinatary

**`note`** this will create [Authorization Requests](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/authorizationrequest) which have to be accepted by the corresponding [Accounts](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/account) and/or [Identities](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/enums/scopetype#identity). An Account or Identity can fetch its pending Authorization Requests by calling `authorizations.getReceived`

**`note`** required role:

* Ticker Owner

**`note`** this method is of type [ProcedureMethod](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/proceduremethod), which means you can call `transferOwnership.checkAuthorization` on it to see whether the Current Account has the required permissions to run it

**Parameters:**

| Name   | Type                                                                                                                                             |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `args` | [TransferTickerOwnershipParams](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/interfaces/transfertickerownershipparams) |

**Returns:** *Promise‹*[*TransactionQueue*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/transactionqueue)*‹*[*TickerReservation*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/tickerreservation)*››*

### `Static` generateUuid

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

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

*Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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* [*CheckpointSchedule*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/classes/checkpointschedule)*.*[*unserialize*](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v6/checkpointschedule#static-unserialize)

*Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/23062de4/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*