InlineKeyboardButton

data class InlineKeyboardButton(text: String, url: String?, loginUrl: LoginUrl?, callbackData: String?, switchInlineQuery: String?, switchInlineQueryCurrentChat: String?, callbackGame: CallbackGame?, pay: Boolean)

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

Parameters

text

Label text on the button

url

Optional. HTTP or tg:// url to be opened when button is pressed

loginUrl

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

callbackData

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

switchInlineQuery

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. Can be empty, in which case just the bot's username will be inserted. Note: This offers an easy way for users to start using your bot in inline mode when they are currently in a private chat with it. Especially useful when combined with switch_pm… actions – in this case the user will be automatically returned to the chat they switched from, skipping the chat selection screen.

switchInlineQueryCurrentChat

Optional. If set, pressing the button will insert the bot's username and the specified inline query in the current chat's input field. Can 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.

callbackGame

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.

pay

Optional. Specify True, to send a Pay button. NOTE: This type of button must always be the first button in the first row.

Constructors

InlineKeyboardButton
Link copied to clipboard
common
fun InlineKeyboardButton(text: String, url: String? = null, loginUrl: LoginUrl? = null, callbackData: String? = null, switchInlineQuery: String? = null, switchInlineQueryCurrentChat: String? = null, callbackGame: CallbackGame? = null, pay: Boolean = false)
Label text on the button

Functions

component1
Link copied to clipboard
common
operator fun component1(): String
component2
Link copied to clipboard
common
operator fun component2(): String?
component3
Link copied to clipboard
common
operator fun component3(): LoginUrl?
component4
Link copied to clipboard
common
operator fun component4(): String?
component5
Link copied to clipboard
common
operator fun component5(): String?
component6
Link copied to clipboard
common
operator fun component6(): String?
component7
Link copied to clipboard
common
operator fun component7(): CallbackGame?
component8
Link copied to clipboard
common
operator fun component8(): Boolean
copy
Link copied to clipboard
common
fun copy(text: String, url: String? = null, loginUrl: LoginUrl? = null, callbackData: String? = null, switchInlineQuery: String? = null, switchInlineQueryCurrentChat: String? = null, callbackGame: CallbackGame? = null, pay: Boolean = false): InlineKeyboardButton
equals
Link copied to clipboard
common
open operator override fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
common
open override fun hashCode(): Int
toString
Link copied to clipboard
common
open override fun toString(): String

Properties

callbackData
Link copied to clipboard
common
val callbackData: String? = null
Optional.
callbackGame
Link copied to clipboard
common
val callbackGame: CallbackGame? = null
Optional.
loginUrl
Link copied to clipboard
common
val loginUrl: LoginUrl? = null
Optional.
pay
Link copied to clipboard
common
val pay: Boolean = false
Optional.
switchInlineQuery
Link copied to clipboard
common
val switchInlineQuery: String? = null
Optional.
switchInlineQueryCurrentChat
Link copied to clipboard
common
val switchInlineQueryCurrentChat: String? = null
Optional.
text
Link copied to clipboard
common
val text: String
Label text on the button
url
Link copied to clipboard
common
val url: String? = null
Optional.