TDLib
Loading...
Searching...
No Matches
inputMessagePoll Class Referencefinal

Inherits InputMessageContent.

Description

A message with a poll. Polls can't be sent to secret chats and channel direct messages chats. Polls can be sent to a private chat only if the chat is a chat with a bot or the Saved Messages chat.

Public Member Functions

 inputMessagePoll ()
 inputMessagePoll (object_ptr< formattedText > &&question_, array< object_ptr< inputPollOption > > &&options_, object_ptr< formattedText > &&description_, object_ptr< InputPollMedia > &&media_, bool is_anonymous_, bool allows_multiple_answers_, bool allows_revoting_, bool members_only_, array< string > &&country_codes_, bool shuffle_options_, bool hide_results_until_closes_, object_ptr< InputPollType > &&type_, int32 open_period_, int32 close_date_, bool is_closed_)
void store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject & operator= (const TlObject &)=delete
TlObject & operator= (TlObject &&)=default
virtual void store (TlStorerCalcLength &s) const
virtual void store (TlStorerUnsafe &s) const
 TlObject ()=default
 TlObject (const TlObject &)=delete
 TlObject (TlObject &&)=default
virtual ~TlObject ()=default

Public Attributes

bool allows_multiple_answers_
 True, if multiple answer options can be chosen simultaneously.
bool allows_revoting_
 True, if the poll can be answered multiple times.
int32 close_date_
 Point in time (Unix timestamp) when the poll will automatically be closed; must be 0-getOption("poll_open_period_max") seconds in the future; pass 0 if not specified.
array< string > country_codes_
 The list of two-letter ISO 3166-1 alpha-2 codes of countries, users from which will be able to vote; for channel chats only. If empty, then all users can participate in the poll. There can be up to getOption("poll_country_count_max") chosen countries.
object_ptr< formattedText > description_
 Poll description; pass null to use an empty description; 0-getOption("message_caption_length_max") characters.
bool hide_results_until_closes_
 True, if the poll results will appear only after the poll closes.
bool is_anonymous_
 True, if the poll voters are anonymous. Non-anonymous polls can't be sent or forwarded to channels.
bool is_closed_
 True, if the poll needs to be sent already closed; for bots only.
object_ptr< InputPollMedia > media_
 Media attached to the poll; pass null if none. Must be one of the following types: inputPollMediaAnimation, inputPollMediaAudio, inputPollMediaDocument, inputPollMediaLocation, inputPollMediaPhoto, inputPollMediaVenue, or inputPollMediaVideo without caption.
bool members_only_
 True, if only the users that are members of the chat for more than a day will be able to vote; for channel chats only.
int32 open_period_
 Amount of time the poll will be active after creation, in seconds; 0-getOption("poll_open_period_max"); pass 0 if not specified.
array< object_ptr< inputPollOption > > options_
 List of poll answer options; 1-getOption("poll_answer_count_max") options.
object_ptr< formattedText > question_
 Poll question; 1-255 characters (up to 300 characters for bots). Only custom emoji entities are allowed to be added and only by Premium users.
bool shuffle_options_
 True, if poll options must be shown in a fixed random order.
object_ptr< InputPollType > type_
 Type of the poll.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ inputMessagePoll() [1/2]

inputMessagePoll ( )

A message with a poll. Polls can't be sent to secret chats and channel direct messages chats. Polls can be sent to a private chat only if the chat is a chat with a bot or the Saved Messages chat.

◆ inputMessagePoll() [2/2]

inputMessagePoll ( object_ptr< formattedText > && question_,
array< object_ptr< inputPollOption > > && options_,
object_ptr< formattedText > && description_,
object_ptr< InputPollMedia > && media_,
bool is_anonymous_,
bool allows_multiple_answers_,
bool allows_revoting_,
bool members_only_,
array< string > && country_codes_,
bool shuffle_options_,
bool hide_results_until_closes_,
object_ptr< InputPollType > && type_,
int32 open_period_,
int32 close_date_,
bool is_closed_ )

A message with a poll. Polls can't be sent to secret chats and channel direct messages chats. Polls can be sent to a private chat only if the chat is a chat with a bot or the Saved Messages chat.

Parameters
[in]question_Poll question; 1-255 characters (up to 300 characters for bots). Only custom emoji entities are allowed to be added and only by Premium users.
[in]options_List of poll answer options; 1-getOption("poll_answer_count_max") options.
[in]description_Poll description; pass null to use an empty description; 0-getOption("message_caption_length_max") characters.
[in]media_Media attached to the poll; pass null if none. Must be one of the following types: inputPollMediaAnimation, inputPollMediaAudio, inputPollMediaDocument, inputPollMediaLocation, inputPollMediaPhoto, inputPollMediaVenue, or inputPollMediaVideo without caption.
[in]is_anonymous_True, if the poll voters are anonymous. Non-anonymous polls can't be sent or forwarded to channels.
[in]allows_multiple_answers_True, if multiple answer options can be chosen simultaneously.
[in]allows_revoting_True, if the poll can be answered multiple times.
[in]members_only_True, if only the users that are members of the chat for more than a day will be able to vote; for channel chats only.
[in]country_codes_The list of two-letter ISO 3166-1 alpha-2 codes of countries, users from which will be able to vote; for channel chats only. If empty, then all users can participate in the poll. There can be up to getOption("poll_country_count_max") chosen countries.
[in]shuffle_options_True, if poll options must be shown in a fixed random order.
[in]hide_results_until_closes_True, if the poll results will appear only after the poll closes.
[in]type_Type of the poll.
[in]open_period_Amount of time the poll will be active after creation, in seconds; 0-getOption("poll_open_period_max"); pass 0 if not specified.
[in]close_date_Point in time (Unix timestamp) when the poll will automatically be closed; must be 0-getOption("poll_open_period_max") seconds in the future; pass 0 if not specified.
[in]is_closed_True, if the poll needs to be sent already closed; for bots only.

Member Function Documentation

◆ store()

void 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 TlObject.


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