GramIO API Reference / @gramio/contexts/dist / UniqueGiftModel
Class: UniqueGiftModel
Defined in: contexts/index.d.ts:5074
Describes a service message about a regular gift that was sent or received.
Constructors
Constructor
new UniqueGiftModel(
payload):UniqueGiftModel
Defined in: contexts/index.d.ts:5076
Parameters
| Parameter | Type |
|---|---|
payload | TelegramUniqueGiftModel |
Returns
UniqueGiftModel
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramUniqueGiftModel | contexts/index.d.ts:5075 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:5078
Returns
string
name
Get Signature
get name():
string
Defined in: contexts/index.d.ts:5082
Name of the model
Returns
string
rarity
Get Signature
get rarity():
TelegramUniqueGiftModelRarity
Defined in: contexts/index.d.ts:5094
Optional. Rarity of the model if it is a crafted model. Currently, can be "uncommon", "rare", "epic", or "legendary".
Returns
rarityPerMille
Get Signature
get rarityPerMille():
number
Defined in: contexts/index.d.ts:5090
The number of unique gifts that receive this model for every 1000 gifts upgraded
Returns
number
sticker
Get Signature
get sticker():
StickerAttachment
Defined in: contexts/index.d.ts:5086
The sticker that represents the unique gift