td::td_api::createChatInviteLink Class Reference

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

Inheritance diagram for td::td_api::createChatInviteLink:

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

Definition at line 93595 of file td_api.h.

Member Typedef Documentation

ReturnType

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

Typedef for the type returned by the function.

Definition at line 93640 of file td_api.h.

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

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.

Member Data Documentation

chat_id_

int53 td::td_api::createChatInviteLink::chat_id_

Chat identifier.

Definition at line 93606 of file td_api.h.

creates_join_request_

bool td::td_api::createChatInviteLink::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 93614 of file td_api.h.

expiration_date_

int32 td::td_api::createChatInviteLink::expiration_date_

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

Definition at line 93610 of file td_api.h.

ID

const std::int32_t td::td_api::createChatInviteLink::ID = 287744833

static

Identifier uniquely determining a type of the object.

Definition at line 93637 of file td_api.h.

member_limit_

int32 td::td_api::createChatInviteLink::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 93612 of file td_api.h.

name_

string td::td_api::createChatInviteLink::name_

Invite link name; 0-32 characters.

Definition at line 93608 of file td_api.h.

---

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

• /home/runner/work/tdlib-obf/tdlib-obf/td/generate/auto/td/telegram/td_api.h