Class ChatInviteLink

constructor

• new ChatInviteLink(
      raw: TypeExportedChatInvite,
      _peers?: PeersIndex,
  ): ChatInviteLink

• Parameters

  • raw: TypeExportedChatInvite
  • Optional_peers: PeersIndex

  Returns ChatInviteLink

Optional Readonly_peers

Readonlyraw

approvalNeeded

• get approvalNeeded(): boolean

• Whether users joined by this link need to be approved by the group administrator before they can join

  Returns boolean

creator

• get creator(): null | User

• Creator of the invite link, if available

  Returns null | User

date

• get date(): Date

• Creation date of the link

  Returns Date

endDate

• get endDate(): null | Date

• The date until which the link will be valid (if any)

  Returns null | Date

isMyLink

• get isMyLink(): boolean

• Whether this invite link was created by the current user.

  If so, link will be a full invite link.

  Returns boolean

isPrimary

• get isPrimary(): boolean

• Whether this link is primary (i.e. "permanent")

  Returns boolean

isRevoked

• get isRevoked(): boolean

• Whether this link was revoked and can't be used anymore

  Returns boolean

link

• get link(): string

• The invite link as a t.me/joinchat/ string.

  If the link was created by another administrator, the second part of the link will be censored with ... (e.g. https://t.me/joinchat/BGxxHIg4...

  See also: isMyLink

  Returns string

pendingApprovals

• get pendingApprovals(): number

• Number of users currently awaiting admin approval.

  0 in case the link is not using approvals

  Returns number

startDate

• get startDate(): null | Date

• The date since which the link will be valid (if any)

  Returns null | Date

usage

• get usage(): number

• Number of users currently in the chat that joined using this link

  Returns number

usageLimit

• get usageLimit(): number

• Maximum number of users that can be members of this chat at the same time after joining using this link.

  Integer in range [1, 99999] or Infinity if unspecified

  Returns number