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

KeyboardButton

@Serializable
data class KeyboardButton(val text: String, val requestUsers: KeyboardButtonRequestUsers? = null, val requestChat: KeyboardButtonRequestChat? = null, val requestContact: Boolean? = null, val requestLocation: Boolean? = null, val requestPoll: KeyboardButtonPollType? = null, val webApp: WebAppInfo? = null) : Button

This object represents one button of the reply keyboard. At most one of the optional fields must be used to specify type of the button. For simple text buttons, String can be used instead of this object to specify the button text. Note: request_users and request_chat options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message.

Api reference

Constructors

Link copied to clipboard
constructor(text: String, requestUsers: KeyboardButtonRequestUsers? = null, requestChat: KeyboardButtonRequestChat? = null, requestContact: Boolean? = null, requestLocation: Boolean? = null, requestPoll: KeyboardButtonPollType? = null, webApp: WebAppInfo? = null)

Properties

Link copied to clipboard
val requestChat: KeyboardButtonRequestChat? = null

Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will send its identifier to the bot in a "chat_shared" service message. Available in private chats only.

Link copied to clipboard
val requestContact: Boolean? = null

Optional. If True, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only.

Link copied to clipboard
val requestLocation: Boolean? = null

Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.

Link copied to clipboard
val requestPoll: KeyboardButtonPollType? = null

Optional. If specified, the user will be asked to create a poll and send it to the bot when the button is pressed. Available in private chats only.

Link copied to clipboard
val requestUsers: KeyboardButtonRequestUsers? = null

Optional. If specified, pressing the button will open a list of suitable users. Identifiers of selected users will be sent to the bot in a "users_shared" service message. Available in private chats only.

Link copied to clipboard
val text: String

Text of the button. If none of the optional fields are used, it will be sent as a message when the button is pressed

Link copied to clipboard
val webApp: WebAppInfo? = null

Optional. If specified, the described Web App will be launched when the button is pressed. The Web App will be able to send a "web_app_data" service message. Available in private chats only.