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

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

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

Public Types

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

Public Member Functions

 editChatInviteLink ()
 
 editChatInviteLink (int53 chat_id_, string const &invite_link_, string const &name_, int32 expiration_date_, int32 member_limit_, bool creates_join_request_)
 
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.
 
string invite_link_
 Invite link to be edited.
 
string name_
 Invite link name; 0-32 characters.
 
int32 expiration_date_
 Point in time (Unix timestamp) when the link will expire; pass 0 if never.
 
int32 member_limit_
 The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited.
 
bool creates_join_request_
 Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, member_limit must be 0.
 

Static Public Attributes

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

Detailed Description

Edits a non-primary invite link for a chat. Available for basic groups, supergroups, and channels. If the link creates a subscription, then expiration_date, member_limit and creates_join_request must not be used. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links.

Returns object_ptr<ChatInviteLink>.

Definition at line 97992 of file td_api.h.

Member Typedef Documentation

◆ ReturnType

using td::td_api::editChatInviteLink::ReturnType = object_ptr<chatInviteLink>

Typedef for the type returned by the function.

Definition at line 98040 of file td_api.h.

Constructor & Destructor Documentation

◆ editChatInviteLink() [1/2]

td::td_api::editChatInviteLink::editChatInviteLink ( )

Default constructor for a function, which edits a non-primary invite link for a chat. Available for basic groups, supergroups, and channels. If the link creates a subscription, then expiration_date, member_limit and creates_join_request must not be used. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links.

Returns object_ptr<ChatInviteLink>.

◆ editChatInviteLink() [2/2]

td::td_api::editChatInviteLink::editChatInviteLink ( int53  chat_id_,
string const &  invite_link_,
string const &  name_,
int32  expiration_date_,
int32  member_limit_,
bool  creates_join_request_ 
)

Creates a function, which edits a non-primary invite link for a chat. Available for basic groups, supergroups, and channels. If the link creates a subscription, then expiration_date, member_limit and creates_join_request must not be used. Requires administrator privileges and can_invite_users right in the chat for own links and owner privileges for other links.

Returns object_ptr<ChatInviteLink>.

Parameters
[in]chat_id_Chat identifier.
[in]invite_link_Invite link to be edited.
[in]name_Invite link name; 0-32 characters.
[in]expiration_date_Point in time (Unix timestamp) when the link will expire; pass 0 if never.
[in]member_limit_The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited.
[in]creates_join_request_Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, member_limit must be 0.

Member Function Documentation

◆ store()

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

Chat identifier.

Definition at line 98003 of file td_api.h.

◆ creates_join_request_

bool td::td_api::editChatInviteLink::creates_join_request_

Pass true if users joining the chat via the link need to be approved by chat administrators. In this case, member_limit must be 0.

Definition at line 98013 of file td_api.h.

◆ expiration_date_

int32 td::td_api::editChatInviteLink::expiration_date_

Point in time (Unix timestamp) when the link will expire; pass 0 if never.

Definition at line 98009 of file td_api.h.

◆ ID

const std::int32_t td::td_api::editChatInviteLink::ID = 1320303996
static

Identifier uniquely determining a type of the object.

Definition at line 98037 of file td_api.h.

◆ invite_link_

string td::td_api::editChatInviteLink::invite_link_

Invite link to be edited.

Definition at line 98005 of file td_api.h.

◆ member_limit_

int32 td::td_api::editChatInviteLink::member_limit_

The maximum number of chat members that can join the chat via the link simultaneously; 0-99999; pass 0 if not limited.

Definition at line 98011 of file td_api.h.

◆ name_

string td::td_api::editChatInviteLink::name_

Invite link name; 0-32 characters.

Definition at line 98007 of file td_api.h.

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