TDLib
Loading...
Searching...
No Matches
td::td_api::getChatJoinRequests Class Referencefinal

Inherits td::td_api::Function.

Public Types

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

Public Member Functions

 getChatJoinRequests ()
 
 getChatJoinRequests (int53 chat_id_, string const &invite_link_, string const &query_, object_ptr< chatJoinRequest > &&offset_request_, int32 limit_)
 
std::int32_t get_id () const final
 
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_
 Chat identifier.
 
string invite_link_
 Invite link for which to return join requests. If empty, all join requests will be returned. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links.
 
string query_
 A query to search for in the first names, last names and usernames of the users to return.
 
object_ptr< chatJoinRequestoffset_request_
 A chat join request from which to return next requests; pass null to get results from the beginning.
 
int32 limit_
 The maximum number of requests to join the chat to return.
 

Static Public Attributes

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

Detailed Description

Returns pending join requests in a chat.

Returns object_ptr<ChatJoinRequests>.

Constructor & Destructor Documentation

◆ getChatJoinRequests() [1/2]

td::td_api::getChatJoinRequests::getChatJoinRequests ( )

Default constructor for a function, which returns pending join requests in a chat.

Returns object_ptr<ChatJoinRequests>.

◆ getChatJoinRequests() [2/2]

td::td_api::getChatJoinRequests::getChatJoinRequests ( int53  chat_id_,
string const &  invite_link_,
string const &  query_,
object_ptr< chatJoinRequest > &&  offset_request_,
int32  limit_ 
)

Creates a function, which returns pending join requests in a chat.

Returns object_ptr<ChatJoinRequests>.

Parameters
[in]chat_id_Chat identifier.
[in]invite_link_Invite link for which to return join requests. If empty, all join requests will be returned. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links.
[in]query_A query to search for in the first names, last names and usernames of the users to return.
[in]offset_request_A chat join request from which to return next requests; pass null to get results from the beginning.
[in]limit_The maximum number of requests to join the chat to return.

Member Function Documentation

◆ get_id()

std::int32_t td::td_api::getChatJoinRequests::get_id ( ) const
inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns
this->ID.

Implements td::TlObject.

◆ store()

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


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