mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2025-01-19 15:43:24 +01:00
26ce9bb343
* Clarify InlineKeyboardButton callback-data docstring Fixes #1267 * Improve documentation slightly - Prettier changelog - Link to examples on frontpage - Link to wiki on frontpage - Put telegram.ext in own sidebar thingy * Improve ext.Filters documentation Superseeds #1089 - Remove `:obj:Filter` as it's pretty obvious that it's a filter since it's in this module. It also made the html output about 1/3 times longer to scroll through. - Add an __all__ to reorder so Filter is at the top instead of BaseFilter - Add a proper docstring for document that documents the attributes (this is the #1089 part) - Also fix a couple of grammar errors. * Fix indentation in telegram.rst * Add `git describe --long --tags` to the `python -m telegram` output * Use admonition for examples to make them *pop* better * Remove automodule telegram Sphinx was whining a lot and it doesn't actually seem to be needed in any way? * Fix Filters.document docstring per CR Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Fix spelling error in docs index Co-Authored-By: jsmnbom <jsmnbom@gmail.com> * Setting needs_sphinx to 1.7.9 so we don't have more issues with incongruent versions * Fixed last warnings * Make pre-commit happy
89 lines
4.6 KiB
Python
89 lines
4.6 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2018
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
"""This module contains an object that represents a Telegram InlineKeyboardButton."""
|
|
|
|
from telegram import TelegramObject
|
|
|
|
|
|
class InlineKeyboardButton(TelegramObject):
|
|
"""This object represents one button of an inline keyboard.
|
|
|
|
Note:
|
|
You must use exactly one of the optional fields. Mind that :attr:`callback_game` is not
|
|
working as expected. Putting a game short name in it might, but is not guaranteed to work.
|
|
|
|
Attributes:
|
|
text (:obj:`str`): Label text on the button.
|
|
url (:obj:`str`): Optional. HTTP url to be opened when button is pressed.
|
|
callback_data (:obj:`str`): Optional. Data to be sent in a callback query to the bot when
|
|
button is pressed, UTF-8 1-64 bytes.
|
|
switch_inline_query (:obj:`str`): Optional. 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.
|
|
switch_inline_query_current_chat (:obj:`str`): Optional. Will insert the bot's username and
|
|
the specified inline query in the current chat's input field.
|
|
callback_game (:class:`telegram.CallbackGame`): Optional. Description of the game that will
|
|
be launched when the user presses the button.
|
|
pay (:obj:`bool`): Optional. Specify True, to send a Pay button.
|
|
|
|
Args:
|
|
text (:obj:`str`): Label text on the button.
|
|
url (:obj:`str`): HTTP url to be opened when button is pressed.
|
|
callback_data (:obj:`str`, optional): Data to be sent in a callback query to the bot when
|
|
button is pressed, 1-64 UTF-8 bytes.
|
|
switch_inline_query (:obj:`str`, 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. 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.
|
|
switch_inline_query_current_chat (:obj:`str`, 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.
|
|
callback_game (:class:`telegram.CallbackGame`, optional): Description of the game that will
|
|
be launched when the user presses the button. This type of button must always be
|
|
the ``first`` button in the first row.
|
|
pay (:obj:`bool`, optional): Specify True, to send a Pay button. This type of button must
|
|
always be the ``first`` button in the first row.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
text,
|
|
url=None,
|
|
callback_data=None,
|
|
switch_inline_query=None,
|
|
switch_inline_query_current_chat=None,
|
|
callback_game=None,
|
|
pay=None,
|
|
**kwargs):
|
|
# Required
|
|
self.text = text
|
|
|
|
# Optionals
|
|
self.url = url
|
|
self.callback_data = callback_data
|
|
self.switch_inline_query = switch_inline_query
|
|
self.switch_inline_query_current_chat = switch_inline_query_current_chat
|
|
self.callback_game = callback_game
|
|
self.pay = pay
|