tgbot-cpp
Loading...
Searching...
No Matches
TgBot::ChatBoostSourceGiveaway Struct Reference

The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways. More...

#include <Types.h>

Public Types

using Ptr = std::shared_ptr<ChatBoostSourceGiveaway>

Public Attributes

std::string source { SOURCE }
 Source of the boost, always “giveaway”
std::int32_t giveawayMessageId { }
 Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet.
std::shared_ptr< Useruser { }
 Optional. User that won the prize in the giveaway if any; for Telegram Premium giveaways only.
std::optional< std::int32_t > prizeStarCount { }
 Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only.
std::optional< bool > isUnclaimed { }
 Optional. True, if the giveaway was completed, but there was no user to win the prize.

Static Public Attributes

static TGBOT_API const std::string SOURCE

Detailed Description

The boost was obtained by the creation of a Telegram Premium or a Telegram Star giveaway. This boosts the chat 4 times for the duration of the corresponding Telegram Premium subscription for Telegram Premium giveaways and prize_star_count / 500 times for one year for Telegram Star giveaways.

Definition at line 1799 of file Types.h.

Member Typedef Documentation

◆ Ptr

Definition at line 1800 of file Types.h.

Member Data Documentation

◆ giveawayMessageId

std::int32_t TgBot::ChatBoostSourceGiveaway::giveawayMessageId { }

Identifier of a message in the chat with the giveaway; the message could have been deleted already. May be 0 if the message isn't sent yet.

Definition at line 1813 of file Types.h.

◆ isUnclaimed

std::optional<bool> TgBot::ChatBoostSourceGiveaway::isUnclaimed { }

Optional. True, if the giveaway was completed, but there was no user to win the prize.

Definition at line 1830 of file Types.h.

◆ prizeStarCount

std::optional<std::int32_t> TgBot::ChatBoostSourceGiveaway::prizeStarCount { }

Optional. The number of Telegram Stars to be split between giveaway winners; for Telegram Star giveaways only.

Definition at line 1825 of file Types.h.

◆ SOURCE

TGBOT_API const std::string TgBot::ChatBoostSourceGiveaway::SOURCE
static

Definition at line 1802 of file Types.h.

◆ source

std::string TgBot::ChatBoostSourceGiveaway::source { SOURCE }

Source of the boost, always “giveaway”

Definition at line 1807 of file Types.h.

◆ user

std::shared_ptr<User> TgBot::ChatBoostSourceGiveaway::user { }

Optional. User that won the prize in the giveaway if any; for Telegram Premium giveaways only.

Definition at line 1819 of file Types.h.


The documentation for this struct was generated from the following file: