KeyboardButton

data class KeyboardButton(text: String, requestContact: Boolean, requestLocation: Boolean, requestPoll: KeyboardButtonPollType?)

This object represents one button of the reply keyboard. For simple text buttons String can be used instead of this object to specify text of the button. Optional fields request_contact, request_location, and request_poll are mutually exclusive. Note: request_contact and request_location options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message. Note: request_poll option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message.

Parameters

text

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

requestContact

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

requestLocation

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

requestPoll

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

Constructors

KeyboardButton

common

fun KeyboardButton(text: String, requestContact: Boolean = false, requestLocation: Boolean = false, requestPoll: KeyboardButtonPollType? = null)

Text of the button.

Functions

component1

common

operator fun component1(): String

component2

common

operator fun component2(): Boolean

component3

common

operator fun component3(): Boolean

component4

common

operator fun component4(): KeyboardButtonPollType?

copy

common

fun copy(text: String, requestContact: Boolean = false, requestLocation: Boolean = false, requestPoll: KeyboardButtonPollType? = null): KeyboardButton

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

toString

common

open override fun toString(): String

Properties

requestContact

common

val requestContact: Boolean = false

Optional.

requestLocation

common

val requestLocation: Boolean = false

Optional.

requestPoll

common

val requestPoll: KeyboardButtonPollType? = null

Optional.

text

common

val text: String

Text of the button.