GramIO API Reference / @gramio/contexts/dist / BusinessBotRights
Class: BusinessBotRights
Defined in: contexts/index.d.ts:1446
Represents the rights of a business bot.
Constructors
Constructor
new BusinessBotRights(
payload):BusinessBotRights
Defined in: contexts/index.d.ts:1448
Parameters
| Parameter | Type |
|---|---|
payload | TelegramBusinessBotRights |
Returns
BusinessBotRights
Properties
| Property | Type | Defined in |
|---|---|---|
payload | TelegramBusinessBotRights | contexts/index.d.ts:1447 |
Accessors
[toStringTag]
Get Signature
get [toStringTag]():
string
Defined in: contexts/index.d.ts:1450
Returns
string
canChangeGiftSettings
Get Signature
get canChangeGiftSettings():
boolean
Defined in: contexts/index.d.ts:1491
True, if the bot can change the privacy settings pertaining to gifts for the business account
Returns
boolean
canConvertGiftsToStars
Get Signature
get canConvertGiftsToStars():
boolean
Defined in: contexts/index.d.ts:1499
True, if the bot can convert regular gifts owned by the business account to Telegram Stars
Returns
boolean
canDeleteAllMessages
Get Signature
get canDeleteAllMessages():
boolean
Defined in: contexts/index.d.ts:1471
True, if the bot can delete all private messages in managed chats
Returns
boolean
canDeleteOutgoingMessages
Get Signature
get canDeleteOutgoingMessages():
boolean
Defined in: contexts/index.d.ts:1463
True, if the bot can delete messages sent by the bot
Deprecated
Use canDeleteSentMessages instead
Returns
boolean
canDeleteSentMessages
Get Signature
get canDeleteSentMessages():
boolean
Defined in: contexts/index.d.ts:1467
True, if the bot can delete messages sent by the bot
Returns
boolean
canEditBio
Get Signature
get canEditBio():
boolean
Defined in: contexts/index.d.ts:1479
True, if the bot can edit the bio of the business account
Returns
boolean
canEditName
Get Signature
get canEditName():
boolean
Defined in: contexts/index.d.ts:1475
True, if the bot can edit the first and last name of the business account
Returns
boolean
canEditProfilePhoto
Get Signature
get canEditProfilePhoto():
boolean
Defined in: contexts/index.d.ts:1483
True, if the bot can edit the profile photo of the business account
Returns
boolean
canEditUsername
Get Signature
get canEditUsername():
boolean
Defined in: contexts/index.d.ts:1487
True, if the bot can edit the username of the business account
Returns
boolean
canManageStories
Get Signature
get canManageStories():
boolean
Defined in: contexts/index.d.ts:1511
True, if the bot can post, edit and delete stories on behalf of the business account
Returns
boolean
canReadMessages
Get Signature
get canReadMessages():
boolean
Defined in: contexts/index.d.ts:1458
True, if the bot can read messages in the private chats that had incoming messages in the last 24 hours
Returns
boolean
canReply
Get Signature
get canReply():
boolean
Defined in: contexts/index.d.ts:1454
True, if the bot can send and edit messages in the private chats that had incoming messages in the last 24 hours
Returns
boolean
canTransferAndUpgradeGifts
Get Signature
get canTransferAndUpgradeGifts():
boolean
Defined in: contexts/index.d.ts:1503
True, if the bot can transfer and upgrade gifts owned by the business account
Returns
boolean
canTransferStars
Get Signature
get canTransferStars():
boolean
Defined in: contexts/index.d.ts:1507
True, if the bot can transfer Telegram Stars received by the business account to its own account, or use them to upgrade and transfer gifts
Returns
boolean
canViewGiftsAndStars
Get Signature
get canViewGiftsAndStars():
boolean
Defined in: contexts/index.d.ts:1495
True, if the bot can view gifts and the amount of Telegram Stars owned by the business account
Returns
boolean