chatInviteLink Class Reference

Inherits Object.

Description

Contains a chat invite link.

Public Member Functions
	chatInviteLink ()
	chatInviteLink (string const &invite_link_, string const &name_, int53 creator_user_id_, int32 date_, int32 edit_date_, int32 expiration_date_, object_ptr< starSubscriptionPricing > &&subscription_pricing_, int32 member_limit_, int32 member_count_, int32 expired_member_count_, int32 pending_join_request_count_, bool creates_join_request_, bool is_primary_, bool is_revoked_)
void	store (TlStorerToString &s, const char *field_name) const final
Public Member Functions inherited from TlObject
TlObject &	operator= (const TlObject &)=delete
TlObject &	operator= (TlObject &&)=default
virtual void	store (TlStorerCalcLength &s) const
virtual void	store (TlStorerUnsafe &s) const
	TlObject ()=default
	TlObject (const TlObject &)=delete
	TlObject (TlObject &&)=default
virtual	~TlObject ()=default

Public Attributes
bool	creates_join_request_
	True, if the link only creates join request. If true, total number of joining members will be unlimited.
int53	creator_user_id_
	User identifier of an administrator created the link.
int32	date_
	Point in time (Unix timestamp) when the link was created.
int32	edit_date_
	Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown.
int32	expiration_date_
	Point in time (Unix timestamp) when the link will expire; 0 if never.
int32	expired_member_count_
	Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only.
string	invite_link_
	Chat invite link.
bool	is_primary_
	True, if the link is primary. Primary invite link can't have name, expiration date, or usage limit. There is exactly one primary invite link for each administrator with can_invite_users right at a given time.
bool	is_revoked_
	True, if the link was revoked.
int32	member_count_
	Number of chat members, which joined the chat using the link.
int32	member_limit_
	The maximum number of members, which can join the chat using the link simultaneously; 0 if not limited. Always 0 if the link requires approval.
string	name_
	Name of the link.
int32	pending_join_request_count_
	Number of pending join requests created using this link.
object_ptr< starSubscriptionPricing >	subscription_pricing_
	Information about subscription plan that is applied to the users joining the chat by the link; may be null if the link doesn't require subscription.

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

Constructor & Destructor Documentation

chatInviteLink() [1/2]

chatInviteLink

(

)

Contains a chat invite link.

chatInviteLink() [2/2]

chatInviteLink	(	string const &	invite_link_,
		string const &	name_,
		int53	creator_user_id_,
		int32	date_,
		int32	edit_date_,
		int32	expiration_date_,
		object_ptr< starSubscriptionPricing > &&	subscription_pricing_,
		int32	member_limit_,
		int32	member_count_,
		int32	expired_member_count_,
		int32	pending_join_request_count_,
		bool	creates_join_request_,
		bool	is_primary_,
		bool	is_revoked_ )

Contains a chat invite link.

Parameters

[in]	invite_link_	Chat invite link.
[in]	name_	Name of the link.
[in]	creator_user_id_	User identifier of an administrator created the link.
[in]	date_	Point in time (Unix timestamp) when the link was created.
[in]	edit_date_	Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown.
[in]	expiration_date_	Point in time (Unix timestamp) when the link will expire; 0 if never.
[in]	subscription_pricing_	Information about subscription plan that is applied to the users joining the chat by the link; may be null if the link doesn't require subscription.
[in]	member_limit_	The maximum number of members, which can join the chat using the link simultaneously; 0 if not limited. Always 0 if the link requires approval.
[in]	member_count_	Number of chat members, which joined the chat using the link.
[in]	expired_member_count_	Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only.
[in]	pending_join_request_count_	Number of pending join requests created using this link.
[in]	creates_join_request_	True, if the link only creates join request. If true, total number of joining members will be unlimited.
[in]	is_primary_	True, if the link is primary. Primary invite link can't have name, expiration date, or usage limit. There is exactly one primary invite link for each administrator with can_invite_users right at a given time.
[in]	is_revoked_	True, if the link was revoked.

Member Function 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]	s	Storer to which object string representation will be appended.
[in]	field_name	Object field_name if applicable.

Implements TlObject.

---

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

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