All Classes and Interfaces

Class
Description
Request builder class for Telegram methods
This object describes the types of gifts that can be gifted to a user or a chat.
AddStickerToSet class.
This class Contains information about the affiliate that received a commission via this transaction.
This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound).
AnswerCallbackQuery class.
AnswerInlineQuery clas.
AnswerPreCheckoutQuery class.
AnswerShippingQuery class.
AnswerWebAppQuery class.
A class to interact with telegram server
ApiResponse class.
ApproveChatJoinRequest class.
This object represents an audio file to be treated as music by the Telegram clients.
This object describes the way a background is filled based on the selected colors
Describes of BackgroundFill.type
This object describes the type of a background.
Describes of BackgroundType.type
Base class for bad_request errors.
BanChatMember class.
BanChatSenderChat class.
Describes the birthdate of a user.
Main class of Telebof library
 
This object represents a bot command.
This object represents the scope to which bot commands are applied.
This class is part of BotCommandScope.
Represents the scope of bot commands, covering all group and supergroup chats.
Represents the scope of bot commands, covering all private chats.
 
Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat.
Represents the scope of bot commands, covering a specific member of a group or supergroup chat.
Represents the default scope of bot commands.
This class implemented all classes defined in io.github.natanimn.telebof.requests as directly usable methods.
This object represents the bot's description.
 
This object represents the bot's name.
This object represents the bot's short description.
Represents the rights of a business bot.
Describes the connection of the bot with a business account.
Contains information about the start page settings of a Telegram Business account.
Contains information about the location of a Telegram Business account.
This object is received when messages are deleted from a connected business account.
Describes the opening hours of a business.
Describes the opening hours of a business.
A placeholder, currently holds no information.
This object represents an incoming callback query from a callback button in an inline keyboard.
Represents a chat.
Describes chat action
Represents the rights of an administrator in a chat.
This class represents a chat background.
This object contains information about a chat boost.
This object represents a service message about a user boosting a chat.
This object represents a boost removed from a chat.
This object describes the source of a chat boost.
This object represents a boost added to a chat or changed.
This object contains full information about a chat.
Represents an invite link for a chat.
Represents a join request sent to a chat.
Represents a location to which a chat is connected.
This object contains information about one member of a chat.
Describes the status of a member in a chat
This object represents changes in the status of a chat member.
Describes actions that a non-administrator user is allowed to take in a chat.
This object represents a chat photo.
This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button.
 
This object represents a checklist.
This object represents a task in a checklist.
This object represents a service message about tasks added to a checklist.
This object represents a service message about checklist tasks marked as done or not done.
Represents a result of an inline query that was chosen by the user and sent to their chat partner.
Close class.
CloseForumTopic class.
CloseGeneralForumTopic class.
Describes connection error
This object represents a phone contact.
ConvertGiftToStars class.
CopyMessage class.
Natanim Negash 3 March 2025
This class represents an inline keyboard button that copies specified text to the clipboard.
CreateChatInviteLink class
CreateChatSubscriptionInviteLink class
CreateForumTopic class.
CreateInvoiceLink class.
CreateNewStickerSet class.
Custom filter
DeclineChatJoinRequest class.
DeleteBusinessMessages class.
DeleteChatPhoto class.
DeleteChatStickerSet class.
DeleteForumTopic class.
DeleteMessage class.
DeleteMessages class.
DeleteMyCommands class.
DeleteStickerFromSet class.
DeleteStickerSet class.
DeleteStory class.
DeleteWebhook class.
This object represents an animated emoji that displays a random value.
This object represents a service message about a change in the price of direct messages sent to a channel chat.
A dispatcher class for updates
This object represents a general file (as opposed to PhotoSize, Voice and Audio).
EditChatInviteLink class
 
EditForumTopic class.
EditGeneralForumTopic class.
EditMessageCaption class.
EditMessageChecklist class.
EditMessageLiveLocation class.
EditMessageMedia class.
EditMessageReplyMarkup class.
EditMessageText class.
EditStory class.
A class for sending request of `editUserStarSubscription`
Telegram Passport is a unified authorization method for services that require personal identification.
Describes documents or other Telegram Passport elements shared with the bot by the user.
ExportChatInviteLink class.
This object contains information about a message that is being replied to, which may come from another chat or forum topic.
This object represents a file ready to be downloaded.
A class for filtering updates
Filter executor
Base class for flood errors.
Base class for forbidden errors.
Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot's message and tapped 'Reply').
This object represents a forum topic.
This object represents a service message about a forum topic closed in the chat.
This object represents a service message about a new forum topic created in the chat.
This object represents a service message about an edited forum topic.
This object represents a service message about a forum topic reopened in the chat.
ForwardMessage class.
ForwardMessages class On success, an array of MessageId of the sent messages is returned.
This object represents a game.
This object represents one row of the high scores table for a game.
This object represents a service message about General forum topic hidden in the chat.
This object represents a service message about General forum topic unhidden in the chat.
GetAvailableGifts class.
GetBusinessAccountGifts class.
GetBusinessAccountStarBalance class.
GetBusinessConnection class.
GetChat class.
GetChatAdministrators class.
GetChatMember class.
GetChatMemberCount class.
GetChatMenuButton class.
GetCustomEmojiStickers class.
GetFile class.
GetForumTopicIconStickers class.
GetGameHighScores class.
Natanim Negash 3 March 2025
GetMyCommands class.
GetMyDefaultAdministratorRights class.
GetMyDescription class.
GetMyName class.
GetMyStarBalance class.
GetStarTransactions class.
GetStickerSet class.
GetUpdates class.
GetUserChatBoosts class.
GetUserProfilePhotos class.
Natanim Negash 3 March 2025
This class represents a gift that can be sent by the bot.
Describes a service message about a regular gift that was sent or received.
GiftPremiumSubscription class.
This class represent a list of gifts.
This object represents a message about a scheduled giveaway.
This object represents a service message about the completion of a giveaway without public winners.
This object represents a service message about the creation of a scheduled giveaway.
This object represents a message about the completion of a giveaway with public winners.
HideGeneralForumTopic class.
This object represents one button of an inline keyboard.
This object represents an inline keyboard that appears right next to the message it belongs to.
This object represents an incoming inline query.
This object represents one result of an inline query.
Represents a link to an article or web page.
Represents a link to an MP3 audio file.
Represents a link to an MP3 audio file stored on the Telegram servers.
 
Represents a link to an animated GIF file stored on the Telegram servers.
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers.
Represents a link to a photo stored on the Telegram servers.
Represents a link to a sticker stored on the Telegram servers.
Represents a link to a video file stored on the Telegram servers.
Represents a link to a voice message stored on the Telegram servers.
Represents a contact with a phone number.
Represents a link to a file.
Represents a Game.
Represents a link to an animated GIF file.
Represents a location on a map.
Represents a link to a video animation (H.264/MPEG-4 AVC video without sound).
Represents a link to a photo.
This object represents a button to be shown above inline query results.
Represents a venue.
Represents a link to a page containing an embedded video player or a video file.
Represents a link to a voice recording in an .OGG container encoded with OPUS.
This object represents a checklist to create.
This object represents a task to add to a checklist.
 
 
Represents the content of an invoice message to be sent as the result of an inline query.
Represents the content of a location message to be sent as the result of an inline query.
This object represents the content of a media message to be sent.
Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
Represents an audio file to be treated as music to be sent.
Input media builder class that contains default parameters
Represents a general file to be sent.
Pass True if the photo needs to be covered with a spoiler animation
Represents a video to be sent.
This object represents the content of a message to be sent as a result of an inline query.
This object describes the paid media to be sent
The paid media to send is a photo.
The paid media to send is a video.
This object contains information about one answer option in a poll to be sent.
This object describes a profile photo to set.
An animated profile photo in the MPEG4 format.
A static profile photo in the .JPG format.
This object describes a sticker to be added to a sticker set.
This object describes the content of a story to post.
Describes a photo to post as a story.
Describes a photo to post as a story.
Represents the content of a text message to be sent as the result of an inline query.
Represents the content of a venue message to be sent as the result of an inline query.
This object contains basic information about an invoice.
This object represents one button of the reply keyboard.
This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed.
This object defines the criteria used to request a suitable chat.
This object defines the criteria used to request suitable users.
This object represents a portion of the price for goods or services.
LeaveChat class.
Describes the options used for link preview generation.
This object represents a point on the map.
Describes the physical address of a location.
This object represents a parameter of the inline keyboard button used to automatically authorize a user.
Natanim Negash 3 March 2025
 
This object describes the position on faces where a mask should be placed by default.
 
This object describes the bot's menu button in a private chat.
 
This class represents message
This object represents a service message about a change in auto-delete timer settings.
This object represents one special entity in a text message.
This class represents a unique message identifier.
This class describes the origin of a message
This enum represents one of message origin type
This object represents reaction changes on a message with anonymous reactions.
This object represents a change of a reaction on a message performed by a user.
 
This class represents information about an order.
This object describes a gift received and owned by a user or a chat.
Contains the list of gifts received and owned by a user or a chat.
This class describes paid media.
Describes the paid media added to a message.
This class contains information about a paid media purchase.
Describes PaidMedia.type
Describes a service message about a change in the price of paid messages within a chat.
Describes parse mode
Telegram Passport is a unified authorization method for services that require personal identification.
Telegram Passport is a unified authorization method for services that require personal identification.
Represents an issue in one of the data fields that was provided by the user.
Represents an issue with a document scan.
Represents an issue with a list of scans.
Represents an issue with the front side of a document.
Represents an issue with the reverse side of a document.
Represents an issue with the selfie with a document.
Describes one of PassportElementError error source
Represents an issue with one of the files that constitute the translation of a document.
Represents an issue with the translated version of a document.
Represents an issue in an unspecified place.
Describes passport element type
Telegram Passport is a unified authorization method for services that require personal identification.
This object represents one size of a photo or a file / sticker thumbnail.
PinChatMessage class.
This class contains information about a poll.
This object represents an answer of a user in a non-anonymous poll.
This class contains information about one answer option in a poll.
 
PostStory class.
This class contains information about an incoming pre-checkout query.
This class represents an inline message to be sent by a user of a Mini App.
PromoteChatMember class.
This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user.
Represents a reaction added to a message along with the number of times it was added.
This object describes the type of a reaction.
ReadBusinessMessage class.
This class contains basic information about a refunded payment.
RefundStarPayment class.
RemoveBusinessAccountProfilePhoto class.
Removes verification from a chat that is currently verified on behalf of the organization represented by the bot.
Removes verification from a user who is currently verified on behalf of the organization represented by the bot.
ReopenForumTopic class.
ReopenGeneralForumTopic class.
ReplaceStickerInSet class.
This object represents a custom keyboard with reply options
Not supported in channels and for messages sent on behalf of a Telegram Business account.
Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard.
Describes reply parameters for the message that is being sent.
Describes why a request was unsuccessful.
RestrictChatMember class.
This class describes the state of a revenue withdrawal operation
RevokeChatInviteLink class
 
SendAnimation class.
SendAudio class.
Common parameters builder for sendXyz methods
SendChatAction class.
SendChecklist class.
SendContact class.
SendPoll class.
SendDocument class.
SendGame class.
SendGift class for sending gifts
SendInvoice class.
SendLocation class.
SendMediaGroup class.
 
SendPaidMedia class.
SendPhoto class.
SendPoll class.
SendSticker class.
SendVenue class.
SendMessage class.
SendVideoNote class.
SendVoice class.
Describes an inline message sent by a Web App on behalf of a user.
SetBusinessAccountBio class.
SetBusinessAccountGiftSettings class.
SetBusinessAccountName class.
SetBusinessAccountProfilePhoto class.
SetBusinessAccountUsername class.
SetChatAdministratorCustomTitle class.
SetChatDescription class.
SetChatMenuButton class.
SetChatPermissions class.
SetChatPhoto class.
SetChatStickerSet class.
SetChatTitle class.
SetCustomEmojiStickerSetThumbnail class.
SetGameScore class.
SetMessageReaction class.
SetMyCommands class.
SetMyDefaultAdministratorRights class.
SetMyDescription class.
SetMyName class.
SetPassportDataErrors class.
SetStickerEmojiList class.
SetStickerKeywords class.
SetStickerMaskPosition class.
SetStickerPositionInSet class.
SetStickerSetThumbnail class.
SetStickerSetTitle class.
 
SetWebhook class.
This object contains information about a user that was shared with the bot using a invalid input: 'button. @author Natanim @since 3 March 2025 @version 0.9'
This class represents a shipping address.
This object represents one shipping option.
This class contains information about an incoming shipping query.
Describes an amount of Telegram Stars.
Describes a Telegram Star transaction.
Contains a list of Telegram Star transactions.
Natanim Negash 3 March 2025
This class represents a sticker.
 
This object represents a sticker set.
 
StopMessageLiveLocation class.
StopPoll class.
This object represents a story.
Describes a clickable area on a story media.
Describes the position of a clickable area within a story.
Describes the type of a clickable area on a story.
Describes a story area pointing to an HTTP or tg:// link.
Describes a story area pointing to a location.
Describes a story area pointing to a suggested reaction.
Describes a story area containing weather information.
This class contains basic information about a successful payment.
This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query.
Describes Telegram error
Represents invalid bot token erro
 
This object contains information about the quoted part of a message that is replied to by the given message.
This class describes the source of a transaction, or its recipient for outgoing transactions.
This enum represents one of TransactionPartner type
TransferBusinessAccountStars class.
TransferGift class.
Represents one of ReactionType type
UnbanChatMember class.
UnbanChatSenderChat class.
UnHideGeneralForumTopic class.
This object describes a unique gift that was upgraded from a regular gift.
This object describes the backdrop of a unique gift.
This object describes the colors of the backdrop of a unique gift.
Describes a service message about a unique gift that was sent or received.
This object describes the model of a unique gift.
This object describes the symbol shown on the pattern of a unique gift.
UnpinAllChatMessages class.
UnpinAllForumTopicMessages class.
UnpinAllGeneralForumTopicMessages class.
UnpinChatMessage class.
This class represents an incoming updates.
 
 
UpgradeGift class.
UploadStickerFile class.
This object represents a Telegram user or bot.
This object represents a list of boosts added to a chat by a user.
This object represent a user's profile pictures.
This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button.
A Utility class
This object represents a venue.
Verifies a chat on behalf of the organization which is represented by the bot.
Verifies a user on behalf of the organization which is represented by the bot.
 
This object represents a service message about a video chat ended in the chat.
This object represents a service message about new members invited to a video chat.
This object represents a service message about a video chat scheduled in the chat.
This object represents a service message about a video chat started in the chat.
This object represents a video message (available in Telegram apps as of v.4.0).
This object represents a voice note.
Describes data sent from a Web App to the bot.
Describes a Web App.
Describes the current status of a webhook.
This object represents a service message about a user allowing a bot to write messages after adding it to the attachment menu, launching a Web App from a link, or accepting an explicit request from a Web App sent by the method requestWriteAccess.