tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | List of all members
td::td_api::getChatInviteLinks Class Referencefinal

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

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

Public Types

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

Public Member Functions

 getChatInviteLinks ()
 
 getChatInviteLinks (int53 chat_id_, int53 creator_user_id_, bool is_revoked_, int32 offset_date_, string const &offset_invite_link_, 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
 
TlObject & operator= (const TlObject &)=delete
 
 TlObject (TlObject &&)=default
 
TlObject & operator= (TlObject &&)=default
 
virtual ~TlObject ()=default
 

Public Attributes

int53 chat_id_
 Chat identifier.
 
int53 creator_user_id_
 User identifier of a chat administrator. Must be an identifier of the current user for non-owner.
 
bool is_revoked_
 Pass true if revoked links needs to be returned instead of active or expired.
 
int32 offset_date_
 Creation date of an invite link starting after which to return invite links; use 0 to get results from the beginning.
 
string offset_invite_link_
 Invite link starting after which to return invite links; use empty string to get results from the beginning.
 
int32 limit_
 The maximum number of invite links to return; up to 100.
 

Static Public Attributes

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

Detailed Description

Returns invite links for a chat created by specified administrator. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links.

Returns object_ptr<ChatInviteLinks>.

Definition at line 102807 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

using td::td_api::getChatInviteLinks::ReturnType = object_ptr<chatInviteLinks>

Typedef for the type returned by the function.

Definition at line 102855 of file td_api.h.

Constructor & Destructor Documentation

◆ getChatInviteLinks() [1/2]

td::td_api::getChatInviteLinks::getChatInviteLinks ( )

Default constructor for a function, which returns invite links for a chat created by specified administrator. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links.

Returns object_ptr<ChatInviteLinks>.

◆ getChatInviteLinks() [2/2]

td::td_api::getChatInviteLinks::getChatInviteLinks ( int53  chat_id_,
int53  creator_user_id_,
bool  is_revoked_,
int32  offset_date_,
string const &  offset_invite_link_,
int32  limit_ 
)

Creates a function, which returns invite links for a chat created by specified administrator. Requires administrator privileges and can_invite_users right in the chat to get own links and owner privileges to get other links.

Returns object_ptr<ChatInviteLinks>.

Parameters
[in]chat_id_Chat identifier.
[in]creator_user_id_User identifier of a chat administrator. Must be an identifier of the current user for non-owner.
[in]is_revoked_Pass true if revoked links needs to be returned instead of active or expired.
[in]offset_date_Creation date of an invite link starting after which to return invite links; use 0 to get results from the beginning.
[in]offset_invite_link_Invite link starting after which to return invite links; use empty string to get results from the beginning.
[in]limit_The maximum number of invite links to return; up to 100.

Member Function Documentation

◆ store()

void td::td_api::getChatInviteLinks::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::getChatInviteLinks::chat_id_

Chat identifier.

Definition at line 102818 of file td_api.h.

◆ creator_user_id_

int53 td::td_api::getChatInviteLinks::creator_user_id_

User identifier of a chat administrator. Must be an identifier of the current user for non-owner.

Definition at line 102820 of file td_api.h.

◆ ID

const std::int32_t td::td_api::getChatInviteLinks::ID = 883252396
static

Identifier uniquely determining a type of the object.

Definition at line 102852 of file td_api.h.

◆ is_revoked_

bool td::td_api::getChatInviteLinks::is_revoked_

Pass true if revoked links needs to be returned instead of active or expired.

Definition at line 102822 of file td_api.h.

◆ limit_

int32 td::td_api::getChatInviteLinks::limit_

The maximum number of invite links to return; up to 100.

Definition at line 102828 of file td_api.h.

◆ offset_date_

int32 td::td_api::getChatInviteLinks::offset_date_

Creation date of an invite link starting after which to return invite links; use 0 to get results from the beginning.

Definition at line 102824 of file td_api.h.

◆ offset_invite_link_

string td::td_api::getChatInviteLinks::offset_invite_link_

Invite link starting after which to return invite links; use empty string to get results from the beginning.

Definition at line 102826 of file td_api.h.

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