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

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

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

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

Definition at line 102874 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

Typedef for the type returned by the function.

Definition at line 102919 of file td_api.h.

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

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

Member Data Documentation

◆ chat_id_

int53 td::td_api::getChatJoinRequests::chat_id_

Chat identifier.

Definition at line 102885 of file td_api.h.

◆ ID

const std::int32_t td::td_api::getChatJoinRequests::ID = -388428126
static

Identifier uniquely determining a type of the object.

Definition at line 102916 of file td_api.h.

◆ invite_link_

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

Definition at line 102887 of file td_api.h.

◆ limit_

int32 td::td_api::getChatJoinRequests::limit_

The maximum number of requests to join the chat to return.

Definition at line 102893 of file td_api.h.

◆ offset_request_

object_ptr<chatJoinRequest> td::td_api::getChatJoinRequests::offset_request_

A chat join request from which to return next requests; pass null to get results from the beginning.

Definition at line 102891 of file td_api.h.

◆ query_

string td::td_api::getChatJoinRequests::query_

A query to search for in the first names, last names and usernames of the users to return.

Definition at line 102889 of file td_api.h.


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