tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::giveawayParameters Class Referencefinal

#include </home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h>

Inheritance diagram for td::td_api::giveawayParameters:
td::td_api::Object td::TlObject

Public Member Functions

 giveawayParameters ()
 
 giveawayParameters (int53 boosted_chat_id_, array< int53 > &&additional_chat_ids_, int32 winners_selection_date_, bool only_new_members_, bool has_public_winners_, array< string > &&country_codes_, string const &prize_description_)
 
void store (TlStorerToString &s, const char *field_name) const final
 
- Public Member Functions inherited from td::TlObject
virtual void store (TlStorerUnsafe &s) const
 
virtual void store (TlStorerCalcLength &s) const
 
 TlObject ()=default
 
 TlObject (const TlObject &)=delete
 
TlObjectoperator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObjectoperator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

int53 boosted_chat_id_
 Identifier of the supergroup or channel chat, which will be automatically boosted by the winners of the giveaway for duration of the Telegram Premium subscription, or for the specified time. If the chat is a channel, then can_post_messages administrator right is required in the channel, otherwise, the user must be an administrator in the supergroup.
 
array< int53additional_chat_ids_
 Identifiers of other supergroup or channel chats that must be subscribed by the users to be eligible for the giveaway. There can be up to getOption("giveaway_additional_chat_count_max") additional chats.
 
int32 winners_selection_date_
 Point in time (Unix timestamp) when the giveaway is expected to be performed; must be 60-getOption("giveaway_duration_max") seconds in the future in scheduled giveaways.
 
bool only_new_members_
 True, if only new members of the chats will be eligible for the giveaway.
 
bool has_public_winners_
 True, if the list of winners of the giveaway will be available to everyone.
 
array< stringcountry_codes_
 The list of two-letter ISO 3166-1 alpha-2 codes of countries, users from which will be eligible for the giveaway. If empty, then all users can participate in the giveaway. There can be up to getOption("giveaway_country_count_max") chosen countries. Users with phone number that was bought at https://fragment.com can participate in any giveaway and the country code "FT" must not be specified in the list.
 
string prize_description_
 Additional description of the giveaway prize; 0-128 characters.
 

Static Public Attributes

static const std::int32_t ID = 1171549354
 Identifier uniquely determining a type of the object.
 

Detailed Description

Describes parameters of a giveaway.

Definition at line 24264 of file td_api.h.

Constructor & Destructor Documentation

◆ giveawayParameters() [1/2]

td::td_api::giveawayParameters::giveawayParameters ( )

Describes parameters of a giveaway.

◆ giveawayParameters() [2/2]

td::td_api::giveawayParameters::giveawayParameters ( int53  boosted_chat_id_,
array< int53 > &&  additional_chat_ids_,
int32  winners_selection_date_,
bool  only_new_members_,
bool  has_public_winners_,
array< string > &&  country_codes_,
string const &  prize_description_ 
)

Describes parameters of a giveaway.

Parameters
[in]boosted_chat_id_Identifier of the supergroup or channel chat, which will be automatically boosted by the winners of the giveaway for duration of the Telegram Premium subscription, or for the specified time. If the chat is a channel, then can_post_messages administrator right is required in the channel, otherwise, the user must be an administrator in the supergroup.
[in]additional_chat_ids_Identifiers of other supergroup or channel chats that must be subscribed by the users to be eligible for the giveaway. There can be up to getOption("giveaway_additional_chat_count_max") additional chats.
[in]winners_selection_date_Point in time (Unix timestamp) when the giveaway is expected to be performed; must be 60-getOption("giveaway_duration_max") seconds in the future in scheduled giveaways.
[in]only_new_members_True, if only new members of the chats will be eligible for the giveaway.
[in]has_public_winners_True, if the list of winners of the giveaway will be available to everyone.
[in]country_codes_The list of two-letter ISO 3166-1 alpha-2 codes of countries, users from which will be eligible for the giveaway. If empty, then all users can participate in the giveaway. There can be up to getOption("giveaway_country_count_max") chosen countries. Users with phone number that was bought at https://fragment.com can participate in any giveaway and the country code "FT" must not be specified in the list.
[in]prize_description_Additional description of the giveaway prize; 0-128 characters.

Member Function Documentation

◆ store()

void td::td_api::giveawayParameters::store ( TlStorerToString &  s,
const char *  field_name 
) const
finalvirtual

Helper function for to_string method. Appends string representation of the object to the storer.

Parameters
[in]sStorer to which object string representation will be appended.
[in]field_nameObject field_name if applicable.

Implements td::TlObject.

Member Data Documentation

◆ additional_chat_ids_

array<int53> td::td_api::giveawayParameters::additional_chat_ids_

Identifiers of other supergroup or channel chats that must be subscribed by the users to be eligible for the giveaway. There can be up to getOption("giveaway_additional_chat_count_max") additional chats.

Definition at line 24277 of file td_api.h.

◆ boosted_chat_id_

int53 td::td_api::giveawayParameters::boosted_chat_id_

Identifier of the supergroup or channel chat, which will be automatically boosted by the winners of the giveaway for duration of the Telegram Premium subscription, or for the specified time. If the chat is a channel, then can_post_messages administrator right is required in the channel, otherwise, the user must be an administrator in the supergroup.

Definition at line 24275 of file td_api.h.

◆ country_codes_

array<string> td::td_api::giveawayParameters::country_codes_

The list of two-letter ISO 3166-1 alpha-2 codes of countries, users from which will be eligible for the giveaway. If empty, then all users can participate in the giveaway. There can be up to getOption("giveaway_country_count_max") chosen countries. Users with phone number that was bought at https://fragment.com can participate in any giveaway and the country code "FT" must not be specified in the list.

Definition at line 24285 of file td_api.h.

◆ has_public_winners_

bool td::td_api::giveawayParameters::has_public_winners_

True, if the list of winners of the giveaway will be available to everyone.

Definition at line 24283 of file td_api.h.

◆ ID

const std::int32_t td::td_api::giveawayParameters::ID = 1171549354
static

Identifier uniquely determining a type of the object.

Definition at line 24308 of file td_api.h.

◆ only_new_members_

bool td::td_api::giveawayParameters::only_new_members_

True, if only new members of the chats will be eligible for the giveaway.

Definition at line 24281 of file td_api.h.

◆ prize_description_

string td::td_api::giveawayParameters::prize_description_

Additional description of the giveaway prize; 0-128 characters.

Definition at line 24287 of file td_api.h.

◆ winners_selection_date_

int32 td::td_api::giveawayParameters::winners_selection_date_

Point in time (Unix timestamp) when the giveaway is expected to be performed; must be 60-getOption("giveaway_duration_max") seconds in the future in scheduled giveaways.

Definition at line 24279 of file td_api.h.


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