MCPcopy Index your code
hub / github.com/python-telegram-bot/python-telegram-bot / Giveaway

Class Giveaway

src/telegram/_giveaway.py:36–153  ·  view source on GitHub ↗

This object represents a message about a scheduled giveaway. Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`chats`, :attr:`winners_selection_date` and :attr:`winner_count` are equal. .. versionadded:: 20.8

Source from the content-addressed store, hash-verified

34
35
36class Giveaway(TelegramObject):
37 """This object represents a message about a scheduled giveaway.
38
39 Objects of this class are comparable in terms of equality. Two objects of this class are
40 considered equal, if their :attr:`chats`, :attr:`winners_selection_date` and
41 :attr:`winner_count` are equal.
42
43 .. versionadded:: 20.8
44
45 Args:
46 chats (tuple[:class:`telegram.Chat`]): The list of chats which the user must join to
47 participate in the giveaway.
48 winners_selection_date (:class:`datetime.datetime`): The date when the giveaway winner will
49 be selected. |datetime_localization|
50 winner_count (:obj:`int`): The number of users which are supposed to be selected as winners
51 of the giveaway.
52 only_new_members (:obj:`True`, optional): If :obj:`True`, only users who join the chats
53 after the giveaway started should be eligible to win.
54 has_public_winners (:obj:`True`, optional): :obj:`True`, if the list of giveaway winners
55 will be visible to everyone
56 prize_description (:obj:`str`, optional): Description of additional giveaway prize
57 country_codes (Sequence[:obj:`str`]): A list of two-letter ISO 3166-1 alpha-2
58 country codes indicating the countries from which eligible users for the giveaway must
59 come. If empty, then all users can participate in the giveaway. Users with a phone
60 number that was bought on Fragment can always participate in giveaways.
61 prize_star_count (:obj:`int`, optional): The number of Telegram Stars to be split between
62 giveaway winners; for Telegram Star giveaways only.
63
64 .. versionadded:: 21.6
65 premium_subscription_month_count (:obj:`int`, optional): The number of months the Telegram
66 Premium subscription won from the giveaway will be active for; for Telegram Premium
67 giveaways only.
68
69 Attributes:
70 chats (Sequence[:class:`telegram.Chat`]): The list of chats which the user must join to
71 participate in the giveaway.
72 winners_selection_date (:class:`datetime.datetime`): The date when the giveaway winner will
73 be selected. |datetime_localization|
74 winner_count (:obj:`int`): The number of users which are supposed to be selected as winners
75 of the giveaway.
76 only_new_members (:obj:`True`): Optional. If :obj:`True`, only users who join the chats
77 after the giveaway started should be eligible to win.
78 has_public_winners (:obj:`True`): Optional. :obj:`True`, if the list of giveaway winners
79 will be visible to everyone
80 prize_description (:obj:`str`): Optional. Description of additional giveaway prize
81 country_codes (tuple[:obj:`str`]): Optional. A tuple of two-letter ISO 3166-1 alpha-2
82 country codes indicating the countries from which eligible users for the giveaway must
83 come. If empty, then all users can participate in the giveaway. Users with a phone
84 number that was bought on Fragment can always participate in giveaways.
85 prize_star_count (:obj:`int`): Optional. The number of Telegram Stars to be split between
86 giveaway winners; for Telegram Star giveaways only.
87
88 .. versionadded:: 21.6
89 premium_subscription_month_count (:obj:`int`): Optional. The number of months the Telegram
90 Premium subscription won from the giveaway will be active for; for Telegram Premium
91 giveaways only.
92 """
93

Callers 3

giveawayFunction · 0.90
test_equalityMethod · 0.90

Calls

no outgoing calls

Tested by 2

giveawayFunction · 0.72
test_equalityMethod · 0.72

Used in the wild real call sites across dependent graphs

searching dependent graphs…