GramIO API Reference / @gramio/contexts/dist / ChatInviteLink
Class: ChatInviteLink
Defined in: contexts/index.d.ts:3838
Represents an invite link for a chat.
Constructors
Constructor
new ChatInviteLink(
payload):ChatInviteLink
Defined in: contexts/index.d.ts:3840
Parameters
| Parameter | Type |
|---|---|
payload | TelegramChatInviteLink |
Returns
ChatInviteLink
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramChatInviteLink | contexts/index.d.ts:3839 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:3842
Returns
string
createsJoinRequest
Get Signature
get createsJoinRequest():
boolean
Defined in: contexts/index.d.ts:3865
true, if users joining the chat via the link need to be approved by chat administrators
Returns
boolean
creator
Get Signature
get creator():
User
Defined in: contexts/index.d.ts:3849
Creator of the link
Returns
expireDate
Get Signature
get expireDate():
number
Defined in: contexts/index.d.ts:3857
Point in time (Unix timestamp) when the link will expire or has been expired
Returns
number
link
Get Signature
get link():
string
Defined in: contexts/index.d.ts:3847
The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with ….
Returns
string
memberLimit
Get Signature
get memberLimit():
number
Defined in: contexts/index.d.ts:3863
Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
Returns
number
name
Get Signature
get name():
string
Defined in: contexts/index.d.ts:3851
Invite link name
Returns
string
pendingJoinRequestCount
Get Signature
get pendingJoinRequestCount():
number
Defined in: contexts/index.d.ts:3867
Number of pending join requests created using this link
Returns
number
Methods
isPrimary()
isPrimary():
boolean
Defined in: contexts/index.d.ts:3853
true, if the link is primary
Returns
boolean
isRevoked()
isRevoked():
boolean
Defined in: contexts/index.d.ts:3855
true, if the link is revoked
Returns
boolean