tdlib-obf API
Reference documentation for the public tdlib-obf API, generated from TDLib schemas and public headers
Loading...
Searching...
No Matches
td::td_api::chatInviteLink Class Referencefinal

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

Inheritance diagram for td::td_api::chatInviteLink:
td::td_api::Object td::TlObject

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 td::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
 

Public Attributes

string invite_link_
 Chat invite link.
 
string name_
 Name of the link.
 
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.
 
object_ptr< starSubscriptionPricingsubscription_pricing_
 Information about subscription plan that is applied to the users joining the chat by the link; may be null if the link doesn&#x27;t require subscription.
 
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.
 
int32 member_count_
 Number of chat members, which joined the chat using the link.
 
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.
 
int32 pending_join_request_count_
 Number of pending join requests created using this link.
 
bool creates_join_request_
 True, if the link only creates join request. If true, total number of joining members will be unlimited.
 
bool is_primary_
 True, if the link is primary. Primary invite link can&#x27;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.
 

Static Public Attributes

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

Detailed Description

Contains a chat invite link.

Definition at line 13248 of file td_api.h.

Constructor & Destructor Documentation

◆ chatInviteLink() [1/2]

td::td_api::chatInviteLink::chatInviteLink ( )

Contains a chat invite link.

◆ chatInviteLink() [2/2]

td::td_api::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_ 
)

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&#x27;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&#x27;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 td::td_api::chatInviteLink::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

◆ creates_join_request_

bool td::td_api::chatInviteLink::creates_join_request_

True, if the link only creates join request. If true, total number of joining members will be unlimited.

Definition at line 13281 of file td_api.h.

◆ creator_user_id_

int53 td::td_api::chatInviteLink::creator_user_id_

User identifier of an administrator created the link.

Definition at line 13263 of file td_api.h.

◆ date_

int32 td::td_api::chatInviteLink::date_

Point in time (Unix timestamp) when the link was created.

Definition at line 13265 of file td_api.h.

◆ edit_date_

int32 td::td_api::chatInviteLink::edit_date_

Point in time (Unix timestamp) when the link was last edited; 0 if never or unknown.

Definition at line 13267 of file td_api.h.

◆ expiration_date_

int32 td::td_api::chatInviteLink::expiration_date_

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

Definition at line 13269 of file td_api.h.

◆ expired_member_count_

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

Definition at line 13277 of file td_api.h.

◆ ID

const std::int32_t td::td_api::chatInviteLink::ID = -957651664
static

Identifier uniquely determining a type of the object.

Definition at line 13313 of file td_api.h.

◆ invite_link_

string td::td_api::chatInviteLink::invite_link_

Chat invite link.

Definition at line 13259 of file td_api.h.

◆ is_primary_

bool td::td_api::chatInviteLink::is_primary_

True, if the link is primary. Primary invite link can&#x27;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.

Definition at line 13283 of file td_api.h.

◆ is_revoked_

bool td::td_api::chatInviteLink::is_revoked_

True, if the link was revoked.

Definition at line 13285 of file td_api.h.

◆ member_count_

int32 td::td_api::chatInviteLink::member_count_

Number of chat members, which joined the chat using the link.

Definition at line 13275 of file td_api.h.

◆ member_limit_

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

Definition at line 13273 of file td_api.h.

◆ name_

string td::td_api::chatInviteLink::name_

Name of the link.

Definition at line 13261 of file td_api.h.

◆ pending_join_request_count_

int32 td::td_api::chatInviteLink::pending_join_request_count_

Number of pending join requests created using this link.

Definition at line 13279 of file td_api.h.

◆ subscription_pricing_

object_ptr<starSubscriptionPricing> td::td_api::chatInviteLink::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&#x27;t require subscription.

Definition at line 13271 of file td_api.h.


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