This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present. More...

#include <CallbackQuery.hpp>

Public Member Functions
	CallbackQuery ()=default

	CallbackQuery (const nl::json &json)

nl::json	toJson () const
	Serializes this object to JSON.

void	fromJson (const nl::json &json)
	Deserializes this object from JSON.

Public Attributes
std::string	id
	Unique identifier for this query.

Ptr< User >	from
	Sender.

MaybeInaccessibleMessage	message
	Optional. Message sent by the bot with the callback button that originated the query.

std::string	inlineMessageId
	Optional. Identifier of the message sent via the bot in inline mode, that originated the query.

std::string	chatInstance
	Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.

std::string	data
	Optional. Data associated with the callback button.

std::string	gameShortName
	Optional. Short name of a Game to be returned, serves as the unique identifier for the game.

Detailed Description

This object represents an incoming callback query from a callback button in an inline keyboard. If the button that originated the query was attached to a message sent by the bot, the field message will be present. If the button was attached to a message sent via the bot (in inline mode), the field inline_message_id will be present. Exactly one of the fields data or game_short_name will be present.

Note: NOTE: After the user presses a callback button, Telegram clients will display a progress bar until you call answerCallbackQuery. It is, therefore, necessary to react by calling answerCallbackQuery even if no notification to the user is needed (e.g., without specifying any of the optional parameters).

https://core.telegram.org/bots/api#callbackquery

Definition at line 22 of file CallbackQuery.hpp.

Constructor & Destructor Documentation

◆ CallbackQuery() [1/2]

tgbotxx::CallbackQuery::CallbackQuery ( )

default

◆ CallbackQuery() [2/2]

tgbotxx::CallbackQuery::CallbackQuery ( const nl::json & json )

explicit

Member Function Documentation

◆ fromJson()

void tgbotxx::CallbackQuery::fromJson ( const nl::json & json )

Deserializes this object from JSON.

◆ toJson()

nl::json tgbotxx::CallbackQuery::toJson ( ) const

Serializes this object to JSON.

Returns: JSON representation of this object

Member Data Documentation

◆ chatInstance

std::string tgbotxx::CallbackQuery::chatInstance

Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.

Definition at line 40 of file CallbackQuery.hpp.

◆ data

std::string tgbotxx::CallbackQuery::data

Optional. Data associated with the callback button.

Note: Be aware that the message originated the query can contain no callback buttons with this data.

Definition at line 44 of file CallbackQuery.hpp.

◆ from

Ptr<User> tgbotxx::CallbackQuery::from

Sender.

Definition at line 30 of file CallbackQuery.hpp.

◆ gameShortName

std::string tgbotxx::CallbackQuery::gameShortName

Optional. Short name of a Game to be returned, serves as the unique identifier for the game.

Definition at line 47 of file CallbackQuery.hpp.

◆ id

std::string tgbotxx::CallbackQuery::id

Unique identifier for this query.

Definition at line 27 of file CallbackQuery.hpp.

◆ inlineMessageId

std::string tgbotxx::CallbackQuery::inlineMessageId

Optional. Identifier of the message sent via the bot in inline mode, that originated the query.

Definition at line 36 of file CallbackQuery.hpp.

◆ message

MaybeInaccessibleMessage tgbotxx::CallbackQuery::message

Optional. Message sent by the bot with the callback button that originated the query.

Definition at line 33 of file CallbackQuery.hpp.

The documentation for this struct was generated from the following file:

include/tgbotxx/objects/CallbackQuery.hpp

Public Member Functions

Public Attributes