TgBot Namespace Reference

Classes
class	Animation
	This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). More...
class	Api
	This class executes telegram api methods. Telegram docs: https://core.telegram.org/bots/api#available-methods More...
class	Audio
	This object represents an audio file to be treated as music by the Telegram clients. More...
class	Birthdate
class	BoostHttpOnlySslClient
	This class makes http requests via boost::asio. More...
class	Bot
	This object holds other objects specific for this bot instance. More...
class	BotCommand
	This object represents a bot command. More...
class	BotCommandScope
	This abstract class is base of all bot command scopes. More...
class	BotCommandScopeAllChatAdministrators
	Represents the scope of bot commands, covering all group and supergroup chat administrators. More...
class	BotCommandScopeAllGroupChats
	Represents the scope of bot commands, covering all group and supergroup chats. More...
class	BotCommandScopeAllPrivateChats
	Represents the scope of bot commands, covering all private chats. More...
class	BotCommandScopeChat
	Represents the scope of bot commands, covering a specific chat. More...
class	BotCommandScopeChatAdministrators
	Represents the scope of bot commands, covering all administrators of a specific group or supergroup chat. More...
class	BotCommandScopeChatMember
	Represents the scope of bot commands, covering a specific member of a group or supergroup chat. More...
class	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	BotDescription
	This object represents the bot's description. More...
class	BotName
	This object represents the bot's name. More...
class	BotShortDescription
	This object represents the bot's short description. More...
class	BusinessConnection
	Describes the connection of the bot with a business account. More...
class	BusinessIntro
class	BusinessLocation
class	BusinessMessagesDeleted
	This object is received when messages are deleted from a connected business account. More...
class	BusinessOpeningHours
class	BusinessOpeningHoursInterval
class	CallbackGame
	A placeholder, currently holds no information. Use BotFather to set up your game. More...
class	CallbackQuery
	This object represents an incoming callback query from a callback button in an inline keyboard. More...
class	Chat
	This object represents a chat. More...
class	ChatAdministratorRights
	Represents the rights of an administrator in a chat. More...
class	ChatBoost
	This object contains information about a chat boost. More...
class	ChatBoostAdded
	This object represents a service message about a user boosting a chat. More...
class	ChatBoostRemoved
	This object represents a boost removed from a chat. More...
class	ChatBoostSource
	This object describes the source of a chat boost. More...
class	ChatBoostSourceGiftCode
	The boost was obtained by the creation of Telegram Premium gift codes to boost a chat. More...
class	ChatBoostSourceGiveaway
	The boost was obtained by the creation of a Telegram Premium giveaway. More...
class	ChatBoostSourcePremium
	The boost was obtained by subscribing to Telegram Premium or by gifting a Telegram Premium subscription to another user. More...
class	ChatBoostUpdated
	This object represents a boost added to a chat or changed. More...
class	ChatInviteLink
	Represents an invite link for a chat. More...
class	ChatJoinRequest
	Represents a join request sent to a chat. More...
class	ChatLocation
	Represents a location to which a chat is connected. More...
class	ChatMember
	This abstract class is base of all chat members. More...
class	ChatMemberAdministrator
	Represents a chat member that has some additional privileges. More...
class	ChatMemberBanned
	Represents a chat member that was banned in the chat and can't return to the chat or view chat messages. More...
class	ChatMemberLeft
	Represents a chat member that isn't currently a member of the chat, but may join it themselves. More...
class	ChatMemberMember
	Represents a chat member that has no additional privileges or restrictions. More...
class	ChatMemberOwner
	Represents a chat member that owns the chat and has all administrator privileges. More...
class	ChatMemberRestricted
	Represents a chat member that is under certain restrictions in the chat. More...
class	ChatMemberUpdated
	This object represents changes in the status of a chat member. More...
class	ChatPermissions
	Describes actions that a non-administrator user is allowed to take in a chat. More...
class	ChatPhoto
	This object represents a chat photo. More...
class	ChatShared
	This object contains information about a chat that was shared with the bot using a KeyboardButtonRequestChat button. More...
class	ChosenInlineResult
	This object represents a result of an inline query that was chosen by the user and sent to their chat partner. More...
class	Contact
	This object represents a phone contact. More...
class	CurlHttpClient
	This class makes http requests via libcurl. More...
class	Dice
	This object represents an animated emoji that displays a random value. More...
class	Document
	This object represents a general file (as opposed to photos, voice messages and audio files). More...
class	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	EncryptedPassportElement
	Describes documents or other Telegram Passport elements shared with the bot by the user. More...
class	EventBroadcaster
	This class holds all event listeners. More...
class	EventHandler
class	ExternalReplyInfo
	This object contains information about a message that is being replied to, which may come from another chat or forum topic. More...
class	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	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	ForumTopic
	This object represents a forum topic. More...
class	ForumTopicClosed
	This object represents a service message about a forum topic closed in the chat. More...
class	ForumTopicCreated
	This object represents a service message about a new forum topic created in the chat. More...
class	ForumTopicEdited
	This object represents a service message about an edited forum topic. More...
class	ForumTopicReopened
	This object represents a service message about a forum topic reopened in the chat. More...
class	Game
	This object represents a game. More...
class	GameHighScore
	This object represents one row of the high scores table for a game. More...
class	GeneralForumTopicHidden
	This object represents a service message about General forum topic hidden in the chat. More...
class	GeneralForumTopicUnhidden
	This object represents a service message about General forum topic unhidden in the chat. More...
class	GenericReply
	This abstract class is base of all keyboard related events. More...
class	Giveaway
	This object represents a message about a scheduled giveaway. More...
class	GiveawayCompleted
	This object represents a service message about the completion of a giveaway without public winners. More...
class	GiveawayCreated
	This object represents a service message about the creation of a scheduled giveaway. More...
class	GiveawayWinners
	This object represents a message about the completion of a giveaway with public winners. More...
class	HttpClient
	This class makes http requests. More...
class	HttpParser
class	HttpReqArg
	This class represents argument in POST http requests. More...
class	HttpServer
	This class handles HTTP requests from the Internet. More...
class	InaccessibleMessage
	This object describes a message that was deleted or is otherwise inaccessible to the bot. More...
class	InlineKeyboardButton
	This object represents one button of an inline keyboard. More...
class	InlineKeyboardMarkup
	This object represents an inline keyboard that appears right next to the message it belongs to. More...
class	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	InlineQueryResult
	This object represents one result of an inline query. More...
class	InlineQueryResultArticle
	Represents a link to an article of web page. More...
class	InlineQueryResultAudio
	Represents a link to an MP3 audio file. More...
class	InlineQueryResultCachedAudio
	Represents a link to an MP3 audio file stored on the Telegram servers. More...
class	InlineQueryResultCachedDocument
	Represents a link to a file stored on the Telegram servers. More...
class	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	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	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	InlineQueryResultCachedSticker
	Represents a link to a sticker stored on the Telegram servers. More...
class	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	InlineQueryResultCachedVoice
	Represents a link to a voice message stored on the Telegram servers. More...
class	InlineQueryResultContact
	Represents a contact with a phone number. More...
class	InlineQueryResultDocument
	Represents a link to a file. More...
class	InlineQueryResultGame
	Represents a Game. More...
class	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	InlineQueryResultLocation
	Represents a location on a map. More...
class	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	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	InlineQueryResultsButton
	This object represents a button to be shown above inline query results. More...
class	InlineQueryResultVenue
	Represents a venue. More...
class	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	InlineQueryResultVoice
	Represents a link to a voice recording in an .OGG container encoded with OPUS. More...
class	InputContactMessageContent
	Represents the content of a contact message to be sent as the result of an inline query. More...
class	InputFile
	This object represents the contents of a file to be uploaded. More...
class	InputInvoiceMessageContent
	Represents the content of an invoice message to be sent as the result of an inline query. More...
class	InputLocationMessageContent
	Represents the content of a location message to be sent as the result of an inline query. More...
class	InputMedia
	This abstract class is base of all input media. More...
class	InputMediaAnimation
	Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent. More...
class	InputMediaAudio
	Represents an audio file to be treated as music to be sent. More...
class	InputMediaDocument
	Represents a general file to be sent. More...
class	InputMediaPhoto
	Represents a photo to be sent. More...
class	InputMediaVideo
	Represents a video to be sent. More...
class	InputMessageContent
	This abstract class is base of all message contents. More...
class	InputSticker
	This object describes a sticker to be added to a sticker set. More...
class	InputTextMessageContent
	Represents the content of a text message to be sent as the result of an inline query. More...
class	InputVenueMessageContent
	Represents the content of a venue message to be sent as the result of an inline query. More...
class	Invoice
	This object contains basic information about an invoice. More...
class	KeyboardButton
	This object represents one button of the reply keyboard. More...
class	KeyboardButtonPollType
	This object represents type of a poll, which is allowed to be created and sent when the corresponding button is pressed. More...
class	KeyboardButtonRequestChat
	This object defines the criteria used to request a suitable chat. More...
class	KeyboardButtonRequestUsers
	This object defines the criteria used to request suitable users. More...
class	LabeledPrice
	This object represents a portion of the price for goods or services. More...
class	LinkPreviewOptions
	Describes the options used for link preview generation. More...
class	Location
	This object represents a point on the map. More...
class	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	MaskPosition
	This object describes the position on faces where a mask should be placed by default. More...
class	MenuButton
	This abstract class is base of all bot menu buttons. More...
class	MenuButtonCommands
	Represents a menu button, which opens the bot's list of commands. More...
class	MenuButtonDefault
	Describes that no specific value for the menu button was set. More...
class	MenuButtonWebApp
	Represents a menu button, which launches a Web App. More...
class	Message
	This object represents a message. More...
class	MessageAutoDeleteTimerChanged
	This object represents a service message about a change in auto-delete timer settings. More...
class	MessageEntity
	This object represents one special entity in a text message. More...
class	MessageId
	This object represents a unique message identifier. More...
class	MessageOrigin
	This object describes the origin of a message. More...
class	MessageOriginChannel
	The message was originally sent to a channel chat. More...
class	MessageOriginChat
	The message was originally sent on behalf of a chat to a group chat. More...
class	MessageOriginHiddenUser
	The message was originally sent by an unknown user. More...
class	MessageOriginUser
	The message was originally sent by a known user. More...
class	MessageReactionCountUpdated
	This object represents reaction changes on a message with anonymous reactions. More...
class	MessageReactionUpdated
	This object represents a change of a reaction on a message performed by a user. More...
class	OrderInfo
	This object represents information about an order. More...
class	PassportData
	Contains information about Telegram Passport data shared with the bot by the user. More...
class	PassportElementError
	This abstract class is base of all passport element errors. More...
class	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	PassportElementErrorFile
	Represents an issue with a document scan. The error is considered resolved when the file with the document scan changes. More...
class	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	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	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	PassportElementErrorSelfie
	Represents an issue with the selfie with a document. The error is considered resolved when the file with the selfie changes. More...
class	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	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	PassportElementErrorUnspecified
	Represents an issue in an unspecified place. The error is considered resolved when new data is added. More...
class	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	PhotoSize
	This object represents one size of a photo or a file / sticker thumbnail. More...
class	Poll
	This object contains information about a poll. More...
class	PollAnswer
	This object represents an answer of a user in a non-anonymous poll. More...
class	PollOption
class	PreCheckoutQuery
	This object contains information about an incoming pre-checkout query. More...
class	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	ReactionCount
	Represents a reaction added to a message along with the number of times it was added. More...
class	ReactionType
	This object describes the type of a reaction. More...
class	ReactionTypeCustomEmoji
	The reaction is based on a custom emoji. More...
class	ReactionTypeEmoji
	The reaction is based on an emoji. More...
class	ReplyKeyboardMarkup
	This object represents a custom keyboard with reply options (see Introduction to bots for details and examples). More...
class	ReplyKeyboardRemove
	Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard. More...
class	ReplyParameters
	Describes reply parameters for the message that is being sent. More...
class	ResponseParameters
	Contains information about why a request was unsuccessfull. More...
class	SentWebAppMessage
	Contains information about an inline message sent by a Web App on behalf of a user. More...
class	SharedUser
	This object contains information about a user that was shared with the bot using a KeyboardButtonRequestUser button. More...
class	ShippingAddress
	This object represents a shipping address. More...
class	ShippingOption
	This object represents one shipping option. More...
class	ShippingQuery
	This object contains information about an incoming shipping query. More...
class	Sticker
	This object represents a sticker. More...
class	StickerSet
	This object represents a sticker set. More...
class	Story
	This object represents a story. More...
class	SuccessfulPayment
	This object contains basic information about a successful payment. More...
class	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	TextQuote
	This object contains information about the quoted part of a message that is replied to by the given message. More...
class	TgException
	Exception type which is only thrown when Telegram refuses API request. More...
class	TgLongPoll
	This class handles long polling and updates parsing. More...
class	TgWebhookLocalServer
	This class setups HTTP server for receiving Telegram Update objects from unix socket. More...
class	TgWebhookServer
class	TgWebhookTcpServer
class	Update
	This object represents an incoming update. More...
class	Url
	This class parses a string with the url. More...
class	User
	This object represents a Telegram user or bot. More...
class	UserChatBoosts
	This object represents a list of boosts added to a chat by a user. More...
class	UserProfilePhotos
	This object represent a user's profile pictures. More...
class	UsersShared
	This object contains information about the users whose identifiers were shared with the bot using a KeyboardButtonRequestUsers button. More...
class	Venue
	This object represents a venue. More...
class	Video
	This object represents a video file. More...
class	VideoChatEnded
	This object represents a service message about a video chat ended in the chat. More...
class	VideoChatParticipantsInvited
	This object represents a service message about new members invited to a video chat. More...
class	VideoChatScheduled
	This object represents a service message about a video chat scheduled in the chat. More...
class	VideoChatStarted
	This object represents a service message about a video chat started in the chat. Currently holds no information. More...
class	VideoNote
	This object represents a video message. More...
class	Voice
	This object represents a voice note. More...
class	WebAppData
	Contains data sent from a Web App to the bot. More...
class	WebAppInfo
	Describes a Web App. More...
class	WebhookInfo
	Contains information about the current status of a webhook. More...
class	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...