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

Inherits Function.

Description

Returns the list of boosts applied to a chat; requires administrator rights in the chat.

Returns object_ptr<FoundChatBoosts>.

Public Fields

int53 chat_id_
 Identifier of the chat.
 
bool only_gift_codes_
 Pass true to receive only boosts received from gift codes and giveaways created by the chat.
 
string offset_
 Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
 
int32 limit_
 The maximum number of boosts to be returned; up to 100. For optimal performance, the number of returned boosts can be smaller than the specified limit.
 

Public Types

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

Public Instance Methods

 getChatBoosts ()
 
 getChatBoosts (int53 chat_id_, bool only_gift_codes_, string const &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 = -1419859400
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ getChatBoosts() [1/2]

Default constructor for a function, which returns the list of boosts applied to a chat; requires administrator rights in the chat.

Returns object_ptr<FoundChatBoosts>.

◆ getChatBoosts() [2/2]

getChatBoosts ( int53  chat_id_,
bool  only_gift_codes_,
string const &  offset_,
int32  limit_ 
)

Creates a function, which returns the list of boosts applied to a chat; requires administrator rights in the chat.

Returns object_ptr<FoundChatBoosts>.

Parameters
[in]chat_id_Identifier of the chat.
[in]only_gift_codes_Pass true to receive only boosts received from gift codes and giveaways created by the chat.
[in]offset_Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results.
[in]limit_The maximum number of boosts to be returned; up to 100. For optimal performance, the number of returned boosts can be smaller than the specified limit.

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: