GramIO API Reference / @gramio/contexts/dist / GiveawayCompleted
Class: GiveawayCompleted
Defined in: contexts/index.d.ts:2423
This object represents a service message about the completion of a giveaway without public winners.
Constructors
Constructor
new GiveawayCompleted(
payload):GiveawayCompleted
Defined in: contexts/index.d.ts:2425
Parameters
| Parameter | Type |
|---|---|
payload | TelegramGiveawayCompleted |
Returns
GiveawayCompleted
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramGiveawayCompleted | contexts/index.d.ts:2424 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:2427
Returns
string
isStarGiveaway
Get Signature
get isStarGiveaway():
true
Defined in: contexts/index.d.ts:2435
True, if the giveaway is a Telegram Star giveaway. Otherwise, currently, the giveaway is a Telegram Premium giveaway.
Returns
true
message
Get Signature
get message():
Message
Defined in: contexts/index.d.ts:2433
Message with the giveaway that was completed, if it wasn't deleted
Returns
unclaimedPrizeCount
Get Signature
get unclaimedPrizeCount():
number
Defined in: contexts/index.d.ts:2431
Number of undistributed prizes
Returns
number
winnerCount
Get Signature
get winnerCount():
number
Defined in: contexts/index.d.ts:2429
Number of winners in the giveaway
Returns
number