Types

Classes
class	TgBot::Animation
	This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). More...
class	TgBot::Audio
	This object represents an audio file to be treated as music by the Telegram clients. More...
class	TgBot::Birthdate
class	TgBot::BotCommand
	This object represents a bot command. More...
class	TgBot::BotCommandScope
	This abstract class is base of all bot command scopes. More...
class	TgBot::BotCommandScopeAllChatAdministrators
	Represents the scope of bot commands, covering all group and supergroup chat administrators. More...
class	TgBot::BotCommandScopeAllGroupChats
	Represents the scope of bot commands, covering all group and supergroup chats. More...
class	TgBot::BotCommandScopeAllPrivateChats
	Represents the scope of bot commands, covering all private chats. More...
class	TgBot::BotCommandScopeChat
	Represents the scope of bot commands, covering a specific chat. More...
class	TgBot::BotCommandScopeChatAdministrators
	Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat. More...
class	TgBot::BotCommandScopeChatMember
	Represents the scope of bot commands, covering a specific member of a group or supergroup chat. More...
class	TgBot::BotCommandScopeDefault
	Represents the default scope of bot commands. Default commands are used if no commands with a narrower scope are specified for the user. More...
class	TgBot::BotDescription
	This object represents the bot's description. More...
class	TgBot::BotName
	This object represents the bot's name. More...
class	TgBot::BotShortDescription
	This object represents the bot's short description. More...
class	TgBot::BusinessConnection
	Describes the connection of the bot with a business account. More...
class	TgBot::BusinessIntro
class	TgBot::BusinessLocation
class	TgBot::BusinessMessagesDeleted
	This object is received when messages are deleted from a connected business account. More...
class	TgBot::BusinessOpeningHours
class	TgBot::BusinessOpeningHoursInterval
class	TgBot::CallbackGame
	A placeholder, currently holds no information. Use BotFather to set up your game. More...
class	TgBot::CallbackQuery
	This object represents an incoming callback query from a callback button in an inline keyboard. More...
class	TgBot::Chat
	This object represents a chat. More...
class	TgBot::ChatAdministratorRights
	Represents the rights of an administrator in a chat. More...
class	TgBot::ChatBoost
	This object contains information about a chat boost. More...
class	TgBot::ChatBoostAdded
	This object represents a service message about a user boosting a chat. More...
class	TgBot::ChatBoostRemoved
	This object represents a boost removed from a chat. More...
class	TgBot::ChatBoostSource
	This object describes the source of a chat boost. More...
class	TgBot::ChatBoostSourceGiftCode
	The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. More...
class	TgBot::ChatBoostSourceGiveaway
	The boost was obtained by the creation of a Telegram Premium giveaway. More...
class	TgBot::ChatBoostSourcePremium
	The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user. More...
class	TgBot::ChatBoostUpdated
	This object represents a boost added to a chat or changed. More...
class	TgBot::ChatInviteLink
	Represents an invite link for a chat. More...
class	TgBot::ChatJoinRequest
	Represents a join request sent to a chat. More...
class	TgBot::ChatLocation
	Represents a location to which a chat is connected. More...
class	TgBot::ChatMember
	This abstract class is base of all chat members. More...
class	TgBot::ChatMemberAdministrator
	Represents a chat member that has some additional privileges. More...
class	TgBot::ChatMemberBanned
	Represents a chat member that was banned in the chat and can't return to the chat or view chat messages. More...
class	TgBot::ChatMemberLeft
	Represents a chat member that isn't currently a member of the chat, but may join it themselves. More...
class	TgBot::ChatMemberMember
	Represents a chat member that has no additional privileges or restrictions. More...
class	TgBot::ChatMemberOwner
	Represents a chat member that owns the chat and has all administrator privileges. More...
class	TgBot::ChatMemberRestricted
	Represents a chat member that is under certain restrictions in the chat. More...
class	TgBot::ChatMemberUpdated
	This object represents changes in the status of a chat member. More...
class	TgBot::ChatPermissions
	Describes actions that a non-administrator user is allowed to take in a chat. More...
class	TgBot::ChatPhoto
	This object represents a chat photo. More...
class	TgBot::ChatShared
	This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button. More...
class	TgBot::ChosenInlineResult
	This object represents a result of an inline query that was chosen by the user and sent to their chat partner. More...
class	TgBot::Contact
	This object represents a phone contact. More...
class	TgBot::Dice
	This object represents an animated emoji that displays a random value. More...
class	TgBot::Document
	This object represents a general file (as opposed to photos, voice messages and audio files). More...
class	TgBot::EncryptedCredentials
	Contains data required for decrypting and authenticating EncryptedPassportElement. See https://core.telegram.org/passport#receiving-information for a complete description of the data decryption and authentication. More...
class	TgBot::EncryptedPassportElement
	Describes documents or other Telegram Passport elements shared with the bot by the user. More...
class	TgBot::ExternalReplyInfo
	This object contains information about a message that is being replied to, which may come from another chat or forum topic. More...
class	TgBot::File
	This object represents a file ready to be downloaded. The file can be downloaded via Api::downloadFile or via the link https://api.telegram.org/file/bot<token>/<filePath>. It is guaranteed that the File::filePath will be valid for at least 1 hour. When the File::filePath expires, a new one can be requested by calling Api::getFile. More...
class	TgBot::ForceReply
	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'). More...
class	TgBot::ForumTopic
	This object represents a forum topic. More...
class	TgBot::ForumTopicClosed
	This object represents a service message about a forum topic closed in the chat. More...
class	TgBot::ForumTopicCreated
	This object represents a service message about a new forum topic created in the chat. More...
class	TgBot::ForumTopicEdited
	This object represents a service message about an edited forum topic. More...
class	TgBot::ForumTopicReopened
	This object represents a service message about a forum topic reopened in the chat. More...
class	TgBot::Game
	This object represents a game. More...
class	TgBot::GameHighScore
	This object represents one row of the high scores table for a game. More...
class	TgBot::GeneralForumTopicHidden
	This object represents a service message about General forum topic hidden in the chat. More...
class	TgBot::GeneralForumTopicUnhidden
	This object represents a service message about General forum topic unhidden in the chat. More...
class	TgBot::GenericReply
	This abstract class is base of all keyboard related events. More...
class	TgBot::Giveaway
	This object represents a message about a scheduled giveaway. More...
class	TgBot::GiveawayCompleted
	This object represents a service message about the completion of a giveaway without public winners. More...
class	TgBot::GiveawayCreated
	This object represents a service message about the creation of a scheduled giveaway. More...
class	TgBot::GiveawayWinners
	This object represents a message about the completion of a giveaway with public winners. More...
class	TgBot::InaccessibleMessage
	This object describes a message that was deleted or is otherwise inaccessible to the bot. More...
class	TgBot::InlineKeyboardButton
	This object represents one button of an inline keyboard. More...
class	TgBot::InlineKeyboardMarkup
	This object represents an inline keyboard that appears right next to the message it belongs to. More...
class	TgBot::InlineQuery
	This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results. More...
class	TgBot::InlineQueryResult
	This object represents one result of an inline query. More...
class	TgBot::InlineQueryResultArticle
	Represents a link to an article of web page. More...
class	TgBot::InlineQueryResultAudio
	Represents a link to an MP3 audio file. More...
class	TgBot::InlineQueryResultCachedAudio
	Represents a link to an MP3 audio file stored on the Telegram servers. More...
class	TgBot::InlineQueryResultCachedDocument
	Represents a link to a file stored on the Telegram servers. More...
class	TgBot::InlineQueryResultCachedGif
	Represents a link to an animated GIF file stored on the Telegram servers. By default, this animated GIF file will be sent by the user with an optional caption. Alternatively, you can use inputMessageContent to send a message with specified content instead of the animation. More...
class	TgBot::InlineQueryResultCachedMpeg4Gif
	Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers. By default, this animated MPEG-4 file will be sent by the user with an optional caption. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the animation. More...
class	TgBot::InlineQueryResultCachedPhoto
	Represents a link to a photo stored on the Telegram servers. By default, this photo will be sent by the user with an optional caption. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the photo. More...
class	TgBot::InlineQueryResultCachedSticker
	Represents a link to a sticker stored on the Telegram servers. More...
class	TgBot::InlineQueryResultCachedVideo
	Represents a link to a video file stored on the Telegram servers. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the video. More...
class	TgBot::InlineQueryResultCachedVoice
	Represents a link to a voice message stored on the Telegram servers. More...
class	TgBot::InlineQueryResultContact
	Represents a contact with a phone number. More...
class	TgBot::InlineQueryResultDocument
	Represents a link to a file. More...
class	TgBot::InlineQueryResultGame
	Represents a Game. More...
class	TgBot::InlineQueryResultGif
	Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the animation. More...
class	TgBot::InlineQueryResultLocation
	Represents a location on a map. More...
class	TgBot::InlineQueryResultMpeg4Gif
	Represents a link to a video animation (H.264/MPEG-4 AVC video without sound). By default, this animated MPEG-4 file will be sent by the user with optional caption. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the animation. More...
class	TgBot::InlineQueryResultPhoto
	Represents a link to a photo. By default, this photo will be sent by the user with optional caption. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the photo. More...
class	TgBot::InlineQueryResultsButton
	This object represents a button to be shown above inline query results. More...
class	TgBot::InlineQueryResultVenue
	Represents a venue. More...
class	TgBot::InlineQueryResultVideo
	Represents a link to a page containing an embedded video player or a video file. By default, this video file will be sent by the user with an optional caption. Alternatively, you can use inputMessageContent to send a message with the specified content instead of the video. More...
class	TgBot::InlineQueryResultVoice
	Represents a link to a voice recording in an .OGG container encoded with OPUS. More...
class	TgBot::InputContactMessageContent
	Represents the content of a contact message to be sent as the result of an inline query. More...
class	TgBot::InputFile
	This object represents the contents of a file to be uploaded. More...
class	TgBot::InputInvoiceMessageContent
	Represents the content of an invoice message to be sent as the result of an inline query. More...
class	TgBot::InputLocationMessageContent
	Represents the content of a location message to be sent as the result of an inline query. More...
class	TgBot::InputMedia
	This abstract class is base of all input media. More...
class	TgBot::InputMediaAnimation
	Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. More...
class	TgBot::InputMediaAudio
	Represents an audio file to be treated as music to be sent. More...
class	TgBot::InputMediaDocument
	Represents a general file to be sent. More...
class	TgBot::InputMediaPhoto
	Represents a photo to be sent. More...
class	TgBot::InputMediaVideo
	Represents a video to be sent. More...
class	TgBot::InputMessageContent
	This abstract class is base of all message contents. More...
class	TgBot::InputSticker
	This object describes a sticker to be added to a sticker set. More...
class	TgBot::InputTextMessageContent
	Represents the content of a text message to be sent as the result of an inline query. More...
class	TgBot::InputVenueMessageContent
	Represents the content of a venue message to be sent as the result of an inline query. More...
class	TgBot::Invoice
	This object contains basic information about an invoice. More...
class	TgBot::KeyboardButton
	This object represents one button of the reply keyboard. More...
class	TgBot::KeyboardButtonPollType
	This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed. More...
class	TgBot::KeyboardButtonRequestChat
	This object defines the criteria used to request a suitable chat. More...
class	TgBot::KeyboardButtonRequestUsers
	This object defines the criteria used to request suitable users. More...
class	TgBot::LabeledPrice
	This object represents a portion of the price for goods or services. More...
class	TgBot::LinkPreviewOptions
	Describes the options used for link preview generation. More...
class	TgBot::Location
	This object represents a point on the map. More...
class	TgBot::LoginUrl
	This object represents a parameter of the inline keyboard button used to automatically authorize a user. Serves as a great replacement for the Telegram Login Widget when the user is coming from Telegram. All the user needs to do is tap/click a button and confirm that they want to log in. Telegram apps support these buttons as of version 5.7. More...
class	TgBot::MaskPosition
	This object describes the position on faces where a mask should be placed by default. More...
class	TgBot::MenuButton
	This abstract class is base of all bot menu buttons. More...
class	TgBot::MenuButtonCommands
	Represents a menu button, which opens the bot's list of commands. More...
class	TgBot::MenuButtonDefault
	Describes that no specific value for the menu button was set. More...
class	TgBot::MenuButtonWebApp
	Represents a menu button, which launches a Web App. More...
class	TgBot::Message
	This object represents a message. More...
class	TgBot::MessageAutoDeleteTimerChanged
	This object represents a service message about a change in auto-delete timer settings. More...
class	TgBot::MessageEntity
	This object represents one special entity in a text message. More...
class	TgBot::MessageId
	This object represents a unique message identifier. More...
class	TgBot::MessageOrigin
	This object describes the origin of a message. More...
class	TgBot::MessageOriginChannel
	The message was originally sent to a channel chat. More...
class	TgBot::MessageOriginChat
	The message was originally sent on behalf of a chat to a group chat. More...
class	TgBot::MessageOriginHiddenUser
	The message was originally sent by an unknown user. More...
class	TgBot::MessageOriginUser
	The message was originally sent by a known user. More...
class	TgBot::MessageReactionCountUpdated
	This object represents reaction changes on a message with anonymous reactions. More...
class	TgBot::MessageReactionUpdated
	This object represents a change of a reaction on a message performed by a user. More...
class	TgBot::OrderInfo
	This object represents information about an order. More...
class	TgBot::PassportData
	Contains information about Telegram Passport data shared with the bot by the user. More...
class	TgBot::PassportElementError
	This abstract class is base of all passport element errors. More...
class	TgBot::PassportElementErrorDataField
	Represents an issue in one of the data fields that was provided by the user. The error is considered resolved when the field's value changes. More...
class	TgBot::PassportElementErrorFile
	Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. More...
class	TgBot::PassportElementErrorFiles
	Represents an issue with a list of scans. The error is considered resolved when the list of files containing the scans changes. More...
class	TgBot::PassportElementErrorFrontSide
	Represents an issue with the front side of a document. The error is considered resolved when the file with the front side of the document changes. More...
class	TgBot::PassportElementErrorReverseSide
	Represents an issue with the reverse side of a document. The error is considered resolved when the file with reverse side of the document changes. More...
class	TgBot::PassportElementErrorSelfie
	Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. More...
class	TgBot::PassportElementErrorTranslationFile
	Represents an issue with one of the files that constitute the translation of a document. The error is considered resolved when the file changes. More...
class	TgBot::PassportElementErrorTranslationFiles
	Represents an issue with the translated version of a document. The error is considered resolved when a file with the document translation change. More...
class	TgBot::PassportElementErrorUnspecified
	Represents an issue in an unspecified place. The error is considered resolved when new data is added. More...
class	TgBot::PassportFile
	This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport files are in JPEG format when decrypted and don't exceed 10MB. More...
class	TgBot::PhotoSize
	This object represents one size of a photo or a file / sticker thumbnail. More...
class	TgBot::Poll
	This object contains information about a poll. More...
class	TgBot::PollAnswer
	This object represents an answer of a user in a non-anonymous poll. More...
class	TgBot::PreCheckoutQuery
	This object contains information about an incoming pre-checkout query. More...
class	TgBot::ProximityAlertTriggered
	This object represents the content of a service message, sent whenever a user in the chat triggers a proximity alert set by another user. More...
class	TgBot::ReactionCount
	Represents a reaction added to a message along with the number of times it was added. More...
class	TgBot::ReactionType
	This object describes the type of a reaction. More...
class	TgBot::ReactionTypeCustomEmoji
	The reaction is based on a custom emoji. More...
class	TgBot::ReactionTypeEmoji
	The reaction is based on an emoji. More...
class	TgBot::ReplyKeyboardMarkup
	This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). More...
class	TgBot::ReplyKeyboardRemove
	Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. More...
class	TgBot::ReplyParameters
	Describes reply parameters for the message that is being sent. More...
class	TgBot::ResponseParameters
	Contains information about why a request was unsuccessfull. More...
class	TgBot::SentWebAppMessage
	Contains information about an inline message sent by a Web App on behalf of a user. More...
class	TgBot::SharedUser
	This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button. More...
class	TgBot::ShippingAddress
	This object represents a shipping address. More...
class	TgBot::ShippingOption
	This object represents one shipping option. More...
class	TgBot::ShippingQuery
	This object contains information about an incoming shipping query. More...
class	TgBot::Sticker
	This object represents a sticker. More...
class	TgBot::StickerSet
	This object represents a sticker set. More...
class	TgBot::Story
	This object represents a story. More...
class	TgBot::SuccessfulPayment
	This object contains basic information about a successful payment. More...
class	TgBot::SwitchInlineQueryChosenChat
	This object represents an inline button that switches the current user to inline mode in a chosen chat, with an optional default inline query. More...
class	TgBot::TextQuote
	This object contains information about the quoted part of a message that is replied to by the given message. More...
class	TgBot::Update
	This object represents an incoming update. More...
class	TgBot::User
	This object represents a Telegram user or bot. More...
class	TgBot::UserChatBoosts
	This object represents a list of boosts added to a chat by a user. More...
class	TgBot::UserProfilePhotos
	This object represent a user's profile pictures. More...
class	TgBot::UsersShared
	This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button. More...
class	TgBot::Venue
	This object represents a venue. More...
class	TgBot::Video
	This object represents a video file. More...
class	TgBot::VideoChatEnded
	This object represents a service message about a video chat ended in the chat. More...
class	TgBot::VideoChatParticipantsInvited
	This object represents a service message about new members invited to a video chat. More...
class	TgBot::VideoChatScheduled
	This object represents a service message about a video chat scheduled in the chat. More...
class	TgBot::VideoChatStarted
	This object represents a service message about a video chat started in the chat. Currently holds no information. More...
class	TgBot::VideoNote
	This object represents a video message. More...
class	TgBot::Voice
	This object represents a voice note. More...
class	TgBot::WebAppData
	Contains data sent from a Web App to the bot. More...
class	TgBot::WebAppInfo
	Describes a Web App. More...
class	TgBot::WebhookInfo
	Contains information about the current status of a webhook. More...
class	TgBot::WriteAccessAllowed
	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. More...

Detailed Description