starGiftUnique
Represents a collectible star gift, see here » for more info. The sticker that represents the gift is contained in a starGiftAttributeModel object in attributes.
type tg.StarGiftUnique struct { /* ... */ }
Implements StarGift.
Fields
| Name | Type | Required | Description |
|---|---|---|---|
RequirePremium | bool | — | This gift can only be bought by users with a Premium subscription. |
ResaleTonOnly | bool | — | Whether the gift can be bought only using Toncoins. |
ThemeAvailable | bool | — | A chat theme associated to this gift is available, see here » for more info on how to use it. |
Burned | bool | — | This gift was already used as an ingredient for crafting another collectible gift ». |
Crafted | bool | — | This collectible gift was obtained by crafting », not by upgrading a regular gift. |
ID | int64 | yes | Unique identifier of this collectible gift. |
GiftID | int64 | yes | ID of the regular gift from which this gift was upgraded (all collectible gifts upgraded from the same gift will have the same gift_id, with different attributes). |
Title | string | yes | Collectible title. |
Slug | string | yes | Slug that can be used to create a collectible gift deep link », or elsewhere in the API where a collectible slug is accepted. |
Num | int | yes | Unique identifier of this collectible gift among all (already upgraded) collectible gifts of the same type. |
OwnerID | PeerClass | — | The owner of the gift. |
OwnerName | string | — | The name of the owner if neither owner_id nor owner_address are set. |
OwnerAddress | string | — | For NFTs on the TON blockchain, contains the address of the owner (append it to the ton_blockchain_explorer_url client configuration value » to obtain a link with information about the address). |
Attributes | []StarGiftAttributeClass | yes | Collectible attributes |
AvailabilityIssued | int | yes | Total number of gifts of the same type that were upgraded to a collectible gift. |
AvailabilityTotal | int | yes | Total number of gifts of the same type that can be upgraded or were already upgraded to a collectible gift. |
GiftAddress | string | — | For NFTs on the TON blockchain, contains the address of the NFT (append it to the ton_blockchain_explorer_url client configuration value » to obtain a link with information about the address). |
ResellAmount | []StarsAmountClass | — | Resale price of the gift. |
ReleasedBy | PeerClass | — | This gift was released by the specified peer. |
ValueAmount | int64 | — | Estimated price of the gift. |
ValueCurrency | string | — | Currency for the gift's estimated price. |
ValueUsdAmount | int64 | — | Estimated price of the gift in USD cents. |
ThemePeer | PeerClass | — | The current chat where the associated chat theme is installed, if any (gift-based themes can only be installed in one chat at a time). |
PeerColor | PeerColorClass | — | Can contain a collectible message palette ». |
HostID | PeerClass | — | If set, the gift is currently hosted on the specified user or channel profile even though ownership belongs to a TON wallet. The owner may transfer, resell or export the gift, while the host or owner may show it on the profile, use it as a theme/status and add it to a collection. |
OfferMinStars | int | — | If set, you can send a purchase offer for this gift »: the minimum offer price is specified in this flag. |
CraftChancePermille | int | — | Success probability, per 1000, contributed by this gift when it is used for crafting ». |
References
- Official documentation
- Generated Go reference
- TL definition:
starGiftUnique#85f0a9cd