simbot-component-telegram-type/love.forte.simbot.telegram.type/InlineKeyboardButton

InlineKeyboardButton

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 callbackGame: CallbackGame? = null, val pay: Boolean? = null)(source)

This object represents one button of an inline keyboard. You must use exactly one of the optional fields.

(auto-generated)

Author

ForteScarlet

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, callbackGame: CallbackGame? = null, pay: Boolean? = null)

Properties

callbackData

@SerialName(value = "callback_data")

val callbackData: String? = null

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

callbackGame

@SerialName(value = "callback_game")

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.

loginUrl

@SerialName(value = "login_url")

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. NOTE: This type of button must always be the first button in the first row and can only be used in invoice messages.

switchInlineQuery

@SerialName(value = "switch_inline_query")

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.

switchInlineQueryChosenChat

@SerialName(value = "switch_inline_query_chosen_chat")

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

switchInlineQueryCurrentChat

@SerialName(value = "switch_inline_query_current_chat")

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.

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

@SerialName(value = "web_app")

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.