MadelineProtoDocs/docs/API_docs/constructors/boost.md
2024-09-10 15:31:46 +02:00

2.3 KiB

title description nav_exclude image
boost Info about one or more boosts applied by a specific user. true https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Constructor: boost

Back to constructors index

Info about one or more boosts applied by a specific user.

Attributes:

Name Type Required Description
gift Bool Optional Whether this boost was applied because the channel directly gifted a subscription to the user.
giveaway Bool Optional Whether this boost was applied because the user was chosen in a giveaway started by the channel.
unclaimed Bool Optional If set, the user hasn't yet invoked payments.applyGiftCode to claim a subscription gifted directly or in a giveaway by the channel.
id string Yes Unique ID for this set of boosts.
user_id long Optional ID of the user that applied the boost.
giveaway_msg_id int Optional The message ID of the giveaway
date int Yes When was the boost applied
expires int Yes When does the boost expire
used_gift_slug string Optional The created Telegram Premium gift code, only set if either gift or giveaway are set AND it is either a gift code for the currently logged in user or if it was already claimed.
multiplier int Optional If set, this boost counts as multiplier boosts, otherwise it counts as a single boost.
stars long Optional

Type: Boost

Example:

$boost = ['_' => 'boost', 'gift' => Bool, 'giveaway' => Bool, 'unclaimed' => Bool, 'id' => 'string', 'user_id' => long, 'giveaway_msg_id' => int, 'date' => int, 'expires' => int, 'used_gift_slug' => 'string', 'multiplier' => int, 'stars' => long];