U dd#@sdZddlmZmZddlmZddlmZmZddl m Z ddl m Z ddl mZddlmZdd lmZer|dd lmZGd d d e Zd S)zIThis module contains an object that represents a Telegram KeyboardButton.) TYPE_CHECKINGOptional)KeyboardButtonPollType)KeyboardButtonRequestChatKeyboardButtonRequestUser)TelegramObject)JSONDict)warn) WebAppInfo)PTBDeprecationWarning)Botc seZdZdZdZdddeeeeee e e dfddZ e edfd d Zed fd d Zeee deddfdd ZZS)KeyboardButtona This object represents one button of the reply keyboard. For simple text buttons, :obj:`str` 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 :attr:`text`, :attr:`request_contact`, :attr:`request_location`, :attr:`request_poll`, :attr:`web_app`, :attr:`request_user` and :attr:`request_chat` are equal. Note: * Optional fields are mutually exclusive. * :attr:`request_contact` and :attr:`request_location` options will only work in Telegram versions released after 9 April, 2016. Older clients will display unsupported message. * :attr:`request_poll` option will only work in Telegram versions released after 23 January, 2020. Older clients will display unsupported message. * :attr:`web_app` option will only work in Telegram versions released after 16 April, 2022. Older clients will display unsupported message. * :attr:`request_user` and :attr:`request_chat` options will only work in Telegram versions released after 3 February, 2023. Older clients will display unsupported message. .. versionchanged:: 20.0 :attr:`web_app` is considered as well when comparing objects of this type in terms of equality. .. deprecated:: 20.1 :paramref:`request_user` and :paramref:`request_chat` will be considered as well when comparing objects of this type in terms of equality in V21. Args: text (:obj:`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 (:obj:`bool`, optional): If :obj:`True`, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only. request_location (:obj:`bool`, optional): If :obj:`True`, the user's current location will be sent when the button is pressed. Available in private chats only. request_poll (:class:`~telegram.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. web_app (:class:`~telegram.WebAppInfo`, optional): If specified, the described `Web App `_ will be launched when the button is pressed. The Web App will be able to send a :attr:`Message.web_app_data` service message. Available in private chats only. .. versionadded:: 20.0 request_user (:class:`KeyboardButtonRequestUser`, optional): If specified, pressing the button will open a list of suitable users. Tapping on any user will send its identifier to the bot in a :attr:`telegram.Message.user_shared` service message. Available in private chats only. .. versionadded:: 20.1 request_chat (:class:`KeyboardButtonRequestChat`, 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 :attr:`telegram.Message.chat_shared` service message. Available in private chats only. .. versionadded:: 20.1 Attributes: text (:obj:`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 (:obj:`bool`): Optional. If :obj:`True`, the user's phone number will be sent as a contact when the button is pressed. Available in private chats only. request_location (:obj:`bool`): Optional. If :obj:`True`, the user's current location will be sent when the button is pressed. Available in private chats only. request_poll (:class:`~telegram.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. web_app (:class:`~telegram.WebAppInfo`): Optional. If specified, the described `Web App `_ will be launched when the button is pressed. The Web App will be able to send a :attr:`Message.web_app_data` service message. Available in private chats only. .. versionadded:: 20.0 request_user (:class:`KeyboardButtonRequestUser`): Optional. If specified, pressing the button will open a list of suitable users. Tapping on any user will send its identifier to the bot in a :attr:`telegram.Message.user_shared` service message. Available in private chats only. .. versionadded:: 20.1 request_chat (:class:`KeyboardButtonRequestChat`): 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 :attr:`telegram.Message.chat_shared` service message. Available in private chats only. .. versionadded:: 20.1 )request_locationrequest_contact request_polltextweb_app request_user request_chatN api_kwargs)rrrrrrrrc s^tj|d||_||_||_||_||_||_||_|j|j|j|j|jf|_ | dS)Nr) super__init__rrrrrrrZ _id_attrsZ_freeze) selfrrrrrrrr __class__s