td::td_api::createChatInviteLink Class Reference

Inherits td::td_api::Function.

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

Public Member Functions
	createChatInviteLink ()
	createChatInviteLink (int53 chat_id_, string const &name_, int32 expiration_date_, int32 member_limit_, bool creates_join_request_)
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
TlObject &	operator= (const TlObject &)=delete
	TlObject (TlObject &&)=default
TlObject &	operator= (TlObject &&)=default
virtual	~TlObject ()=default

Public Attributes
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.

Static Public Attributes
static const std::int32_t	ID = 287744833
	Identifier uniquely determining a type of the object.

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

Constructor & Destructor Documentation

createChatInviteLink() [1/2]

td::td_api::createChatInviteLink::createChatInviteLink

(

)

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]

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

Member Function Documentation

get_id()

std::int32_t td::td_api::createChatInviteLink::get_id ( ) const

inlinefinalvirtual

Returns identifier uniquely determining a type of the object.

Returns

this->ID.

Implements td::TlObject.

store()

void td::td_api::createChatInviteLink::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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements td::TlObject.

---

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

• td/generate/auto/td/telegram/td_api.h