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

Inherits Function.

Description

Creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat.

Returns object_ptr<ChatInviteLink>.

Public Fields

int53 chat_id_
 Chat identifier.
 
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.
 

Public Types

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

Public Instance Methods

 createChatInviteLink ()
 
 createChatInviteLink (int53 chat_id_, string const &name_, int32 expiration_date_, int32 member_limit_, bool creates_join_request_)
 
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 = 287744833
 Identifier uniquely determining a type of the object.
 

Constructor & Destructor Documentation

◆ createChatInviteLink() [1/2]

Default constructor for a function, which creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat.

Returns object_ptr<ChatInviteLink>.

◆ createChatInviteLink() [2/2]

createChatInviteLink ( int53  chat_id_,
string const &  name_,
int32  expiration_date_,
int32  member_limit_,
bool  creates_join_request_ 
)

Creates a function, which creates a new invite link for a chat. Available for basic groups, supergroups, and channels. Requires administrator privileges and can_invite_users right in the chat.

Returns object_ptr<ChatInviteLink>.

Parameters
[in]chat_id_Chat identifier.
[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.

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: