GramIO API Reference / @gramio/contexts/dist / ChatShared
Class: ChatShared
Defined in: contexts/index.d.ts:1727
This object contains information about the chat whose identifier was shared with the bot using a KeyboardButtonRequestChat button.
Constructors
Constructor
new ChatShared(
payload):ChatShared
Defined in: contexts/index.d.ts:1729
Parameters
| Parameter | Type |
|---|---|
payload | TelegramChatShared |
Returns
ChatShared
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramChatShared | contexts/index.d.ts:1728 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:1731
Returns
string
chatId
Get Signature
get chatId():
number
Defined in: contexts/index.d.ts:1735
Identifier of the shared chat. 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 may not have access to the chat and could be unable to use this identifier, unless the chat is already known to the bot by some other means.
Returns
number
photo
Get Signature
get photo():
PhotoSize[]
Defined in: contexts/index.d.ts:1741
Available sizes of the chat photo, if the photo was requested by the bot.
Returns
requestId
Get Signature
get requestId():
number
Defined in: contexts/index.d.ts:1733
Identifier of the request
Returns
number
title
Get Signature
get title():
string
Defined in: contexts/index.d.ts:1737
Title of the chat, if the title was requested by the bot.
Returns
string
username
Get Signature
get username():
string
Defined in: contexts/index.d.ts:1739
Username of the chat, if the username was requested by the bot and available.
Returns
string