Telegram Bot/eu.vendeli.tgbot.types.keyboard/InlineKeyboardButton

InlineKeyboardButton

@Serializable

data class InlineKeyboardButton(val text: String, val url: String? = null, val callbackData: String? = null, val webApp: WebAppInfo? = null, val loginUrl: LoginUrl? = null, val switchInlineQuery: String? = null, val switchInlineQueryCurrentChat: String? = null, val switchInlineQueryChosenChat: SwitchInlineQueryChosenChat? = null, val copyText: CopyTextButton? = null, val callbackGame: CallbackGame? = null, val pay: Boolean? = null) : Button

This object represents one button of an inline keyboard. Exactly one of the optional fields must be used to specify type of the button.

Api reference

Constructors

InlineKeyboardButton

constructor(text: String, url: String? = null, callbackData: String? = null, webApp: WebAppInfo? = null, loginUrl: LoginUrl? = null, switchInlineQuery: String? = null, switchInlineQueryCurrentChat: String? = null, switchInlineQueryChosenChat: SwitchInlineQueryChosenChat? = null, copyText: CopyTextButton? = null, callbackGame: CallbackGame? = null, pay: Boolean? = null)

Properties

callbackData

val callbackData: String? = null

Optional. Data to be sent in a callback query to the bot when the button is pressed, 1-64 bytes

callbackGame

val callbackGame: CallbackGame? = null

Optional. Description of the game that will be launched when the user presses the button. NOTE: This type of button must always be the first button in the first row.

copyText

val copyText: CopyTextButton? = null

Optional. Description of the button that copies the specified text to the clipboard.

loginUrl

val loginUrl: LoginUrl? = null

Optional. An HTTPS URL used to automatically authorize the user. Can be used as a replacement for the Telegram Login Widget.

pay

val pay: Boolean? = null

Optional. Specify True, to send a Pay button. Substrings "⭐" and "XTR" in the buttons's text will be replaced with a Telegram Star icon. NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.

switchInlineQuery

val switchInlineQuery: String? = null

Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot's username and the specified inline query in the input field. May be empty, in which case just the bot's username will be inserted. Not supported for messages sent on behalf of a Telegram Business account.

switchInlineQueryChosenChat

val switchInlineQueryChosenChat: SwitchInlineQueryChosenChat? = null

Optional. If set, pressing the button will prompt the user to select one of their chats of the specified type, open that chat and insert the bot's username and the specified inline query in the input field. Not supported for messages sent on behalf of a Telegram Business account.

switchInlineQueryCurrentChat

val switchInlineQueryCurrentChat: String? = null

Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. May be empty, in which case only the bot's username will be inserted. This offers a quick way for the user to open your bot in inline mode in the same chat - good for selecting something from multiple options. Not supported in channels and for messages sent on behalf of a Telegram Business account.

text

val text: String

Label text on the button

url

val url: String? = null

Optional. HTTP or tg:// URL to be opened when the button is pressed. Links tg://user?id= can be used to mention a user by their identifier without using a username, if this is allowed by their privacy settings.

webApp

val webApp: WebAppInfo? = null

Optional. Description of the Web App that will be launched when the user presses the button. The Web App will be able to send an arbitrary message on behalf of the user using the method answerWebAppQuery. Available only in private chats between a user and the bot. Not supported for messages sent on behalf of a Telegram Business account.