summaryrefslogtreecommitdiff
path: root/include/tgbot/types/GiveawayWinners.h
blob: 05d02f14a5f68b1eaa5c3ea564134941aa933682 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
#ifndef TGBOT_GIVEAWAYWINNERS_H
#define TGBOT_GIVEAWAYWINNERS_H

#include "tgbot/types/Chat.h"
#include "tgbot/types/User.h"

#include <cstdint>
#include <memory>
#include <string>
#include <vector>

namespace TgBot {

/**
 * @brief This object represents a message about the completion of a giveaway with public winners.
 *
 * @ingroup types
 */
class GiveawayWinners {

public:
    typedef std::shared_ptr<GiveawayWinners> Ptr;

    /**
     * @brief The chat that created the giveaway
     */
    Chat::Ptr chat;

    /**
     * @brief Identifier of the message with the giveaway in the chat
     */
    std::int32_t giveawayMessageId;

    /**
     * @brief Point in time (Unix timestamp) when winners of the giveaway were selected
     */
    std::uint32_t winnersSelectionDate;

    /**
     * @brief Total number of winners in the giveaway
     */
    std::int32_t winnerCount;

    /**
     * @brief List of up to 100 winners of the giveaway
     */
    std::vector<User::Ptr> winners;

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

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

    /**
     * @brief Optional. Number of undistributed prizes
     */
    std::int32_t unclaimedPrizeCount;

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

    /**
     * @brief Optional. True, if the giveaway was canceled because the payment for it was refunded
     */
    bool wasRefunded;

    /**
     * @brief Optional. Description of additional giveaway prize
     */
    std::string prizeDescription;
};
}

#endif //TGBOT_GIVEAWAYWINNERS_H