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

#include <GiveawayWinners.h>

Public Types
typedef std::shared_ptr< GiveawayWinners >	Ptr

Public Attributes
Chat::Ptr	chat
	The chat that created the giveaway.

std::int32_t	giveawayMessageId
	Identifier of the message with the giveaway in the chat.

std::uint32_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< User::Ptr >	winners
	List of up to 100 winners of the giveaway.

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

std::int32_t	premiumSubscriptionMonthCount
	Optional. The number of months the Telegram Premium subscription won from the giveaway will be active for.

std::int32_t	unclaimedPrizeCount
	Optional. Number of undistributed prizes.

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

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

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 19 of file GiveawayWinners.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<GiveawayWinners> TgBot::GiveawayWinners::Ptr

Definition at line 22 of file GiveawayWinners.h.

Member Data Documentation

◆ additionalChatCount

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 52 of file GiveawayWinners.h.

◆ chat

Chat::Ptr TgBot::GiveawayWinners::chat

The chat that created the giveaway.

Definition at line 27 of file GiveawayWinners.h.

◆ giveawayMessageId

std::int32_t TgBot::GiveawayWinners::giveawayMessageId

Identifier of the message with the giveaway in the chat.

Definition at line 32 of file GiveawayWinners.h.

◆ onlyNewMembers

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 67 of file GiveawayWinners.h.

◆ premiumSubscriptionMonthCount

std::int32_t TgBot::GiveawayWinners::premiumSubscriptionMonthCount

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

Definition at line 57 of file GiveawayWinners.h.

◆ prizeDescription

std::string TgBot::GiveawayWinners::prizeDescription

Optional. Description of additional giveaway prize.

Definition at line 77 of file GiveawayWinners.h.

◆ unclaimedPrizeCount

std::int32_t TgBot::GiveawayWinners::unclaimedPrizeCount

Optional. Number of undistributed prizes.

Definition at line 62 of file GiveawayWinners.h.

◆ wasRefunded

bool TgBot::GiveawayWinners::wasRefunded

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

Definition at line 72 of file GiveawayWinners.h.

◆ winnerCount

std::int32_t TgBot::GiveawayWinners::winnerCount

Total number of winners in the giveaway.

Definition at line 42 of file GiveawayWinners.h.

◆ winners

std::vector<User::Ptr> TgBot::GiveawayWinners::winners

List of up to 100 winners of the giveaway.

Definition at line 47 of file GiveawayWinners.h.

◆ winnersSelectionDate

std::uint32_t TgBot::GiveawayWinners::winnersSelectionDate

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

Definition at line 37 of file GiveawayWinners.h.

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

include/tgbot/types/GiveawayWinners.h

Public Types

Public Attributes