> For the complete documentation index, see [llms.txt](https://developers.polymath.network/polymesh-sdk-api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.polymath.network/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md). # 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](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹UniqueIdentifiers, string› ↳ **TickerReservation** ## Index ### Properties * [context](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#protected-context) * [ticker](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#ticker) * [uuid](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#uuid) ### Methods * [createToken](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#createtoken) * [details](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#details) * [extend](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#extend) * [isEqual](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#isequal) * [toJson](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#tojson) * [transferOwnership](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#transferownership) * [generateUuid](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#static-generateuuid) * [unserialize](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md#static-unserialize) ## Properties ### `Protected` context • **context**: [*Context*](/polymesh-sdk-api-reference/docs-v9/classes/context.md) *Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*context*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#protected-context) *Defined in* [*src/api/entities/Entity.ts:48*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L48) ### ticker • **ticker**: *string* *Defined in* [*src/api/entities/TickerReservation/index.ts:49*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/TickerReservation/index.ts#L49) reserved ticker ### uuid • **uuid**: *string* *Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*uuid*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#uuid) *Defined in* [*src/api/entities/Entity.ts:46*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L46) ## Methods ### createToken ▸ **createToken**(`args`: [CreateSecurityTokenParams](/polymesh-sdk-api-reference/docs-v9/interfaces/createsecuritytokenparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v9/classes/securitytoken.md)*››* *Defined in* [*src/api/entities/TickerReservation/index.ts:182*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/TickerReservation/index.ts#L182) Create a Security Token using the reserved ticker **`note`** required role: * Ticker Owner **`note`** this method is of type [ProcedureMethod](/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), 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](/polymesh-sdk-api-reference/docs-v9/interfaces/createsecuritytokenparams.md) | | `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md) | **Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹*[*SecurityToken*](/polymesh-sdk-api-reference/docs-v9/classes/securitytoken.md)*››* ### details ▸ **details**(): *Promise‹*[*TickerReservationDetails*](/polymesh-sdk-api-reference/docs-v9/interfaces/tickerreservationdetails.md)*›* *Defined in* [*src/api/entities/TickerReservation/index.ts:82*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/TickerReservation/index.ts#L82) Retrieve the Reservation's owner, expiry date and status **`note`** can be subscribed to **Returns:** *Promise‹*[*TickerReservationDetails*](/polymesh-sdk-api-reference/docs-v9/interfaces/tickerreservationdetails.md)*›* ▸ **details**(`callback`: [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹[TickerReservationDetails](/polymesh-sdk-api-reference/docs-v9/interfaces/tickerreservationdetails.md)›): *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›* *Defined in* [*src/api/entities/TickerReservation/index.ts:83*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/TickerReservation/index.ts#L83) **Parameters:** | Name | Type | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `callback` | [SubCallback](/polymesh-sdk-api-reference/docs-v9/globals.md#subcallback)‹[TickerReservationDetails](/polymesh-sdk-api-reference/docs-v9/interfaces/tickerreservationdetails.md)› | **Returns:** *Promise‹*[*UnsubCallback*](/polymesh-sdk-api-reference/docs-v9/globals.md#unsubcallback)*›* ### extend ▸ **extend**(`args`: void, `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md)*››* *Defined in* [*src/api/entities/TickerReservation/index.ts:169*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/TickerReservation/index.ts#L169) 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](/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), 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 | | `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md) | **Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md)*››* ### isEqual ▸ **isEqual**(`entity`: [Entity](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹unknown, unknown›): *boolean* *Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*isEqual*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#isequal) *Defined in* [*src/api/entities/Entity.ts:61*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/Entity.ts#L61) Whether this Entity is the same as another one **Parameters:** | Name | Type | | -------- | --------------------------------------------------------------------------------- | | `entity` | [Entity](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)‹unknown, unknown› | **Returns:** *boolean* ### toJson ▸ **toJson**(): *string* *Overrides* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*toJson*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#abstract-tojson) *Defined in* [*src/api/entities/TickerReservation/index.ts:207*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/TickerReservation/index.ts#L207) Return the Reservation's ticker **Returns:** *string* ### transferOwnership ▸ **transferOwnership**(`args`: [TransferTickerOwnershipParams](/polymesh-sdk-api-reference/docs-v9/interfaces/transfertickerownershipparams.md), `opts?`: [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md)): *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md)*››* *Defined in* [*src/api/entities/TickerReservation/index.ts:200*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/src/api/entities/TickerReservation/index.ts#L200) 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](/polymesh-sdk-api-reference/docs-v9/classes/authorizationrequest.md) which have to be accepted by the corresponding [Accounts](/polymesh-sdk-api-reference/docs-v9/classes/account.md) and/or [Identities](/polymesh-sdk-api-reference/docs-v9/classes/identity.md). 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](/polymesh-sdk-api-reference/docs-v9/interfaces/proceduremethod.md), 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](/polymesh-sdk-api-reference/docs-v9/interfaces/transfertickerownershipparams.md) | | `opts?` | [ProcedureOpts](/polymesh-sdk-api-reference/docs-v9/interfaces/procedureopts.md) | **Returns:** *Promise‹*[*TransactionQueue*](/polymesh-sdk-api-reference/docs-v9/classes/transactionqueue.md)*‹*[*TickerReservation*](/polymesh-sdk-api-reference/docs-v9/classes/tickerreservation.md)*››* ### `Static` generateUuid ▸ **generateUuid**‹**Identifiers**›(`identifiers`: Identifiers): *string* *Inherited from* [*Entity*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*generateUuid*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-generateuuid) *Defined in* [*src/api/entities/Entity.ts:14*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/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*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md)*.*[*unserialize*](/polymesh-sdk-api-reference/docs-v9/classes/entity.md#static-unserialize) *Defined in* [*src/api/entities/Entity.ts:23*](https://github.com/PolymathNetwork/polymesh-sdk/blob/56921667/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*