Skip to content

ChatInviteLink

Type · TDLib 1.8.67 · d1085f9c

Contains a chat invite link

ChatInviteLink(
  invite_link: string,
  name: string,
  creator_user_id: int53,
  date: int32,
  edit_date: int32,
  expiration_date: int32,
  subscription_pricing: StarSubscriptionPricing,
  member_limit: int32,
  member_count: int32,
  expired_member_count: int32,
  pending_join_request_count: int32,
  creates_join_request: Bool,
  is_primary: Bool,
  is_revoked: Bool
) → ChatInviteLink

string

Chat invite link

name

string

Name of the link

creator_user_id

int53

User identifier of an administrator created the link

date

int32

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

edit_date

int32

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

expiration_date

int32

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

subscription_pricing

StarSubscriptionPricing

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

member_limit

int32

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

member_count

int32

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

expired_member_count

int32

Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only

pending_join_request_count

int32

Number of pending join requests created using this link

creates_join_request

Bool

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

is_primary

Bool

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

is_revoked

Bool

True, if the link was revoked