This object represents a button to be shown above inline query results. More...

#include <InlineQueryResultsButton.h>

Public Types
typedef std::shared_ptr< InlineQueryResultsButton >	Ptr

Public Attributes
std::string	text
	Label text on the button.

WebAppInfo::Ptr	webApp
	Optional. Description of the Web App (https://core.telegram.org/bots/webapps) that will be launched when the user presses the button.

std::string	startParameter
	Optional. Deep-linking (https://core.telegram.org/bots/features#deep-linking) parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.

Detailed Description

This object represents a button to be shown above inline query results.

You must use exactly one of the optional fields.

Definition at line 18 of file InlineQueryResultsButton.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<InlineQueryResultsButton> TgBot::InlineQueryResultsButton::Ptr

Definition at line 20 of file InlineQueryResultsButton.h.

Member Data Documentation

◆ startParameter

std::string TgBot::InlineQueryResultsButton::startParameter

Optional. Deep-linking (https://core.telegram.org/bots/features#deep-linking) parameter for the /start message sent to the bot when a user presses the button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed.

Example: An inline bot that sends YouTube videos can ask the user to connect the bot to their YouTube account to adapt search results accordingly. To do this, it displays a 'Connect your YouTube account' button above the results, or even before showing any. The user presses the button, switches to a private chat with the bot and, in doing so, passes a start parameter that instructs the bot to return an OAuth link. Once done, the bot can offer a switchInline button so that the user can easily return to the chat where they wanted to use the bot's inline capabilities.

Definition at line 42 of file InlineQueryResultsButton.h.

◆ text

std::string TgBot::InlineQueryResultsButton::text

Label text on the button.

Definition at line 25 of file InlineQueryResultsButton.h.

◆ webApp

WebAppInfo::Ptr TgBot::InlineQueryResultsButton::webApp

Optional. Description of the Web App (https://core.telegram.org/bots/webapps) that will be launched when the user presses the button.

The Web App will be able to switch back to the inline mode using the method switchInlineQuery (https://core.telegram.org/bots/webapps#initializing-mini-apps) inside the Web App.

Definition at line 32 of file InlineQueryResultsButton.h.

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

include/tgbot/types/InlineQueryResultsButton.h

Public Types