+ +

This is the complete list of members for TgBot::ResponseParameters, including all inherited members.

+ + + + +

migrateToChatId	TgBot::ResponseParameters
Ptr typedef	TgBot::ResponseParameters
retryAfter	TgBot::ResponseParameters

CallbackQueryListener typedef	TgBot::EventBroadcaster
ChosenInlineResultListener typedef	TgBot::EventBroadcaster
InlineQueryListener typedef	TgBot::EventBroadcaster
MessageListener typedef	TgBot::EventBroadcaster
onAnyMessage(const MessageListener &listener)	TgBot::EventBroadcaster	inline
onCallbackQuery(const CallbackQueryListener &listener)	TgBot::EventBroadcaster	inline
onChosenInlineResult(const ChosenInlineResultListener &listener)	TgBot::EventBroadcaster	inline
onCommand(const std::string &commandName, const MessageListener &listener)	TgBot::EventBroadcaster	inline
onInlineQuery(const InlineQueryListener &listener)	TgBot::EventBroadcaster	inline
onNonCommandMessage(const MessageListener &listener)	TgBot::EventBroadcaster	inline
onUnknownCommand(const MessageListener &listener)	TgBot::EventBroadcaster	inline

duration	TgBot::Audio
fileId	TgBot::Audio
fileSize	TgBot::Audio
mimeType	TgBot::Audio
performer	TgBot::Audio
Ptr typedef	TgBot::Audio
title	TgBot::Audio

+Public Member Functions
	Api (const std::string &token)

User::Ptr	getMe () const

Message::Ptr	sendMessage (int64_t chatId, const std::string &text, bool disableWebPagePreview=false, int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), const std::string &parseMode="", bool disableNotification=false) const

Message::Ptr	forwardMessage (int64_t chatId, int64_t fromChatId, int32_t messageId, bool disableNotification=false) const

Message::Ptr	sendPhoto (int64_t chatId, const InputFile::Ptr &photo, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendPhoto (int64_t chatId, const std::string &photoId, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendAudio (int64_t chatId, const InputFile::Ptr &audio, const std::string &caption="", int32_t duration=0, const std::string &performer="", const std::string &title="", int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendAudio (int64_t chatId, const std::string &audioId, const std::string &caption="", int32_t duration=0, const std::string &performer="", const std::string &title="", int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendDocument (int64_t chatId, const InputFile::Ptr &document, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendDocument (int64_t chatId, const std::string &documentId, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendSticker (int64_t chatId, const InputFile::Ptr &sticker, int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendSticker (int64_t chatId, const std::string &stickerId, int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendVideo (int64_t chatId, const InputFile::Ptr &video, int32_t duration=0, int32_t width=0, int32_t height=0, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendVideo (int64_t chatId, const std::string &videoId, int32_t duration=0, int32_t width=0, int32_t height=0, const std::string &caption="", int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendVoice (int64_t chatId, const InputFile::Ptr &voice, const std::string &caption="", int duration=0, int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendVoice (int64_t chatId, const std::string &voiceId, const std::string &caption="", int duration=0, int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendLocation (int64_t chatId, float latitude, float longitude, int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr(), bool disableNotification=false) const

Message::Ptr	sendVenue (int64_t chatId, float latitude, float longitude, std::string title, std::string address, std::string foursquareId="", bool disableNotification=false, int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr()) const

Message::Ptr	sendContact (int64_t chatId, std::string phoneNumber, std::string firstName, std::string lastName="", bool disableNotification=false, int32_t replyToMessageId=0, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr()) const

void	sendChatAction (int64_t chatId, const std::string &action) const

UserProfilePhotos::Ptr	getUserProfilePhotos (int32_t userId, int32_t offset=0, int32_t limit=100) const

File::Ptr	getFile (int32_t fileId) const

bool	leaveChat (int64_t chatId) const

Chat::Ptr	getChat (int64_t chatId) const

std::vector< ChatMember::Ptr >	getChatAdministrators (int64_t chatId) const

int32_t	getChatMembersCount (int64_t chatId) const

ChatMember::Ptr	getChatMember (int64_t chatId, int32_t userId) const

bool	answerCallbackQuery (const std::string &callbackQueryId, const std::string &text="", bool showAlert=false, const std::string &url="", int32_t cacheTime=0) const

Message::Ptr	editMessageText (const std::string &text, int64_t chatId=0, int32_t messageId=0, const std::string &inlineMessageId="", const std::string &parseMode="", bool disableWebPagePreview=false, const GenericReply::Ptr &replyMarkup=GenericReply::Ptr()) const

Message::Ptr	editMessageCaption (int64_t chatId=0, int32_t messageId=0, const std::string &caption="", const std::string &inlineMessageId="", const GenericReply::Ptr &replyMarkup=GenericReply::Ptr()) const

Message::Ptr	editMessageReplyMarkup (int64_t chatId=0, int32_t messageId=0, const std::string &inlineMessageId="", const GenericReply::Ptr &replyMarkup=GenericReply::Ptr()) const

std::vector< Update::Ptr >	getUpdates (int32_t offset=0, int32_t limit=100, int32_t timeout=0, const StringArrayPtr &allowedUpdates=nullptr) const

void	setWebhook (const std::string &url="", const InputFile::Ptr &certificate=nullptr, int32_t maxConnection=40, const StringArrayPtr &allowedUpdates=nullptr) const

bool	deleteWebhook () const

WebhookInfo::Ptr	getWebhookInfo () const

bool	answerInlineQuery (const std::string &inlineQueryId, const std::vector< InlineQueryResult::Ptr > &results, int32_t cacheTime=300, bool isPersonal=false, const std::string &nextOffset="", const std::string &switchPmText="", const std::string &switchPmParameter="") const

bool	kickChatMember (int64_t chatId, int32_t userId) const

bool	unbanChatMember (int64_t chatId, int32_t userId) const

bool TgBot::Api::answerCallbackQuery	(	const std::string &	callbackQueryId,
		const std::string &	text = `""`,
		bool	showAlert = `false`,
		const std::string &	url = `""`,
		int32_t	cacheTime = `0`
	)		const

callbackQueryId	Unique identifier for the query to be answered
text	Optional Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
showAlert	Optional If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
url	Optional URL that will be opened by the user's client. If you have created a Game and accepted the conditions via , specify the URL that opens your game – note that this will only work if the query comes from a callback_game button
cacheTime	Optional The maximum amount of time in seconds that the result of the callback query may be cached client-side. Telegram apps will support caching starting in version 3.14. Defaults to 0.

bool TgBot::Api::answerInlineQuery	(	const std::string &	inlineQueryId,
		const std::vector< InlineQueryResult::Ptr > &	results,
		int32_t	cacheTime = `300`,
		bool	isPersonal = `false`,
		const std::string &	nextOffset = `""`,
		const std::string &	switchPmText = `""`,
		const std::string &	switchPmParameter = `""`
	)		const

inlineQueryId	Unique identifier for the answered query.
results	Array of results for the inline query.
cacheTime	The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300.
isPersonal	Pass True, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query.
nextOffset	Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don‘t support pagination. Offset length can’t exceed 64 bytes.
switchPmText	If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter
switchPmParameter	Parameter for the start message sent to the bot when user presses the switch button

Message::Ptr TgBot::Api::editMessageCaption	(	int64_t	chatId = `0`,
		int32_t	messageId = `0`,
		const std::string &	caption = `""`,
		const std::string &	inlineMessageId = `""`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`
	)		const

chatId	Optional Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format )
messageId	Optional Required if inline_message_id is not specified. Identifier of the sent message
caption	Optional New caption of the message
inlineMessageId	Optional Required if chat_id and message_id are not specified. Identifier of the inline message
replyMarkup	Optional A JSON-serialized object for an inline keyboard.

Message::Ptr TgBot::Api::editMessageReplyMarkup	(	int64_t	chatId = `0`,
		int32_t	messageId = `0`,
		const std::string &	inlineMessageId = `""`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`
	)		const

Message::Ptr TgBot::Api::editMessageText	(	const std::string &	text,
		int64_t	chatId = `0`,
		int32_t	messageId = `0`,
		const std::string &	inlineMessageId = `""`,
		const std::string &	parseMode = `""`,
		bool	disableWebPagePreview = `false`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`
	)		const

text	New text of the message
chatId	Optional Required if inline_message_id is not specified. Unique identifier for the target chat or username of the target channel (in the format )
messageId	Optional Required if inline_message_id is not specified. Identifier of the sent message
inlineMessageId	Optional Required if chat_id and message_id are not specified. Identifier of the inline message
parseMode	Optional Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
disableWebPagePreview	Optional Disables link previews for links in this message
replyMarkup	Optional A JSON-serialized object for an inline keyboard.

Message::Ptr TgBot::Api::forwardMessage	(	int64_t	chatId,
		int64_t	fromChatId,
		int32_t	messageId,
		bool	disableNotification = `false`
	)		const

chatId	Unique identifier for the target chat.
fromChatId	Unique identifier for the chat where the original message was sent — User or GroupChat id.
messageId	Unique message identifier.
disableNotification	Optional. Sends the message silenty.

ChatMember::Ptr TgBot::Api::getChatMember	(	int64_t	chatId,
		int32_t	userId
	)		const

+Friends
class	Bot

std::vector<Update::Ptr> TgBot::Api::getUpdates	(	int32_t	offset = `0`,
		int32_t	limit = `100`,
		int32_t	timeout = `0`,
		const StringArrayPtr &	allowedUpdates = `nullptr`
	)		const

offset	Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id.
limit	Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100.
timeout	Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling.
allowed_updates	Optional. List the types of updates you want your bot to receive. For example, specify [“message”, “edited_channel_post”, “callback_query”] to only receive updates of these types. See Update for a complete list of available update types. Specify an empty list to receive all updates regardless of type (default). If not specified, the previous setting will be used.

userId	Unique identifier of the target user.
offset	Optional. Sequential number of the first photo to be returned. By default, all photos are returned.
limit	Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.

chatId	Unique identifier for the target chat or username of the target supergroup or channel (in the format )
userId	Unique identifier of the target user

UserProfilePhotos::Ptr TgBot::Api::getUserProfilePhotos	(	int32_t	userId,
		int32_t	offset = `0`,
		int32_t	limit = `100`
	)		const

bool TgBot::Api::kickChatMember	(	int64_t	chatId,
		int32_t	userId
	)		const

chatId	Unique identifier for the target group.
userId	Unique identifier of the target user.

Message::Ptr TgBot::Api::sendAudio	(	int64_t	chatId,
		const InputFile::Ptr &	audio,
		const std::string &	caption = `""`,
		int32_t	duration = `0`,
		const std::string &	performer = `""`,
		const std::string &	title = `""`,
		int32_t	replyToMessageId = `0`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`,
		bool	disableNotification = `false`
	)		const

chatId	Unique identifier for the target chat.
audio	Audio to send.
caption	Audio caption, 0-200 characters
duration	Duration of sent audio in seconds.
performer	Performer
title	Track name
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
disableNotification	Optional. Sends the message silenty.

void TgBot::Api::sendChatAction	(	int64_t	chatId,
		const std::string &	action
	)		const

chatId	Unique identifier for the target chat.
action	Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_audio or upload_audio for audio files, upload_document for general files, find_location for location data.

Message::Ptr TgBot::Api::sendContact	(	int64_t	chatId,
		std::string	phoneNumber,
		std::string	firstName,
		std::string	lastName = `""`,
		bool	disableNotification = `false`,
		int32_t	replyToMessageId = `0`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`
	)		const

chatId	Unique identifier for the target chat.
phoneNumber	Contact's phone number.
firstName	Contact's first name.
lastName	Contact's last name.
disableNotification	Optional. Sends the message silenty.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.

+Public Member Functions

+Friends

Detailed Description

Constructor & Destructor Documentation

◆ Api()

Member Function Documentation

◆ answerCallbackQuery()

◆ answerInlineQuery()

◆ deleteWebhook()

◆ editMessageCaption()

◆ editMessageReplyMarkup()

◆ editMessageText()

◆ forwardMessage()

◆ getChat()

◆ getChatAdministrators()

◆ getChatMember()

◆ getChatMembersCount()

◆ getFile()

◆ getMe()

◆ getUpdates()

◆ getUserProfilePhotos()

◆ getWebhookInfo()

◆ kickChatMember()

◆ leaveChat()

◆ sendAudio() [1/2]

◆ sendAudio() [2/2]

◆ sendChatAction()

◆ sendContact()

◆ sendDocument() [1/2]

◆ sendDocument() [2/2]

◆ sendLocation()

◆ sendMessage()

◆ sendPhoto() [1/2]

◆ sendPhoto() [2/2]

◆ sendSticker() [1/2]

◆ sendSticker() [2/2]

◆ sendVenue()

◆ sendVideo() [1/2]

◆ sendVideo() [2/2]

◆ sendVoice() [1/2]

◆ sendVoice() [2/2]

◆ setWebhook()

◆ unbanChatMember()

Friends And Related Function Documentation

◆ Bot

+Public Types

+Public Attributes

Detailed Description

Member Typedef Documentation

◆ Ptr

Member Data Documentation

◆ requestContact

◆ requestLocation

◆ text

+Public Types

+Public Member Functions

+Public Attributes

+Static Public Attributes

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ InlineQueryResultVoice()

Member Data Documentation

◆ TYPE

◆ voiceDuration

◆ voiceUrl

+Public Member Functions

+Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Url()

Member Data Documentation

◆ fragment

◆ host

◆ path

◆ protocol

◆ query

+Classes

+Namespaces

Message::Ptr TgBot::Api::sendDocument	(	int64_t	chatId,
		const InputFile::Ptr &	document,
		const std::string &	caption = `""`,
		int32_t	replyToMessageId = `0`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`,
		bool	disableNotification = `false`
	)		const

chatId	Unique identifier for the target chat.
document	Document to send.
caption	Document caption (may also be used when resending documents by file_id), 0-200 characters
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
disableNotification	Optional. Sends the message silenty.

Message::Ptr TgBot::Api::sendLocation	(	int64_t	chatId,
		float	latitude,
		float	longitude,
		int32_t	replyToMessageId = `0`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`,
		bool	disableNotification = `false`
	)		const

chatId	Unique identifier for the target chat.
latitude	Latitude of location.
longitude	Longitude of location.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
disableNotification	Optional. Sends the message silenty.

Message::Ptr TgBot::Api::sendMessage	(	int64_t	chatId,
		const std::string &	text,
		bool	disableWebPagePreview = `false`,
		int32_t	replyToMessageId = `0`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`,
		const std::string &	parseMode = `""`,
		bool	disableNotification = `false`
	)		const

Message::Ptr TgBot::Api::sendPhoto	(	int64_t	chatId,
		const InputFile::Ptr &	photo,
		const std::string &	caption = `""`,
		int32_t	replyToMessageId = `0`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`,
		bool	disableNotification = `false`
	)		const

chatId	Unique identifier for the target chat.
photo	Photo to send.
caption	Optional. Photo caption.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
disableNotification	Optional. Sends the message silenty.

Message::Ptr TgBot::Api::sendSticker	(	int64_t	chatId,
		const InputFile::Ptr &	sticker,
		int32_t	replyToMessageId = `0`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`,
		bool	disableNotification = `false`
	)		const

chatId	Unique identifier for the target chat.
sticker	Sticker to send.
replyToMessageId	Optional. If the message is a reply, ID of the original message.
replyMarkup	Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
disableNotification	Optional. Sends the message silenty.

Message::Ptr TgBot::Api::sendVenue	(	int64_t	chatId,
		float	latitude,
		float	longitude,
		std::string	title,
		std::string	address,
		std::string	foursquareId = `""`,
		bool	disableNotification = `false`,
		int32_t	replyToMessageId = `0`,
		const GenericReply::Ptr &	replyMarkup = `GenericReply::Ptr()`
	)		const