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

Inherits Function.

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

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 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

int53 chat_id_
 Identifier of the chat to which the poll belongs.
int32 limit_
 The maximum number of voters to be returned; must be positive and can'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.
int53 message_id_
 Identifier of the message containing the poll.
int32 offset_
 Number of voters to skip in the result; must be non-negative.
int32 option_id_
 0-based identifier of the answer option.

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getPollVoters() [1/2]

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]

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'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 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: