List of all members | Public Fields | Public Types | Public Instance Methods | Static Public Attributes
getPollVoters Class Referencefinal

Inherits Function.

Description

Returns message senders voted for the specified option in a non-anonymous polls. For optimal performance, the number of returned users is chosen by TDLib.

Returns object_ptr<MessageSenders>.

Public Fields

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

Public Types

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

Public Instance Methods

 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 Instance Methods inherited from 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
 

Static Public Attributes

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

Constructor & Destructor Documentation

◆ getPollVoters() [1/2]

Default constructor for a function, which returns message senders voted for the specified option in a non-anonymous polls. For optimal performance, the number of returned users is chosen by TDLib.

Returns object_ptr<MessageSenders>.

◆ 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 non-anonymous polls. For optimal performance, the number of returned users is chosen by TDLib.

Returns object_ptr<MessageSenders>.

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.

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