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::getPollVoters Class Referencefinal

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

Inheritance diagram for td::td_api::getPollVoters:
td::td_api::Function td::TlObject

Public Types

using ReturnType = object_ptr< pollVoters >
 Typedef for the type returned by the function.
 

Public Member Functions

 getPollVoters ()
 
 getPollVoters (int53 chat_id_, int53 message_id_, int32 option_id_, int32 offset_, int32 limit_)
 
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 chat_id_
 Identifier of the chat to which the poll belongs.
 
int53 message_id_
 Identifier of the message containing the poll.
 
int32 option_id_
 0-based identifier of the answer option.
 
int32 offset_
 Number of voters to skip in the result; must be non-negative.
 
int32 limit_
 The maximum number of voters to be returned; must be positive and can&#x27;t be greater than 50. For optimal performance, the number of returned voters is chosen by TDLib and can be smaller than the specified limit, even if the end of the voter list has not been reached.
 

Static Public Attributes

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

Detailed Description

Returns message senders voted for the specified option in a poll; use poll.can_get_voters to check whether the method can be used. For optimal performance, the number of returned users is chosen by TDLib.

Returns object_ptr<PollVoters>.

Definition at line 110639 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 110684 of file td_api.h.

Constructor & Destructor Documentation

◆ getPollVoters() [1/2]

td::td_api::getPollVoters::getPollVoters ( )

Default constructor for a function, which returns message senders voted for the specified option in a poll; use poll.can_get_voters to check whether the method can be used. For optimal performance, the number of returned users is chosen by TDLib.

Returns object_ptr<PollVoters>.

◆ getPollVoters() [2/2]

td::td_api::getPollVoters::getPollVoters ( int53  chat_id_,
int53  message_id_,
int32  option_id_,
int32  offset_,
int32  limit_ 
)

Creates a function, which returns message senders voted for the specified option in a poll; use poll.can_get_voters to check whether the method can be used. For optimal performance, the number of returned users is chosen by TDLib.

Returns object_ptr<PollVoters>.

Parameters
[in]chat_id_Identifier of the chat to which the poll belongs.
[in]message_id_Identifier of the message containing the poll.
[in]option_id_0-based identifier of the answer option.
[in]offset_Number of voters to skip in the result; must be non-negative.
[in]limit_The maximum number of voters to be returned; must be positive and can&#x27;t be greater than 50. For optimal performance, the number of returned voters is chosen by TDLib and can be smaller than the specified limit, even if the end of the voter list has not been reached.

Member Function Documentation

◆ store()

void td::td_api::getPollVoters::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

◆ chat_id_

int53 td::td_api::getPollVoters::chat_id_

Identifier of the chat to which the poll belongs.

Definition at line 110650 of file td_api.h.

◆ ID

const std::int32_t td::td_api::getPollVoters::ID = -1602915575
static

Identifier uniquely determining a type of the object.

Definition at line 110681 of file td_api.h.

◆ limit_

int32 td::td_api::getPollVoters::limit_

The maximum number of voters to be returned; must be positive and can&#x27;t be greater than 50. For optimal performance, the number of returned voters is chosen by TDLib and can be smaller than the specified limit, even if the end of the voter list has not been reached.

Definition at line 110658 of file td_api.h.

◆ message_id_

int53 td::td_api::getPollVoters::message_id_

Identifier of the message containing the poll.

Definition at line 110652 of file td_api.h.

◆ offset_

int32 td::td_api::getPollVoters::offset_

Number of voters to skip in the result; must be non-negative.

Definition at line 110656 of file td_api.h.

◆ option_id_

int32 td::td_api::getPollVoters::option_id_

0-based identifier of the answer option.

Definition at line 110654 of file td_api.h.


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