GramIO API Reference / @gramio/contexts/dist / ChatJoinRequest
Class: ChatJoinRequest
Defined in: contexts/index.d.ts:3764
Represents a join request sent to a chat.
Extended by
Constructors
Constructor
new ChatJoinRequest(
payload):ChatJoinRequest
Defined in: contexts/index.d.ts:3766
Parameters
| Parameter | Type |
|---|---|
payload | TelegramChatJoinRequest |
Returns
ChatJoinRequest
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramChatJoinRequest | contexts/index.d.ts:3765 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:3768
Returns
string
bio
Get Signature
get bio():
string
Defined in: contexts/index.d.ts:3778
Bio of the user
Returns
string
chat
Get Signature
get chat():
Chat
Defined in: contexts/index.d.ts:3770
Chat to which the request was sent
Returns
date
Get Signature
get date():
number
Defined in: contexts/index.d.ts:3776
Date the request was sent in Unix time
Returns
number
from
Get Signature
get from():
User
Defined in: contexts/index.d.ts:3772
User that sent the join request
Returns
inviteLink
Get Signature
get inviteLink():
ChatInviteLink
Defined in: contexts/index.d.ts:3780
Chat invite link that was used by the user to send the join request
Returns
userChatId
Get Signature
get userChatId():
number
Defined in: contexts/index.d.ts:3774
Identifier of a private chat with the user who sent the join request. This number may have more than 32 significant bits and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a 64-bit integer or double-precision float type are safe for storing this identifier. The bot can use this identifier for 24 hours to send messages until the join request is processed, assuming no other administrator contacted the user.
Returns
number