GramIO API Reference / @gramio/contexts/dist / ChatBoost
Class: ChatBoost
Defined in: contexts/index.d.ts:3349
This object contains information about a chat boost.
Constructors
Constructor
new ChatBoost(
payload):ChatBoost
Defined in: contexts/index.d.ts:3351
Parameters
| Parameter | Type |
|---|---|
payload | TelegramChatBoost |
Returns
ChatBoost
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramChatBoost | contexts/index.d.ts:3350 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:3353
Returns
string
addDate
Get Signature
get addDate():
number
Defined in: contexts/index.d.ts:3357
Point in time (Unix timestamp) when the chat was boosted
Returns
number
expirationDate
Get Signature
get expirationDate():
number
Defined in: contexts/index.d.ts:3359
Point in time (Unix timestamp) when the boost will automatically expire, unless the booster's Telegram Premium subscription is prolonged
Returns
number
id
Get Signature
get id():
string
Defined in: contexts/index.d.ts:3355
Unique identifier of the boost
Returns
string
source
Get Signature
get source():
ChatBoostSourcePremium|ChatBoostSourceGiftCode|ChatBoostSourceGiveaway
Defined in: contexts/index.d.ts:3361
Source of the added boost
Returns
ChatBoostSourcePremium | ChatBoostSourceGiftCode | ChatBoostSourceGiveaway