GramIO API Reference / @gramio/contexts/dist / ChatJoinRequest
Class: ChatJoinRequest
Defined in: contexts/index.d.ts:4215
Represents a join request sent to a chat.
Extended by
Constructors
Constructor
new ChatJoinRequest(
payload):ChatJoinRequest
Defined in: contexts/index.d.ts:4217
Parameters
| Parameter | Type |
|---|---|
payload | TelegramChatJoinRequest |
Returns
ChatJoinRequest
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramChatJoinRequest | contexts/index.d.ts:4216 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:4219
Returns
string
bio
Get Signature
get bio():
string
Defined in: contexts/index.d.ts:4229
Bio of the user
Returns
string
chat
Get Signature
get chat():
Chat
Defined in: contexts/index.d.ts:4221
Chat to which the request was sent
Returns
date
Get Signature
get date():
number
Defined in: contexts/index.d.ts:4227
Date the request was sent in Unix time
Returns
number
from
Get Signature
get from():
User
Defined in: contexts/index.d.ts:4223
User that sent the join request
Returns
inviteLink
Get Signature
get inviteLink():
ChatInviteLink
Defined in: contexts/index.d.ts:4231
Chat invite link that was used by the user to send the join request
Returns
queryId
Get Signature
get queryId():
string
Defined in: contexts/index.d.ts:4237
Identifier of the join request query. If present, then the bot must call sendChatJoinRequestWebApp or directly call answerChatJoinRequestQuery within 10 seconds.
Returns
string
userChatId
Get Signature
get userChatId():
number
Defined in: contexts/index.d.ts:4225
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