Boost

class pyrogram.raw.types.Boost

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

Constructor of Boost.

Details:
  • Layer: 223

  • ID: 4B3E14D6

Parameters:
  • id (str) – Unique ID for this set of boosts.

  • date (int 32-bit) – When was the boost applied

  • expires (int 32-bit) – When does the boost expire

  • gift (bool, optional) – Whether this boost was applied because the channel/supergroup 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/supergroup.

  • 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.

  • user_id (int 64-bit, optional) – ID of the user that applied the boost.

  • giveaway_msg_id (int 32-bit, optional) – The message ID of the giveaway

  • used_gift_slug (str, 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 32-bit, optional) – If set, this boost counts as multiplier boosts, otherwise it counts as a single boost.

  • stars (int 64-bit, optional) – Number of Telegram Stars distributed among the winners of the giveaway.

TL Schema

boost#4b3e14d6
flags:#
gift:flags.1?true
giveaway:flags.2?true
unclaimed:flags.3?true
id:string
user_id:flags.0?long
giveaway_msg_id:flags.2?int
date:int
expires:int
used_gift_slug:flags.4?string
multiplier:flags.5?int
stars:flags.6?long

= Boost

Parameter Tree

Boost
├── gifttrue (optional)
├── giveawaytrue (optional)
├── unclaimedtrue (optional)
├── idstring
├── user_idlong (optional)
├── giveaway_msg_idint (optional)
├── dateint
├── expiresint
├── used_gift_slugstring (optional)
├── multiplierint (optional)
└── starslong (optional)

Example

Boost(
    id="text",
    date=0,
    expires=0,
)