GramIO API Reference / @gramio/contexts/dist / ChatFullInfo
Class: ChatFullInfo
Defined in: contexts/index.d.ts:3966
This object contains full information about a chat.
Constructors
Constructor
new ChatFullInfo(
payload):ChatFullInfo
Defined in: contexts/index.d.ts:3968
Parameters
| Parameter | Type |
|---|---|
payload | TelegramChatFullInfo |
Returns
ChatFullInfo
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramChatFullInfo | contexts/index.d.ts:3967 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:3970
Returns
string
accentColorId
Get Signature
get accentColorId():
number
Defined in: contexts/index.d.ts:4006
Identifier of the accent color for the chat name and backgrounds of the chat photo, reply header, and link preview. See accent colors for more details.
Returns
number
acceptedGiftTypes
Get Signature
get acceptedGiftTypes():
AcceptedGiftTypes
Defined in: contexts/index.d.ts:4144
Returns
activeUsernames
Get Signature
get activeUsernames():
string[]
Defined in: contexts/index.d.ts:4018
Optional. If non-empty, the list of all active chat usernames; for private chats, supergroups and channels
Returns
string[]
availableReactions
Get Signature
get availableReactions():
TelegramReactionType[]
Defined in: contexts/index.d.ts:4046
Optional. List of available reactions allowed in the chat. If omitted, then all emoji reactions are allowed.
Returns
backgroundCustomEmojiId
Get Signature
get backgroundCustomEmojiId():
string
Defined in: contexts/index.d.ts:4050
Optional. Custom emoji identifier of the emoji chosen by the chat for the reply header and link preview background
Returns
string
bio
Get Signature
get bio():
string
Defined in: contexts/index.d.ts:4070
Optional. Bio of the other party in a private chat
Returns
string
birthdate
Get Signature
get birthdate():
Birthdate
Defined in: contexts/index.d.ts:4022
Optional. For private chats, the date of birth of the user
Returns
businessIntro
Get Signature
get businessIntro():
BusinessIntro
Defined in: contexts/index.d.ts:4026
Optional. For private chats with business accounts, the intro of the business
Returns
businessLocation
Get Signature
get businessLocation():
BusinessLocation
Defined in: contexts/index.d.ts:4030
Optional. For private chats with business accounts, the location of the business
Returns
businessOpeningHours
Get Signature
get businessOpeningHours():
BusinessOpeningHours
Defined in: contexts/index.d.ts:4034
Optional. For private chats with business accounts, the opening hours of the business
Returns
canSendGift
Get Signature
get canSendGift():
boolean
Defined in: contexts/index.d.ts:4143
Returns
boolean
canSendPaidMedia
Get Signature
get canSendPaidMedia():
true
Defined in: contexts/index.d.ts:4138
Optional. True, if the bot can change the group sticker set
Returns
true
canSetStickerSet
Get Signature
get canSetStickerSet():
true
Defined in: contexts/index.d.ts:4142
Optional. True, if the bot can change the group sticker set
Returns
true
community
Get Signature
get community():
Community
Defined in: contexts/index.d.ts:4178
Optional. Information about the community the chat belongs to
Returns
customEmojiStickerSetName
Get Signature
get customEmojiStickerSetName():
string
Defined in: contexts/index.d.ts:4148
Optional. For supergroups, the name of the group's custom emoji sticker set. Custom emoji from this set can be used by all users and bots in the group.
Returns
string
description
Get Signature
get description():
string
Defined in: contexts/index.d.ts:4090
Optional. Description, for groups, supergroups and channel chats
Returns
string
emojiStatusCustomEmojiId
Get Signature
get emojiStatusCustomEmojiId():
string
Defined in: contexts/index.d.ts:4062
Optional. Custom emoji identifier of the emoji status of the chat or the other party in a private chat
Returns
string
emojiStatusExpirationDate
Get Signature
get emojiStatusExpirationDate():
number
Defined in: contexts/index.d.ts:4066
Optional. Expiration date of the emoji status of the chat or the other party in a private chat, in Unix time, if any
Returns
number
firstName
Get Signature
get firstName():
string
Defined in: contexts/index.d.ts:3990
Optional. First name of the other party in a private chat
Returns
string
firstProfileAudio
Get Signature
get firstProfileAudio():
AudioAttachment
Defined in: contexts/index.d.ts:4164
Optional. For private chats, the first audio added to the profile of the user
Returns
guardBot
Get Signature
get guardBot():
User
Defined in: contexts/index.d.ts:4176
Optional. The bot that processes join request queries in the chat. The field is only available to chat administrators.
Returns
hasAggressiveAntiSpamEnabled
Get Signature
get hasAggressiveAntiSpamEnabled():
true
Defined in: contexts/index.d.ts:4118
Optional. True, if aggressive anti-spam checks are enabled in the supergroup. The field is only available to chat administrators.
Returns
true
hasHiddenMembers
Get Signature
get hasHiddenMembers():
true
Defined in: contexts/index.d.ts:4122
Optional. True, if non-administrators can only get the list of bots and administrators in the chat
Returns
true
hasPrivateForwards
Get Signature
get hasPrivateForwards():
true
Defined in: contexts/index.d.ts:4074
Optional. True, if privacy settings of the other party in the private chat allows to use tg://user?id=<user_id> links only in chats with the user
Returns
true
hasProtectedContent
Get Signature
get hasProtectedContent():
true
Defined in: contexts/index.d.ts:4126
Optional. True, if messages from the chat can't be forwarded to other chats
Returns
true
hasRestrictedVoiceAndVideoMessages
Get Signature
get hasRestrictedVoiceAndVideoMessages():
true
Defined in: contexts/index.d.ts:4078
Optional. True, if the privacy settings of the other party restrict sending voice and video note messages in the private chat
Returns
true
hasVisibleHistory
Get Signature
get hasVisibleHistory():
true
Defined in: contexts/index.d.ts:4130
Optional. True, if new chat members will have access to old messages; available only to chat administrators
Returns
true
id
Get Signature
get id():
number
Defined in: contexts/index.d.ts:3974
Unique identifier for this 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 signed 64-bit integer or double-precision float type are safe for storing this identifier.
Returns
number
inviteLink
Get Signature
get inviteLink():
string
Defined in: contexts/index.d.ts:4094
Optional. Primary invite link, for groups, supergroups and channel chats
Returns
string
isDirectMessages
Get Signature
get isDirectMessages():
true
Defined in: contexts/index.d.ts:4002
Optional. True, if the chat is the direct messages chat of a channel
Returns
true
isForum
Get Signature
get isForum():
true
Defined in: contexts/index.d.ts:3998
Optional. True, if the supergroup chat is a forum (has topics enabled)
Returns
true
joinByRequest
Get Signature
get joinByRequest():
true
Defined in: contexts/index.d.ts:4086
Optional. True, if all users directly joining the supergroup need to be approved by supergroup administrators
Returns
true
joinToSendMessages
Get Signature
get joinToSendMessages():
true
Defined in: contexts/index.d.ts:4082
Optional. True, if users need to join the supergroup before they can send messages
Returns
true
lastName
Get Signature
get lastName():
string
Defined in: contexts/index.d.ts:3994
Optional. Last name of the other party in a private chat
Returns
string
linkedChatId
Get Signature
get linkedChatId():
number
Defined in: contexts/index.d.ts:4152
Optional. Unique identifier for the linked chat, i.e. the discussion group identifier for a channel and vice versa; for supergroups and channel chats. This identifier may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier.
Returns
number
location
Get Signature
get location():
ChatLocation
Defined in: contexts/index.d.ts:4156
Optional. For supergroups, the location to which the supergroup is connected
Returns
maxReactionCount
Get Signature
get maxReactionCount():
number
Defined in: contexts/index.d.ts:4010
The maximum number of reactions that can be set on a message in the chat
Returns
number
messageAutoDeleteTime
Get Signature
get messageAutoDeleteTime():
number
Defined in: contexts/index.d.ts:4114
Optional. The time after which all messages sent to the chat will be automatically deleted; in seconds
Returns
number
paidMessageStarCount
Get Signature
get paidMessageStarCount():
number
Defined in: contexts/index.d.ts:4172
Optional. The number of Telegram Stars a general user have to pay to send a message to the chat
Returns
number
parentChat
Get Signature
get parentChat():
Chat
Defined in: contexts/index.d.ts:4042
Optional. Information about the corresponding channel chat; for direct messages chats only
Returns
permissions
Get Signature
get permissions():
ChatPermissions
Defined in: contexts/index.d.ts:4102
Optional. Default chat member permissions, for groups and supergroups
Returns
personalChat
Get Signature
get personalChat():
Chat
Defined in: contexts/index.d.ts:4038
Optional. For private chats, the personal channel of the user
Returns
photo
Get Signature
get photo():
ChatPhoto
Defined in: contexts/index.d.ts:4014
Optional. Chat photo
Returns
pinnedMessage
Get Signature
get pinnedMessage():
Message
Defined in: contexts/index.d.ts:4098
Optional. The most recent pinned message (by sending date)
Returns
profileAccentColorId
Get Signature
get profileAccentColorId():
number
Defined in: contexts/index.d.ts:4054
Optional. Identifier of the accent color for the chat's profile background. See profile accent colors for more details.
Returns
number
profileBackgroundCustomEmojiId
Get Signature
get profileBackgroundCustomEmojiId():
string
Defined in: contexts/index.d.ts:4058
Optional. Custom emoji identifier of the emoji chosen by the chat for its profile background
Returns
string
rating
Get Signature
get rating():
UserRating
Defined in: contexts/index.d.ts:4160
Optional. For private chats, the rating of the user if any
Returns
slowModeDelay
Get Signature
get slowModeDelay():
number
Defined in: contexts/index.d.ts:4106
Optional. For supergroups, the minimum allowed delay between consecutive messages sent by each unprivileged user; in seconds
Returns
number
stickerSetName
Get Signature
get stickerSetName():
string
Defined in: contexts/index.d.ts:4134
Optional. For supergroups, name of the group sticker set
Returns
string
title
Get Signature
get title():
string
Defined in: contexts/index.d.ts:3982
Optional. Title, for supergroups, channels and group chats
Returns
string
type
Get Signature
get type():
TelegramChatFullInfoType
Defined in: contexts/index.d.ts:3978
Type of the chat, can be either “private”, “group”, “supergroup” or “channel”
Returns
uniqueGiftColors
Get Signature
get uniqueGiftColors():
UniqueGiftColors
Defined in: contexts/index.d.ts:4168
Optional. The color scheme based on a unique gift that must be used for the chat's name, message replies and link previews
Returns
unrestrictBoostCount
Get Signature
get unrestrictBoostCount():
number
Defined in: contexts/index.d.ts:4110
Optional. For supergroups, the minimum number of boosts that a non-administrator user needs to add in order to ignore slow mode and chat permissions
Returns
number
username
Get Signature
get username():
string
Defined in: contexts/index.d.ts:3986
Optional. Username, for private chats, supergroups and channels if available
Returns
string