telegram.KeyboardButton¶
-
class
telegram.
KeyboardButton
(text, request_contact=None, request_location=None, request_poll=None, **_kwargs)¶ Bases:
telegram.base.TelegramObject
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.
Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their
text
,request_contact
,request_location
andrequest_poll
are equal.Note
Optional fields are mutually exclusive.
request_contact
andrequest_location
options will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.request_poll
option will only work in Telegram versions released after 23 January, 2020. Older clients will receive unsupported message.
- Parameters
text (
str
) – Text of the button. If none of the optional fields are used, it will be sent to the bot as a message when the button is pressed.request_contact (
bool
, optional) – IfTrue
, the user’s phone number will be sent as a contact when the button is pressed. Available in private chats only.request_location (
bool
, optional) – IfTrue
, the user’s current location will be sent when the button is pressed. Available in private chats only.request_poll (
KeyboardButtonPollType
, 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.
-
text
¶ Text of the button.
- Type
str
-
request_contact
¶ Optional. The user’s phone number will be sent.
- Type
bool
-
request_location
¶ Optional. The user’s current location will be sent.
- Type
bool
-
request_poll
¶ Optional. If the user should create a poll.