This object represents a message about the completion of a giveaway with public winners. More...

#include <Types.h>

Public Types
using	Ptr = std::shared_ptr<GiveawayWinners>

Public Attributes
std::shared_ptr< Chat >	chat { }
	The chat that created the giveaway.
std::int32_t	giveawayMessageId { }
	Identifier of the message with the giveaway in the chat.
std::int32_t	winnersSelectionDate { }
	Point in time (Unix timestamp) when winners of the giveaway were selected.
std::int32_t	winnerCount { }
	Total number of winners in the giveaway.
std::vector< std::shared_ptr< User > >	winners { }
	List of up to 100 winners of the giveaway.
std::optional< std::int32_t >	additionalChatCount { }
	Optional. The number of other chats the user had to join in order to be eligible for the giveaway.
std::optional< std::int32_t >	prizeStarCount { }
	Optional. The number of Telegram Stars that were split between giveaway winners; for Telegram Star giveaways only.
std::optional< std::int32_t >	premiumSubscriptionMonthCount { }
	Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only.
std::optional< std::int32_t >	unclaimedPrizeCount { }
	Optional. Number of undistributed prizes.
std::optional< bool >	onlyNewMembers { }
	Optional. True, if only users who had joined the chats after the giveaway started were eligible to win.
std::optional< bool >	wasRefunded { }
	Optional. True, if the giveaway was canceled because the payment for it was refunded.
std::optional< std::string >	prizeDescription { }
	Optional. Description of additional giveaway prize.

Detailed Description

This object represents a message about the completion of a giveaway with public winners.

Definition at line 4222 of file Types.h.

Member Typedef Documentation

◆ Ptr

using TgBot::GiveawayWinners::Ptr = std::shared_ptr<GiveawayWinners>

Definition at line 4223 of file Types.h.

Member Data Documentation

◆ additionalChatCount

std::optional<std::int32_t> TgBot::GiveawayWinners::additionalChatCount { }

Optional. The number of other chats the user had to join in order to be eligible for the giveaway.

Definition at line 4254 of file Types.h.

◆ chat

std::shared_ptr<Chat> TgBot::GiveawayWinners::chat { }

The chat that created the giveaway.

Definition at line 4228 of file Types.h.

◆ giveawayMessageId

std::int32_t TgBot::GiveawayWinners::giveawayMessageId { }

Identifier of the message with the giveaway in the chat.

Definition at line 4233 of file Types.h.

◆ onlyNewMembers

std::optional<bool> TgBot::GiveawayWinners::onlyNewMembers { }

Optional. True, if only users who had joined the chats after the giveaway started were eligible to win.

Definition at line 4277 of file Types.h.

◆ premiumSubscriptionMonthCount

std::optional<std::int32_t> TgBot::GiveawayWinners::premiumSubscriptionMonthCount { }

Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for; for Telegram Premium giveaways only.

Definition at line 4266 of file Types.h.

◆ prizeDescription

std::optional<std::string> TgBot::GiveawayWinners::prizeDescription { }

Optional. Description of additional giveaway prize.

Definition at line 4287 of file Types.h.

◆ prizeStarCount

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

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

Definition at line 4260 of file Types.h.

◆ unclaimedPrizeCount

std::optional<std::int32_t> TgBot::GiveawayWinners::unclaimedPrizeCount { }

Optional. Number of undistributed prizes.

Definition at line 4271 of file Types.h.

◆ wasRefunded

std::optional<bool> TgBot::GiveawayWinners::wasRefunded { }

Optional. True, if the giveaway was canceled because the payment for it was refunded.

Definition at line 4282 of file Types.h.

◆ winnerCount

std::int32_t TgBot::GiveawayWinners::winnerCount { }

Total number of winners in the giveaway.

Definition at line 4243 of file Types.h.

◆ winners

std::vector<std::shared_ptr<User> > TgBot::GiveawayWinners::winners { }

List of up to 100 winners of the giveaway.

Definition at line 4248 of file Types.h.

◆ winnersSelectionDate

std::int32_t TgBot::GiveawayWinners::winnersSelectionDate { }

Point in time (Unix timestamp) when winners of the giveaway were selected.

Definition at line 4238 of file Types.h.

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

include/tgbot/Types.h

Public Types

Public Attributes