2016-04-12 06:23:52 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2021-01-03 06:10:24 +01:00
|
|
|
# Copyright (C) 2015-2021
|
2016-04-12 06:23:52 +02:00
|
|
|
# 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/].
|
2020-10-31 16:33:34 +01:00
|
|
|
# pylint: disable=W0622
|
2016-10-17 00:22:40 +02:00
|
|
|
"""This module contains an object that represents a Telegram CallbackQuery"""
|
2021-01-07 21:27:51 +01:00
|
|
|
from typing import TYPE_CHECKING, Any, List, Optional, Union, Tuple, ClassVar
|
2016-04-14 02:10:04 +02:00
|
|
|
|
2021-01-07 21:27:51 +01:00
|
|
|
from telegram import Message, TelegramObject, User, Location, ReplyMarkup, constants
|
2020-10-06 19:28:40 +02:00
|
|
|
from telegram.utils.types import JSONDict
|
|
|
|
|
|
|
|
if TYPE_CHECKING:
|
2020-12-30 13:41:07 +01:00
|
|
|
from telegram import (
|
|
|
|
Bot,
|
|
|
|
GameHighScore,
|
|
|
|
InlineKeyboardMarkup,
|
|
|
|
MessageId,
|
|
|
|
InputMedia,
|
|
|
|
MessageEntity,
|
|
|
|
)
|
2020-10-06 19:28:40 +02:00
|
|
|
|
2016-04-14 02:10:04 +02:00
|
|
|
|
|
|
|
class CallbackQuery(TelegramObject):
|
2017-07-23 22:33:08 +02:00
|
|
|
"""
|
|
|
|
This object represents an incoming callback query from a callback button in an inline keyboard.
|
|
|
|
|
|
|
|
If the button that originated the query was attached to a message sent by the bot, the field
|
|
|
|
:attr:`message` will be present. If the button was attached to a message sent via the bot (in
|
|
|
|
inline mode), the field :attr:`inline_message_id` will be present.
|
|
|
|
|
2020-07-14 21:33:56 +02:00
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
|
|
considered equal, if their :attr:`id` is equal.
|
|
|
|
|
2017-07-23 22:33:08 +02:00
|
|
|
Note:
|
2017-07-28 16:41:25 +02:00
|
|
|
* In Python `from` is a reserved word, use `from_user` instead.
|
2017-08-02 04:56:07 +02:00
|
|
|
* Exactly one of the fields :attr:`data` or :attr:`game_short_name` will be present.
|
2020-12-30 15:59:50 +01:00
|
|
|
* After the user presses an inline button, Telegram clients will display a progress bar
|
|
|
|
until you call :attr:`answer`. It is, therefore, necessary to react
|
|
|
|
by calling :attr:`telegram.Bot.answer_callback_query` even if no notification to the user
|
|
|
|
is needed (e.g., without specifying any of the optional parameters).
|
2017-07-23 22:33:08 +02:00
|
|
|
|
|
|
|
Args:
|
|
|
|
id (:obj:`str`): Unique identifier for this query.
|
2017-07-28 16:41:25 +02:00
|
|
|
from_user (:class:`telegram.User`): Sender.
|
2020-03-28 15:52:37 +01:00
|
|
|
chat_instance (:obj:`str`): Global identifier, uniquely corresponding to the chat to which
|
|
|
|
the message with the callback button was sent. Useful for high scores in games.
|
2017-07-23 22:33:08 +02:00
|
|
|
message (:class:`telegram.Message`, optional): Message with the callback button that
|
|
|
|
originated the query. Note that message content and message date will not be available
|
|
|
|
if the message is too old.
|
|
|
|
data (:obj:`str`, optional): Data associated with the callback button. Be aware that a bad
|
|
|
|
client can send arbitrary data in this field.
|
2020-03-28 15:52:37 +01:00
|
|
|
inline_message_id (:obj:`str`, optional): Identifier of the message sent via the bot in
|
|
|
|
inline mode, that originated the query.
|
2017-07-23 22:33:08 +02:00
|
|
|
game_short_name (:obj:`str`, optional): Short name of a Game to be returned, serves as
|
|
|
|
the unique identifier for the game
|
2020-03-28 15:52:37 +01:00
|
|
|
bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods.
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2020-12-30 15:59:50 +01:00
|
|
|
Attributes:
|
|
|
|
id (:obj:`str`): Unique identifier for this query.
|
|
|
|
from_user (:class:`telegram.User`): Sender.
|
|
|
|
chat_instance (:obj:`str`): Global identifier, uniquely corresponding to the chat to which
|
|
|
|
the message with the callback button was sent.
|
|
|
|
message (:class:`telegram.Message`): Optional. Message with the callback button that
|
|
|
|
originated the query.
|
|
|
|
data (:obj:`str`): Optional. Data associated with the callback button.
|
|
|
|
inline_message_id (:obj:`str`): Optional. Identifier of the message sent via the bot in
|
|
|
|
inline mode, that originated the query.
|
|
|
|
game_short_name (:obj:`str`): Optional. Short name of a Game to be returned.
|
|
|
|
bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2017-07-23 22:33:08 +02:00
|
|
|
"""
|
2016-04-14 02:10:04 +02:00
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
def __init__(
|
2020-11-05 18:12:01 +01:00
|
|
|
self,
|
2020-10-31 16:33:34 +01:00
|
|
|
id: str, # pylint: disable=W0622
|
2020-10-09 17:22:07 +02:00
|
|
|
from_user: User,
|
|
|
|
chat_instance: str,
|
|
|
|
message: Message = None,
|
|
|
|
data: str = None,
|
|
|
|
inline_message_id: str = None,
|
|
|
|
game_short_name: str = None,
|
|
|
|
bot: 'Bot' = None,
|
2020-11-05 18:12:01 +01:00
|
|
|
**_kwargs: Any,
|
2020-10-09 17:22:07 +02:00
|
|
|
):
|
2016-04-14 02:10:04 +02:00
|
|
|
# Required
|
2020-10-31 16:33:34 +01:00
|
|
|
self.id = id # pylint: disable=C0103
|
2016-04-14 02:10:04 +02:00
|
|
|
self.from_user = from_user
|
2016-10-03 21:01:38 +02:00
|
|
|
self.chat_instance = chat_instance
|
2016-04-14 02:10:04 +02:00
|
|
|
# Optionals
|
2016-10-16 16:24:13 +02:00
|
|
|
self.message = message
|
2016-10-19 12:35:50 +02:00
|
|
|
self.data = data
|
2016-10-16 16:24:13 +02:00
|
|
|
self.inline_message_id = inline_message_id
|
2016-10-19 12:35:50 +02:00
|
|
|
self.game_short_name = game_short_name
|
2016-04-14 02:10:04 +02:00
|
|
|
|
2016-09-20 06:36:55 +02:00
|
|
|
self.bot = bot
|
|
|
|
|
2017-08-11 23:58:41 +02:00
|
|
|
self._id_attrs = (self.id,)
|
2017-08-01 22:07:12 +02:00
|
|
|
|
2017-07-23 21:14:38 +02:00
|
|
|
@classmethod
|
2020-10-06 19:28:40 +02:00
|
|
|
def de_json(cls, data: Optional[JSONDict], bot: 'Bot') -> Optional['CallbackQuery']:
|
|
|
|
data = cls.parse_data(data)
|
|
|
|
|
2016-04-14 02:10:04 +02:00
|
|
|
if not data:
|
|
|
|
return None
|
|
|
|
|
2016-09-20 06:36:55 +02:00
|
|
|
data['from_user'] = User.de_json(data.get('from'), bot)
|
2020-07-19 17:47:26 +02:00
|
|
|
data['message'] = Message.de_json(data.get('message'), bot)
|
2016-04-14 02:10:04 +02:00
|
|
|
|
2017-07-23 21:14:38 +02:00
|
|
|
return cls(bot=bot, **data)
|
2016-05-30 15:59:45 +02:00
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
def answer(
|
|
|
|
self,
|
|
|
|
text: str = None,
|
|
|
|
show_alert: bool = False,
|
|
|
|
url: str = None,
|
|
|
|
cache_time: int = None,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
) -> bool:
|
2017-09-01 08:43:08 +02:00
|
|
|
"""Shortcut for::
|
2017-07-23 22:33:08 +02:00
|
|
|
|
|
|
|
bot.answer_callback_query(update.callback_query.id, *args, **kwargs)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.answer_callback_query`.
|
|
|
|
|
2017-07-23 22:33:08 +02:00
|
|
|
Returns:
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
:obj:`bool`: On success, :obj:`True` is returned.
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2017-09-01 08:43:08 +02:00
|
|
|
"""
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.bot.answer_callback_query(
|
|
|
|
callback_query_id=self.id,
|
|
|
|
text=text,
|
|
|
|
show_alert=show_alert,
|
|
|
|
url=url,
|
|
|
|
cache_time=cache_time,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|
|
|
|
|
|
|
|
def edit_message_text(
|
|
|
|
self,
|
|
|
|
text: str,
|
|
|
|
parse_mode: str = None,
|
|
|
|
disable_web_page_preview: bool = None,
|
|
|
|
reply_markup: 'InlineKeyboardMarkup' = None,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
|
|
|
|
) -> Union[Message, bool]:
|
2017-09-01 08:43:08 +02:00
|
|
|
"""Shortcut for either::
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2020-11-05 17:11:35 +01:00
|
|
|
update.callback_query.message.edit_text(text, *args, **kwargs)
|
2017-07-23 22:33:08 +02:00
|
|
|
|
|
|
|
or::
|
|
|
|
|
2019-02-13 11:37:13 +01:00
|
|
|
bot.edit_message_text(text, inline_message_id=update.callback_query.inline_message_id,
|
2017-07-23 22:33:08 +02:00
|
|
|
*args, **kwargs)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.edit_message_text`.
|
|
|
|
|
2017-07-23 22:33:08 +02:00
|
|
|
Returns:
|
|
|
|
:class:`telegram.Message`: On success, if edited message is sent by the bot, the
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
edited Message is returned, otherwise :obj:`True` is returned.
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2017-09-01 08:43:08 +02:00
|
|
|
"""
|
2016-09-25 16:03:06 +02:00
|
|
|
if self.inline_message_id:
|
2020-10-09 17:22:07 +02:00
|
|
|
return self.bot.edit_message_text(
|
2020-12-30 13:41:07 +01:00
|
|
|
inline_message_id=self.inline_message_id,
|
|
|
|
text=text,
|
|
|
|
parse_mode=parse_mode,
|
|
|
|
disable_web_page_preview=disable_web_page_preview,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
entities=entities,
|
|
|
|
chat_id=None,
|
|
|
|
message_id=None,
|
2020-10-09 17:22:07 +02:00
|
|
|
)
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.edit_text(
|
|
|
|
text=text,
|
|
|
|
parse_mode=parse_mode,
|
|
|
|
disable_web_page_preview=disable_web_page_preview,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
entities=entities,
|
|
|
|
)
|
2016-09-25 16:03:06 +02:00
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
def edit_message_caption(
|
2020-12-30 13:41:07 +01:00
|
|
|
self,
|
|
|
|
caption: str = None,
|
|
|
|
reply_markup: 'InlineKeyboardMarkup' = None,
|
|
|
|
timeout: float = None,
|
|
|
|
parse_mode: str = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
caption_entities: Union[List['MessageEntity'], Tuple['MessageEntity', ...]] = None,
|
2020-10-09 17:22:07 +02:00
|
|
|
) -> Union[Message, bool]:
|
2017-09-01 08:43:08 +02:00
|
|
|
"""Shortcut for either::
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2020-11-05 17:11:35 +01:00
|
|
|
update.callback_query.message.edit_caption(caption, *args, **kwargs)
|
2017-07-23 22:33:08 +02:00
|
|
|
|
|
|
|
or::
|
|
|
|
|
2019-02-13 11:37:13 +01:00
|
|
|
bot.edit_message_caption(caption=caption
|
|
|
|
inline_message_id=update.callback_query.inline_message_id,
|
2017-07-23 22:33:08 +02:00
|
|
|
*args, **kwargs)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.edit_message_caption`.
|
|
|
|
|
2017-07-23 22:33:08 +02:00
|
|
|
Returns:
|
|
|
|
:class:`telegram.Message`: On success, if edited message is sent by the bot, the
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
edited Message is returned, otherwise :obj:`True` is returned.
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2017-09-01 08:43:08 +02:00
|
|
|
"""
|
2016-09-25 16:03:06 +02:00
|
|
|
if self.inline_message_id:
|
2020-10-09 17:22:07 +02:00
|
|
|
return self.bot.edit_message_caption(
|
2020-12-30 13:41:07 +01:00
|
|
|
caption=caption,
|
|
|
|
inline_message_id=self.inline_message_id,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
parse_mode=parse_mode,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
caption_entities=caption_entities,
|
|
|
|
chat_id=None,
|
|
|
|
message_id=None,
|
2020-10-09 17:22:07 +02:00
|
|
|
)
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.edit_caption(
|
|
|
|
caption=caption,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
parse_mode=parse_mode,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
caption_entities=caption_entities,
|
|
|
|
)
|
2016-09-25 16:03:06 +02:00
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
def edit_message_reply_markup(
|
2020-12-30 13:41:07 +01:00
|
|
|
self,
|
|
|
|
reply_markup: Optional['InlineKeyboardMarkup'] = None,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
2020-10-09 17:22:07 +02:00
|
|
|
) -> Union[Message, bool]:
|
2017-09-01 08:43:08 +02:00
|
|
|
"""Shortcut for either::
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2020-11-05 17:11:35 +01:00
|
|
|
update.callback_query.message.edit_reply_markup(
|
2020-10-31 16:33:34 +01:00
|
|
|
reply_markup=reply_markup,
|
2020-11-05 17:11:35 +01:00
|
|
|
*args,
|
|
|
|
**kwargs
|
2020-10-31 16:33:34 +01:00
|
|
|
)
|
2017-07-23 22:33:08 +02:00
|
|
|
|
|
|
|
or::
|
|
|
|
|
2020-10-31 16:33:34 +01:00
|
|
|
bot.edit_message_reply_markup
|
|
|
|
inline_message_id=update.callback_query.inline_message_id,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
*args,
|
|
|
|
**kwargs
|
|
|
|
)
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.edit_message_reply_markup`.
|
|
|
|
|
2017-07-23 22:33:08 +02:00
|
|
|
Returns:
|
|
|
|
:class:`telegram.Message`: On success, if edited message is sent by the bot, the
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
edited Message is returned, otherwise :obj:`True` is returned.
|
2017-07-23 22:33:08 +02:00
|
|
|
|
2017-09-01 08:43:08 +02:00
|
|
|
"""
|
2016-09-25 16:03:06 +02:00
|
|
|
if self.inline_message_id:
|
2020-10-09 17:22:07 +02:00
|
|
|
return self.bot.edit_message_reply_markup(
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
inline_message_id=self.inline_message_id,
|
2020-12-30 13:41:07 +01:00
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
chat_id=None,
|
|
|
|
message_id=None,
|
2020-10-09 17:22:07 +02:00
|
|
|
)
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.edit_reply_markup(
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|
2020-08-13 13:39:43 +02:00
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
def edit_message_media(
|
|
|
|
self,
|
|
|
|
media: 'InputMedia' = None,
|
|
|
|
reply_markup: 'InlineKeyboardMarkup' = None,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
) -> Union[Message, bool]:
|
2020-08-13 13:39:43 +02:00
|
|
|
"""Shortcut for either::
|
|
|
|
|
2020-11-05 17:11:35 +01:00
|
|
|
update.callback_query.message.edit_media(*args, **kwargs)
|
2020-08-13 13:39:43 +02:00
|
|
|
|
|
|
|
or::
|
|
|
|
|
|
|
|
bot.edit_message_media(inline_message_id=update.callback_query.inline_message_id,
|
|
|
|
*args, **kwargs)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.edit_message_media`.
|
|
|
|
|
2020-08-13 13:39:43 +02:00
|
|
|
Returns:
|
|
|
|
:class:`telegram.Message`: On success, if edited message is sent by the bot, the
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
edited Message is returned, otherwise :obj:`True` is returned.
|
2020-08-13 13:39:43 +02:00
|
|
|
|
|
|
|
"""
|
|
|
|
if self.inline_message_id:
|
2020-10-09 17:22:07 +02:00
|
|
|
return self.bot.edit_message_media(
|
2020-12-30 13:41:07 +01:00
|
|
|
inline_message_id=self.inline_message_id,
|
|
|
|
media=media,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
chat_id=None,
|
|
|
|
message_id=None,
|
2020-10-09 17:22:07 +02:00
|
|
|
)
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.edit_media(
|
|
|
|
media=media,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|
|
|
|
|
|
|
|
def edit_message_live_location(
|
|
|
|
self,
|
|
|
|
latitude: float = None,
|
|
|
|
longitude: float = None,
|
|
|
|
location: Location = None,
|
|
|
|
reply_markup: 'InlineKeyboardMarkup' = None,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
horizontal_accuracy: float = None,
|
|
|
|
heading: int = None,
|
|
|
|
proximity_alert_radius: int = None,
|
|
|
|
) -> Union[Message, bool]:
|
2020-08-13 13:39:43 +02:00
|
|
|
"""Shortcut for either::
|
|
|
|
|
2020-11-05 17:11:35 +01:00
|
|
|
update.callback_query.message.edit_live_location(*args, **kwargs)
|
2020-08-13 13:39:43 +02:00
|
|
|
|
|
|
|
or::
|
|
|
|
|
|
|
|
bot.edit_message_live_location(
|
|
|
|
inline_message_id=update.callback_query.inline_message_id,
|
|
|
|
*args, **kwargs
|
|
|
|
)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.edit_message_live_location`.
|
|
|
|
|
2020-08-13 13:39:43 +02:00
|
|
|
Returns:
|
|
|
|
:class:`telegram.Message`: On success, if edited message is sent by the bot, the
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
edited Message is returned, otherwise :obj:`True` is returned.
|
2020-08-13 13:39:43 +02:00
|
|
|
|
|
|
|
"""
|
|
|
|
if self.inline_message_id:
|
2020-10-09 17:22:07 +02:00
|
|
|
return self.bot.edit_message_live_location(
|
2020-12-30 13:41:07 +01:00
|
|
|
inline_message_id=self.inline_message_id,
|
|
|
|
latitude=latitude,
|
|
|
|
longitude=longitude,
|
|
|
|
location=location,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
horizontal_accuracy=horizontal_accuracy,
|
|
|
|
heading=heading,
|
|
|
|
proximity_alert_radius=proximity_alert_radius,
|
|
|
|
chat_id=None,
|
|
|
|
message_id=None,
|
2020-10-09 17:22:07 +02:00
|
|
|
)
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.edit_live_location(
|
|
|
|
latitude=latitude,
|
|
|
|
longitude=longitude,
|
|
|
|
location=location,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
horizontal_accuracy=horizontal_accuracy,
|
|
|
|
heading=heading,
|
|
|
|
proximity_alert_radius=proximity_alert_radius,
|
|
|
|
)
|
|
|
|
|
|
|
|
def stop_message_live_location(
|
|
|
|
self,
|
|
|
|
reply_markup: 'InlineKeyboardMarkup' = None,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
) -> Union[Message, bool]:
|
2020-08-13 13:39:43 +02:00
|
|
|
"""Shortcut for either::
|
|
|
|
|
2020-11-05 17:11:35 +01:00
|
|
|
update.callback_query.message.stop_live_location(*args, **kwargs)
|
2020-08-13 13:39:43 +02:00
|
|
|
|
|
|
|
or::
|
|
|
|
|
|
|
|
bot.stop_message_live_location(
|
|
|
|
inline_message_id=update.callback_query.inline_message_id,
|
|
|
|
*args, **kwargs
|
|
|
|
)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.stop_message_live_location`.
|
|
|
|
|
2020-08-13 13:39:43 +02:00
|
|
|
Returns:
|
|
|
|
:class:`telegram.Message`: On success, if edited message is sent by the bot, the
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
edited Message is returned, otherwise :obj:`True` is returned.
|
2020-08-13 13:39:43 +02:00
|
|
|
|
|
|
|
"""
|
|
|
|
if self.inline_message_id:
|
2020-10-09 17:22:07 +02:00
|
|
|
return self.bot.stop_message_live_location(
|
2020-12-30 13:41:07 +01:00
|
|
|
inline_message_id=self.inline_message_id,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
chat_id=None,
|
|
|
|
message_id=None,
|
2020-10-09 17:22:07 +02:00
|
|
|
)
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.stop_live_location(
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|
2020-08-13 13:39:43 +02:00
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
def set_game_score(
|
|
|
|
self,
|
|
|
|
user_id: Union[int, str],
|
|
|
|
score: int,
|
|
|
|
force: bool = None,
|
|
|
|
disable_edit_message: bool = None,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
) -> Union[Message, bool]:
|
2020-08-13 13:39:43 +02:00
|
|
|
"""Shortcut for either::
|
|
|
|
|
2020-11-05 17:11:35 +01:00
|
|
|
update.callback_query.message.set_game_score(*args, **kwargs)
|
2020-08-13 13:39:43 +02:00
|
|
|
|
|
|
|
or::
|
|
|
|
|
|
|
|
bot.set_game_score(inline_message_id=update.callback_query.inline_message_id,
|
|
|
|
*args, **kwargs)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.set_game_score`.
|
|
|
|
|
2020-08-13 13:39:43 +02:00
|
|
|
Returns:
|
|
|
|
:class:`telegram.Message`: On success, if edited message is sent by the bot, the
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
edited Message is returned, otherwise :obj:`True` is returned.
|
2020-08-13 13:39:43 +02:00
|
|
|
|
|
|
|
"""
|
|
|
|
if self.inline_message_id:
|
2020-10-09 17:22:07 +02:00
|
|
|
return self.bot.set_game_score(
|
2020-12-30 13:41:07 +01:00
|
|
|
inline_message_id=self.inline_message_id,
|
|
|
|
user_id=user_id,
|
|
|
|
score=score,
|
|
|
|
force=force,
|
|
|
|
disable_edit_message=disable_edit_message,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
chat_id=None,
|
|
|
|
message_id=None,
|
2020-10-09 17:22:07 +02:00
|
|
|
)
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.set_game_score(
|
|
|
|
user_id=user_id,
|
|
|
|
score=score,
|
|
|
|
force=force,
|
|
|
|
disable_edit_message=disable_edit_message,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|
|
|
|
|
|
|
|
def get_game_high_scores(
|
|
|
|
self,
|
|
|
|
user_id: Union[int, str],
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
) -> List['GameHighScore']:
|
2020-08-13 13:39:43 +02:00
|
|
|
"""Shortcut for either::
|
|
|
|
|
2020-11-05 17:11:35 +01:00
|
|
|
update.callback_query.message.get_game_high_score(*args, **kwargs)
|
2020-08-13 13:39:43 +02:00
|
|
|
|
|
|
|
or::
|
|
|
|
|
|
|
|
bot.get_game_high_scores(inline_message_id=update.callback_query.inline_message_id,
|
|
|
|
*args, **kwargs)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.get_game_high_scores`.
|
|
|
|
|
2020-08-13 13:39:43 +02:00
|
|
|
Returns:
|
2020-10-06 19:28:40 +02:00
|
|
|
List[:class:`telegram.GameHighScore`]
|
2020-08-13 13:39:43 +02:00
|
|
|
|
|
|
|
"""
|
|
|
|
if self.inline_message_id:
|
2020-10-09 17:22:07 +02:00
|
|
|
return self.bot.get_game_high_scores(
|
2020-12-30 13:41:07 +01:00
|
|
|
inline_message_id=self.inline_message_id,
|
|
|
|
user_id=user_id,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
chat_id=None,
|
|
|
|
message_id=None,
|
2020-10-09 17:22:07 +02:00
|
|
|
)
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.get_game_high_scores(
|
|
|
|
user_id=user_id,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|
2020-11-05 17:11:35 +01:00
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
def delete_message(
|
|
|
|
self,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
) -> bool:
|
2020-11-05 17:11:35 +01:00
|
|
|
"""Shortcut for::
|
|
|
|
|
|
|
|
update.callback_query.message.delete(*args, **kwargs)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.delete_message`.
|
|
|
|
|
2020-11-05 17:11:35 +01:00
|
|
|
Returns:
|
|
|
|
:obj:`bool`: On success, :obj:`True` is returned.
|
|
|
|
|
|
|
|
"""
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.delete(
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|
2020-11-29 16:20:46 +01:00
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
def pin_message(
|
|
|
|
self,
|
|
|
|
disable_notification: bool = None,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
) -> bool:
|
2020-11-29 16:20:46 +01:00
|
|
|
"""Shortcut for::
|
|
|
|
|
|
|
|
bot.pin_chat_message(chat_id=message.chat_id,
|
|
|
|
message_id=message.message_id,
|
|
|
|
*args,
|
|
|
|
**kwargs)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.pin_chat_message`.
|
|
|
|
|
2020-11-29 16:20:46 +01:00
|
|
|
Returns:
|
|
|
|
:obj:`bool`: On success, :obj:`True` is returned.
|
|
|
|
|
|
|
|
"""
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.pin(
|
|
|
|
disable_notification=disable_notification,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|
2020-11-29 16:20:46 +01:00
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
def unpin_message(
|
|
|
|
self,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
) -> bool:
|
2020-11-29 16:20:46 +01:00
|
|
|
"""Shortcut for::
|
|
|
|
|
|
|
|
bot.unpin_chat_message(chat_id=message.chat_id,
|
|
|
|
message_id=message.message_id,
|
|
|
|
*args,
|
|
|
|
**kwargs)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.unpin_chat_message`.
|
|
|
|
|
2020-11-29 16:20:46 +01:00
|
|
|
Returns:
|
|
|
|
:obj:`bool`: On success, :obj:`True` is returned.
|
|
|
|
|
|
|
|
"""
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.unpin(
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|
2020-11-29 16:20:46 +01:00
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
def copy_message(
|
|
|
|
self,
|
|
|
|
chat_id: Union[int, str],
|
|
|
|
caption: str = None,
|
|
|
|
parse_mode: str = None,
|
|
|
|
caption_entities: Union[Tuple['MessageEntity', ...], List['MessageEntity']] = None,
|
|
|
|
disable_notification: bool = False,
|
|
|
|
reply_to_message_id: Union[int, str] = None,
|
|
|
|
allow_sending_without_reply: bool = False,
|
|
|
|
reply_markup: ReplyMarkup = None,
|
|
|
|
timeout: float = None,
|
|
|
|
api_kwargs: JSONDict = None,
|
|
|
|
) -> 'MessageId':
|
2020-11-29 16:20:46 +01:00
|
|
|
"""Shortcut for::
|
|
|
|
|
|
|
|
update.callback_query.message.copy(
|
|
|
|
chat_id,
|
|
|
|
from_chat_id=update.message.chat_id,
|
|
|
|
message_id=update.message.message_id,
|
|
|
|
*args,
|
|
|
|
**kwargs)
|
|
|
|
|
2020-12-30 13:41:07 +01:00
|
|
|
For the documentation of the arguments, please see
|
|
|
|
:meth:`telegram.Bot.copy_message`.
|
|
|
|
|
2020-11-29 16:20:46 +01:00
|
|
|
Returns:
|
|
|
|
:class:`telegram.MessageId`: On success, returns the MessageId of the sent message.
|
|
|
|
|
|
|
|
"""
|
2020-12-30 13:41:07 +01:00
|
|
|
return self.message.copy(
|
|
|
|
chat_id=chat_id,
|
|
|
|
caption=caption,
|
|
|
|
parse_mode=parse_mode,
|
|
|
|
caption_entities=caption_entities,
|
|
|
|
disable_notification=disable_notification,
|
|
|
|
reply_to_message_id=reply_to_message_id,
|
|
|
|
allow_sending_without_reply=allow_sending_without_reply,
|
|
|
|
reply_markup=reply_markup,
|
|
|
|
timeout=timeout,
|
|
|
|
api_kwargs=api_kwargs,
|
|
|
|
)
|
2021-01-07 21:27:51 +01:00
|
|
|
|
|
|
|
MAX_ANSWER_TEXT_LENGTH: ClassVar[int] = constants.MAX_ANSWER_CALLBACK_QUERY_TEXT_LENGTH
|
|
|
|
"""
|
|
|
|
:const:`telegram.constants.MAX_ANSWER_CALLBACK_QUERY_TEXT_LENGTH`
|
|
|
|
|
|
|
|
.. versionadded:: 13.2
|
|
|
|
"""
|