mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2025-03-29 09:40:31 +01:00
Documentation Fixes & Improvements (#2822)
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
This commit is contained in:
parent
6382361161
commit
0a6cc7f722
21 changed files with 106 additions and 97 deletions
118
telegram/_bot.py
118
telegram/_bot.py
|
@ -442,7 +442,7 @@ class Bot(TelegramObject):
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
A JSON-serialized object for an inline keyboard, custom reply keyboard,
|
An object for an inline keyboard, custom reply keyboard,
|
||||||
instructions to remove reply keyboard or to force a reply from the user.
|
instructions to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
|
@ -649,8 +649,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
|
An object for an inline keyboard, custom reply keyboard, instructions
|
||||||
to remove reply keyboard or to force a reply from the user.
|
to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): Send file timeout (default: 20 seconds).
|
timeout (:obj:`int` | :obj:`float`, optional): Send file timeout (default: 20 seconds).
|
||||||
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
||||||
|
@ -762,8 +762,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
|
An object for an inline keyboard, custom reply keyboard, instructions
|
||||||
to remove reply keyboard or to force a reply from the user.
|
to remove reply keyboard or to force a reply from the user.
|
||||||
thumb (`filelike object` | :obj:`bytes` | :class:`pathlib.Path`, optional): Thumbnail
|
thumb (`filelike object` | :obj:`bytes` | :class:`pathlib.Path`, optional): Thumbnail
|
||||||
of the file sent; can be ignored if
|
of the file sent; can be ignored if
|
||||||
|
@ -884,8 +884,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
|
An object for an inline keyboard, custom reply keyboard, instructions
|
||||||
to remove reply keyboard or to force a reply from the user.
|
to remove reply keyboard or to force a reply from the user.
|
||||||
thumb (`filelike object` | :obj:`bytes` | :class:`pathlib.Path`, optional): Thumbnail
|
thumb (`filelike object` | :obj:`bytes` | :class:`pathlib.Path`, optional): Thumbnail
|
||||||
of the file sent; can be ignored if
|
of the file sent; can be ignored if
|
||||||
|
@ -978,8 +978,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
|
An object for an inline keyboard, custom reply keyboard, instructions
|
||||||
to remove reply keyboard or to force a reply from the user.
|
to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): Send file timeout (default: 20 seconds).
|
timeout (:obj:`int` | :obj:`float`, optional): Send file timeout (default: 20 seconds).
|
||||||
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
||||||
|
@ -1085,8 +1085,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
|
An object for an inline keyboard, custom reply keyboard, instructions
|
||||||
to remove reply keyboard or to force a reply from the user.
|
to remove reply keyboard or to force a reply from the user.
|
||||||
thumb (`filelike object` | :obj:`bytes` | :class:`pathlib.Path`, optional): Thumbnail
|
thumb (`filelike object` | :obj:`bytes` | :class:`pathlib.Path`, optional): Thumbnail
|
||||||
of the file sent; can be ignored if
|
of the file sent; can be ignored if
|
||||||
|
@ -1200,8 +1200,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard,
|
An object for an inline keyboard, custom reply keyboard,
|
||||||
instructions to remove reply keyboard or to force a reply from the user.
|
instructions to remove reply keyboard or to force a reply from the user.
|
||||||
thumb (`filelike object` | :obj:`bytes` | :class:`pathlib.Path`, optional): Thumbnail
|
thumb (`filelike object` | :obj:`bytes` | :class:`pathlib.Path`, optional): Thumbnail
|
||||||
of the file sent; can be ignored if
|
of the file sent; can be ignored if
|
||||||
|
@ -1329,8 +1329,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
|
An object for an inline keyboard, custom reply keyboard, instructions
|
||||||
to remove reply keyboard or to force a reply from the user.
|
to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): Send file timeout (default: 20 seconds).
|
timeout (:obj:`int` | :obj:`float`, optional): Send file timeout (default: 20 seconds).
|
||||||
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
||||||
|
@ -1441,8 +1441,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard,
|
An object for an inline keyboard, custom reply keyboard,
|
||||||
instructions to remove reply keyboard or to force a reply from the user.
|
instructions to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): Send file timeout (default: 20 seconds).
|
timeout (:obj:`int` | :obj:`float`, optional): Send file timeout (default: 20 seconds).
|
||||||
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
||||||
|
@ -1593,8 +1593,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard,
|
An object for an inline keyboard, custom reply keyboard,
|
||||||
instructions to remove reply keyboard or to force a reply from the user.
|
instructions to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
|
@ -1688,8 +1688,8 @@ class Bot(TelegramObject):
|
||||||
proximity_alert_radius (:obj:`int`, optional): Maximum distance for proximity alerts
|
proximity_alert_radius (:obj:`int`, optional): Maximum distance for proximity alerts
|
||||||
about approaching another chat member, in meters. Must be between 1 and
|
about approaching another chat member, in meters. Must be between 1 and
|
||||||
:tg-const:`telegram.constants.LocationLimit.HEADING` if specified.
|
:tg-const:`telegram.constants.LocationLimit.HEADING` if specified.
|
||||||
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): A JSON-serialized
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for a new
|
||||||
object for a new inline keyboard.
|
inline keyboard.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
the connection pool).
|
the connection pool).
|
||||||
|
@ -1757,8 +1757,8 @@ class Bot(TelegramObject):
|
||||||
Identifier of the sent message with live location to stop.
|
Identifier of the sent message with live location to stop.
|
||||||
inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not
|
inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not
|
||||||
specified. Identifier of the inline message.
|
specified. Identifier of the inline message.
|
||||||
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): A JSON-serialized
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for a new
|
||||||
object for a new inline keyboard.
|
inline keyboard.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
the connection pool).
|
the connection pool).
|
||||||
|
@ -1844,8 +1844,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
|
An object for an inline keyboard, custom reply keyboard, instructions
|
||||||
to remove reply keyboard or to force a reply from the user.
|
to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
|
@ -1948,8 +1948,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
|
An object for an inline keyboard, custom reply keyboard, instructions
|
||||||
to remove reply keyboard or to force a reply from the user.
|
to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
|
@ -2028,8 +2028,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): A JSON-serialized
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for a new
|
||||||
object for a new inline keyboard. If empty, one ‘Play game_title’ button will be
|
inline keyboard. If empty, one ‘Play game_title’ button will be
|
||||||
shown. If not empty, the first button must launch the game.
|
shown. If not empty, the first button must launch the game.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
|
@ -2658,8 +2658,8 @@ class Bot(TelegramObject):
|
||||||
that appear in message text, which can be specified instead of :attr:`parse_mode`.
|
that appear in message text, which can be specified instead of :attr:`parse_mode`.
|
||||||
disable_web_page_preview (:obj:`bool`, optional): Disables link previews for links in
|
disable_web_page_preview (:obj:`bool`, optional): Disables link previews for links in
|
||||||
this message.
|
this message.
|
||||||
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): A JSON-serialized
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an
|
||||||
object for an inline keyboard.
|
inline keyboard.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
the connection pool).
|
the connection pool).
|
||||||
|
@ -2730,8 +2730,8 @@ class Bot(TelegramObject):
|
||||||
caption_entities (List[:class:`telegram.MessageEntity`], optional): List of special
|
caption_entities (List[:class:`telegram.MessageEntity`], optional): List of special
|
||||||
entities that appear in message text, which can be specified instead of
|
entities that appear in message text, which can be specified instead of
|
||||||
:attr:`parse_mode`.
|
:attr:`parse_mode`.
|
||||||
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): A JSON-serialized
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an
|
||||||
object for an inline keyboard.
|
inline keyboard.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
the connection pool).
|
the connection pool).
|
||||||
|
@ -2801,8 +2801,8 @@ class Bot(TelegramObject):
|
||||||
Identifier of the message to edit.
|
Identifier of the message to edit.
|
||||||
inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not
|
inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not
|
||||||
specified. Identifier of the inline message.
|
specified. Identifier of the inline message.
|
||||||
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): A JSON-serialized
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an
|
||||||
object for an inline keyboard.
|
inline keyboard.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
the connection pool).
|
the connection pool).
|
||||||
|
@ -2861,8 +2861,8 @@ class Bot(TelegramObject):
|
||||||
Identifier of the message to edit.
|
Identifier of the message to edit.
|
||||||
inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not
|
inline_message_id (:obj:`str`, optional): Required if chat_id and message_id are not
|
||||||
specified. Identifier of the inline message.
|
specified. Identifier of the inline message.
|
||||||
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): A JSON-serialized
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an
|
||||||
object for an inline keyboard.
|
inline keyboard.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
the connection pool).
|
the connection pool).
|
||||||
|
@ -2928,7 +2928,7 @@ class Bot(TelegramObject):
|
||||||
read_latency (:obj:`float` | :obj:`int`, optional): Grace time in seconds for receiving
|
read_latency (:obj:`float` | :obj:`int`, optional): Grace time in seconds for receiving
|
||||||
the reply from server. Will be added to the ``timeout`` value and used as the read
|
the reply from server. Will be added to the ``timeout`` value and used as the read
|
||||||
timeout from server. Defaults to ``2``.
|
timeout from server. Defaults to ``2``.
|
||||||
allowed_updates (List[:obj:`str`]), optional): A JSON-serialized list the types of
|
allowed_updates (List[:obj:`str`]), optional): A list the types of
|
||||||
updates you want your bot to receive. For example, specify ["message",
|
updates you want your bot to receive. For example, specify ["message",
|
||||||
"edited_channel_post", "callback_query"] to only receive updates of these types.
|
"edited_channel_post", "callback_query"] to only receive updates of these types.
|
||||||
See :class:`telegram.Update` for a complete list of available update types.
|
See :class:`telegram.Update` for a complete list of available update types.
|
||||||
|
@ -2999,7 +2999,7 @@ class Bot(TelegramObject):
|
||||||
"""
|
"""
|
||||||
Use this method to specify a url and receive incoming updates via an outgoing webhook.
|
Use this method to specify a url and receive incoming updates via an outgoing webhook.
|
||||||
Whenever there is an update for the bot, Telegram will send an HTTPS POST request to the
|
Whenever there is an update for the bot, Telegram will send an HTTPS POST request to the
|
||||||
specified url, containing a JSON-serialized Update. In case of an unsuccessful request,
|
specified url, containing An Update. In case of an unsuccessful request,
|
||||||
Telegram will give up after a reasonable amount of attempts.
|
Telegram will give up after a reasonable amount of attempts.
|
||||||
|
|
||||||
If you'd like to make sure that the Webhook request comes from Telegram, Telegram
|
If you'd like to make sure that the Webhook request comes from Telegram, Telegram
|
||||||
|
@ -3021,7 +3021,7 @@ class Bot(TelegramObject):
|
||||||
connections to the webhook for update delivery, 1-100. Defaults to ``40``. Use
|
connections to the webhook for update delivery, 1-100. Defaults to ``40``. Use
|
||||||
lower values to limit the load on your bot's server, and higher values to increase
|
lower values to limit the load on your bot's server, and higher values to increase
|
||||||
your bot's throughput.
|
your bot's throughput.
|
||||||
allowed_updates (List[:obj:`str`], optional): A JSON-serialized list the types of
|
allowed_updates (List[:obj:`str`], optional): A list the types of
|
||||||
updates you want your bot to receive. For example, specify ["message",
|
updates you want your bot to receive. For example, specify ["message",
|
||||||
"edited_channel_post", "callback_query"] to only receive updates of these types.
|
"edited_channel_post", "callback_query"] to only receive updates of these types.
|
||||||
See :class:`telegram.Update` for a complete list of available update types.
|
See :class:`telegram.Update` for a complete list of available update types.
|
||||||
|
@ -3533,7 +3533,7 @@ class Bot(TelegramObject):
|
||||||
provider_token (:obj:`str`): Payments provider token, obtained via
|
provider_token (:obj:`str`): Payments provider token, obtained via
|
||||||
`@BotFather <https://t.me/BotFather>`_.
|
`@BotFather <https://t.me/BotFather>`_.
|
||||||
currency (:obj:`str`): Three-letter ISO 4217 currency code.
|
currency (:obj:`str`): Three-letter ISO 4217 currency code.
|
||||||
prices (List[:class:`telegram.LabeledPrice`)]: Price breakdown, a JSON-serialized list
|
prices (List[:class:`telegram.LabeledPrice`)]: Price breakdown, a list
|
||||||
of components (e.g. product price, tax, discount, delivery cost, delivery tax,
|
of components (e.g. product price, tax, discount, delivery cost, delivery tax,
|
||||||
bonus, etc.).
|
bonus, etc.).
|
||||||
max_tip_amount (:obj:`int`, optional): The maximum accepted amount for tips in the
|
max_tip_amount (:obj:`int`, optional): The maximum accepted amount for tips in the
|
||||||
|
@ -3544,7 +3544,7 @@ class Bot(TelegramObject):
|
||||||
majority of currencies). Defaults to ``0``.
|
majority of currencies). Defaults to ``0``.
|
||||||
|
|
||||||
.. versionadded:: 13.5
|
.. versionadded:: 13.5
|
||||||
suggested_tip_amounts (List[:obj:`int`], optional): A JSON-serialized array of
|
suggested_tip_amounts (List[:obj:`int`], optional): An array of
|
||||||
suggested amounts of tips in the smallest units of the currency (integer, not
|
suggested amounts of tips in the smallest units of the currency (integer, not
|
||||||
float/double). At most 4 suggested tip amounts can be specified. The suggested tip
|
float/double). At most 4 suggested tip amounts can be specified. The suggested tip
|
||||||
amounts must be positive, passed in a strictly increased order and must not exceed
|
amounts must be positive, passed in a strictly increased order and must not exceed
|
||||||
|
@ -3560,7 +3560,7 @@ class Bot(TelegramObject):
|
||||||
|
|
||||||
.. versionchanged:: 13.5
|
.. versionchanged:: 13.5
|
||||||
As of Bot API 5.2, this parameter is optional.
|
As of Bot API 5.2, this parameter is optional.
|
||||||
provider_data (:obj:`str` | :obj:`object`, optional): JSON-serialized data about the
|
provider_data (:obj:`str` | :obj:`object`, optional): data about the
|
||||||
invoice, which will be shared with the payment provider. A detailed description of
|
invoice, which will be shared with the payment provider. A detailed description of
|
||||||
required fields should be provided by the payment provider. When an object is
|
required fields should be provided by the payment provider. When an object is
|
||||||
passed, it will be encoded as JSON.
|
passed, it will be encoded as JSON.
|
||||||
|
@ -3595,8 +3595,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): A JSON-serialized
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for an
|
||||||
object for an inline keyboard. If empty, one 'Pay total price' button will be
|
inline keyboard. If empty, one 'Pay total price' button will be
|
||||||
shown. If not empty, the first button must be a Pay button.
|
shown. If not empty, the first button must be a Pay button.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
|
@ -3688,7 +3688,7 @@ class Bot(TelegramObject):
|
||||||
and :obj:`False` if there are any problems (for example, if delivery to the
|
and :obj:`False` if there are any problems (for example, if delivery to the
|
||||||
specified address is not possible).
|
specified address is not possible).
|
||||||
shipping_options (List[:class:`telegram.ShippingOption`]), optional]: Required if ok is
|
shipping_options (List[:class:`telegram.ShippingOption`]), optional]: Required if ok is
|
||||||
:obj:`True`. A JSON-serialized array of available shipping options.
|
:obj:`True`. An array of available shipping options.
|
||||||
error_message (:obj:`str`, optional): Required if ok is :obj:`False`. Error message in
|
error_message (:obj:`str`, optional): Required if ok is :obj:`False`. Error message in
|
||||||
human readable form that explains why it is impossible to complete the order (e.g.
|
human readable form that explains why it is impossible to complete the order (e.g.
|
||||||
"Sorry, delivery to your desired address is unavailable"). Telegram will display
|
"Sorry, delivery to your desired address is unavailable"). Telegram will display
|
||||||
|
@ -3824,7 +3824,7 @@ class Bot(TelegramObject):
|
||||||
restricted forever.
|
restricted forever.
|
||||||
For timezone naive :obj:`datetime.datetime` objects, the default timezone of the
|
For timezone naive :obj:`datetime.datetime` objects, the default timezone of the
|
||||||
bot will be used.
|
bot will be used.
|
||||||
permissions (:class:`telegram.ChatPermissions`): A JSON-serialized object for new user
|
permissions (:class:`telegram.ChatPermissions`): An object for new user
|
||||||
permissions.
|
permissions.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
|
@ -5016,7 +5016,7 @@ class Bot(TelegramObject):
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
user_id (:obj:`int`): User identifier
|
user_id (:obj:`int`): User identifier
|
||||||
errors (List[:class:`PassportElementError`]): A JSON-serialized array describing the
|
errors (List[:class:`PassportElementError`]): An array describing the
|
||||||
errors.
|
errors.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during
|
the read timeout from the server (instead of the one specified during
|
||||||
|
@ -5110,8 +5110,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
|
An object for an inline keyboard, custom reply keyboard, instructions
|
||||||
to remove reply keyboard or to force a reply from the user.
|
to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
|
@ -5180,8 +5180,8 @@ class Bot(TelegramObject):
|
||||||
chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username
|
chat_id (:obj:`int` | :obj:`str`): Unique identifier for the target chat or username
|
||||||
of the target channel (in the format ``@channelusername``).
|
of the target channel (in the format ``@channelusername``).
|
||||||
message_id (:obj:`int`): Identifier of the original message with the poll.
|
message_id (:obj:`int`): Identifier of the original message with the poll.
|
||||||
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): A JSON-serialized
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): An object for a new
|
||||||
object for a new message inline keyboard.
|
message inline keyboard.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
the connection pool).
|
the connection pool).
|
||||||
|
@ -5251,8 +5251,8 @@ class Bot(TelegramObject):
|
||||||
original message.
|
original message.
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options. A
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
JSON-serialized object for an inline keyboard, custom reply keyboard, instructions
|
An object for an inline keyboard, custom reply keyboard, instructions
|
||||||
to remove reply keyboard or to force a reply from the user.
|
to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
|
@ -5302,7 +5302,7 @@ class Bot(TelegramObject):
|
||||||
the connection pool).
|
the connection pool).
|
||||||
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
||||||
Telegram API.
|
Telegram API.
|
||||||
scope (:class:`telegram.BotCommandScope`, optional): A JSON-serialized object,
|
scope (:class:`telegram.BotCommandScope`, optional): An object,
|
||||||
describing scope of users. Defaults to :class:`telegram.BotCommandScopeDefault`.
|
describing scope of users. Defaults to :class:`telegram.BotCommandScopeDefault`.
|
||||||
|
|
||||||
.. versionadded:: 13.7
|
.. versionadded:: 13.7
|
||||||
|
@ -5347,7 +5347,7 @@ class Bot(TelegramObject):
|
||||||
commands.
|
commands.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
commands (List[:class:`BotCommand` | (:obj:`str`, :obj:`str`)]): A JSON-serialized list
|
commands (List[:class:`BotCommand` | (:obj:`str`, :obj:`str`)]): A list
|
||||||
of bot commands to be set as the list of the bot's commands. At most 100 commands
|
of bot commands to be set as the list of the bot's commands. At most 100 commands
|
||||||
can be specified.
|
can be specified.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
|
@ -5355,7 +5355,7 @@ class Bot(TelegramObject):
|
||||||
the connection pool).
|
the connection pool).
|
||||||
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
api_kwargs (:obj:`dict`, optional): Arbitrary keyword arguments to be passed to the
|
||||||
Telegram API.
|
Telegram API.
|
||||||
scope (:class:`telegram.BotCommandScope`, optional): A JSON-serialized object,
|
scope (:class:`telegram.BotCommandScope`, optional): An object,
|
||||||
describing scope of users for which the commands are relevant. Defaults to
|
describing scope of users for which the commands are relevant. Defaults to
|
||||||
:class:`telegram.BotCommandScopeDefault`.
|
:class:`telegram.BotCommandScopeDefault`.
|
||||||
|
|
||||||
|
@ -5405,7 +5405,7 @@ class Bot(TelegramObject):
|
||||||
.. versionadded:: 13.7
|
.. versionadded:: 13.7
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
scope (:class:`telegram.BotCommandScope`, optional): A JSON-serialized object,
|
scope (:class:`telegram.BotCommandScope`, optional): An object,
|
||||||
describing scope of users for which the commands are relevant. Defaults to
|
describing scope of users for which the commands are relevant. Defaults to
|
||||||
:class:`telegram.BotCommandScopeDefault`.
|
:class:`telegram.BotCommandScopeDefault`.
|
||||||
language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code. If empty,
|
language_code (:obj:`str`, optional): A two-letter ISO 639-1 language code. If empty,
|
||||||
|
@ -5528,7 +5528,7 @@ class Bot(TelegramObject):
|
||||||
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
allow_sending_without_reply (:obj:`bool`, optional): Pass :obj:`True`, if the message
|
||||||
should be sent even if the specified replied-to message is not found.
|
should be sent even if the specified replied-to message is not found.
|
||||||
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
reply_markup (:class:`telegram.ReplyMarkup`, optional): Additional interface options.
|
||||||
A JSON-serialized object for an inline keyboard, custom reply keyboard,
|
An object for an inline keyboard, custom reply keyboard,
|
||||||
instructions to remove reply keyboard or to force a reply from the user.
|
instructions to remove reply keyboard or to force a reply from the user.
|
||||||
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
||||||
the read timeout from the server (instead of the one specified during creation of
|
the read timeout from the server (instead of the one specified during creation of
|
||||||
|
|
|
@ -31,9 +31,9 @@ class BotCommand(TelegramObject):
|
||||||
considered equal, if their :attr:`command` and :attr:`description` are equal.
|
considered equal, if their :attr:`command` and :attr:`description` are equal.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
command (:obj:`str`): Text of the command, 1-32 characters. Can contain only lowercase
|
command (:obj:`str`): Text of the command; 1-32 characters. Can contain only lowercase
|
||||||
English letters, digits and underscores.
|
English letters, digits and underscores.
|
||||||
description (:obj:`str`): Description of the command, 1-256 characters.
|
description (:obj:`str`): Description of the command; 1-256 characters.
|
||||||
|
|
||||||
Attributes:
|
Attributes:
|
||||||
command (:obj:`str`): Text of the command.
|
command (:obj:`str`): Text of the command.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -46,7 +46,7 @@ class InputInvoiceMessageContent(InputMessageContent):
|
||||||
`@Botfather <https://t.me/Botfather>`_.
|
`@Botfather <https://t.me/Botfather>`_.
|
||||||
currency (:obj:`str`): Three-letter ISO 4217 currency code, see more on
|
currency (:obj:`str`): Three-letter ISO 4217 currency code, see more on
|
||||||
`currencies <https://core.telegram.org/bots/payments#supported-currencies>`_
|
`currencies <https://core.telegram.org/bots/payments#supported-currencies>`_
|
||||||
prices (List[:class:`telegram.LabeledPrice`]): Price breakdown, a JSON-serialized list of
|
prices (List[:class:`telegram.LabeledPrice`]): Price breakdown, a list of
|
||||||
components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus,
|
components (e.g. product price, tax, discount, delivery cost, delivery tax, bonus,
|
||||||
etc.)
|
etc.)
|
||||||
max_tip_amount (:obj:`int`, optional): The maximum accepted amount for tips in the smallest
|
max_tip_amount (:obj:`int`, optional): The maximum accepted amount for tips in the smallest
|
||||||
|
@ -55,12 +55,12 @@ class InputInvoiceMessageContent(InputMessageContent):
|
||||||
`currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it
|
`currencies.json <https://core.telegram.org/bots/payments/currencies.json>`_, it
|
||||||
shows the number of digits past the decimal point for each currency (2 for the majority
|
shows the number of digits past the decimal point for each currency (2 for the majority
|
||||||
of currencies). Defaults to ``0``.
|
of currencies). Defaults to ``0``.
|
||||||
suggested_tip_amounts (List[:obj:`int`], optional): A JSON-serialized array of suggested
|
suggested_tip_amounts (List[:obj:`int`], optional): An array of suggested
|
||||||
amounts of tip in the smallest units of the currency (integer, not float/double). At
|
amounts of tip in the smallest units of the currency (integer, not float/double). At
|
||||||
most 4 suggested tip amounts can be specified. The suggested tip amounts must be
|
most 4 suggested tip amounts can be specified. The suggested tip amounts must be
|
||||||
positive, passed in a strictly increased order and must not exceed
|
positive, passed in a strictly increased order and must not exceed
|
||||||
:attr:`max_tip_amount`.
|
:attr:`max_tip_amount`.
|
||||||
provider_data (:obj:`str`, optional): A JSON-serialized object for data about the invoice,
|
provider_data (:obj:`str`, optional): An object for data about the invoice,
|
||||||
which will be shared with the payment provider. A detailed description of the required
|
which will be shared with the payment provider. A detailed description of the required
|
||||||
fields should be provided by the payment provider.
|
fields should be provided by the payment provider.
|
||||||
photo_url (:obj:`str`, optional): URL of the product photo for the invoice. Can be a photo
|
photo_url (:obj:`str`, optional): URL of the product photo for the invoice. Can be a photo
|
||||||
|
@ -94,13 +94,13 @@ class InputInvoiceMessageContent(InputMessageContent):
|
||||||
`@Botfather <https://t.me/Botfather>`_.
|
`@Botfather <https://t.me/Botfather>`_.
|
||||||
currency (:obj:`str`): Three-letter ISO 4217 currency code, see more on
|
currency (:obj:`str`): Three-letter ISO 4217 currency code, see more on
|
||||||
`currencies <https://core.telegram.org/bots/payments#supported-currencies>`_
|
`currencies <https://core.telegram.org/bots/payments#supported-currencies>`_
|
||||||
prices (List[:class:`telegram.LabeledPrice`]): Price breakdown, a JSON-serialized list of
|
prices (List[:class:`telegram.LabeledPrice`]): Price breakdown, a list of
|
||||||
components.
|
components.
|
||||||
max_tip_amount (:obj:`int`): Optional. The maximum accepted amount for tips in the smallest
|
max_tip_amount (:obj:`int`): Optional. The maximum accepted amount for tips in the smallest
|
||||||
units of the currency (integer, not float/double).
|
units of the currency (integer, not float/double).
|
||||||
suggested_tip_amounts (List[:obj:`int`]): Optional. A JSON-serialized array of suggested
|
suggested_tip_amounts (List[:obj:`int`]): Optional. An array of suggested
|
||||||
amounts of tip in the smallest units of the currency (integer, not float/double).
|
amounts of tip in the smallest units of the currency (integer, not float/double).
|
||||||
provider_data (:obj:`str`): Optional. A JSON-serialized object for data about the invoice,
|
provider_data (:obj:`str`): Optional. An object for data about the invoice,
|
||||||
which will be shared with the payment provider.
|
which will be shared with the payment provider.
|
||||||
photo_url (:obj:`str`): Optional. URL of the product photo for the invoice.
|
photo_url (:obj:`str`): Optional. URL of the product photo for the invoice.
|
||||||
photo_size (:obj:`int`): Optional. Photo size.
|
photo_size (:obj:`int`): Optional. Photo size.
|
||||||
|
|
|
@ -162,7 +162,7 @@ class TelegramObject:
|
||||||
def get_bot(self) -> 'Bot':
|
def get_bot(self) -> 'Bot':
|
||||||
"""Returns the :class:`telegram.Bot` instance associated with this object.
|
"""Returns the :class:`telegram.Bot` instance associated with this object.
|
||||||
|
|
||||||
.. seealso:: :meth: `set_bot`
|
.. seealso:: :meth:`set_bot`
|
||||||
|
|
||||||
.. versionadded: 14.0
|
.. versionadded: 14.0
|
||||||
|
|
||||||
|
@ -179,7 +179,7 @@ class TelegramObject:
|
||||||
def set_bot(self, bot: Optional['Bot']) -> None:
|
def set_bot(self, bot: Optional['Bot']) -> None:
|
||||||
"""Sets the :class:`telegram.Bot` instance associated with this object.
|
"""Sets the :class:`telegram.Bot` instance associated with this object.
|
||||||
|
|
||||||
.. seealso:: :meth: `get_bot`
|
.. seealso:: :meth:`get_bot`
|
||||||
|
|
||||||
.. versionadded: 14.0
|
.. versionadded: 14.0
|
||||||
|
|
||||||
|
|
|
@ -267,7 +267,13 @@ class Update(TelegramObject):
|
||||||
def effective_user(self) -> Optional['User']:
|
def effective_user(self) -> Optional['User']:
|
||||||
"""
|
"""
|
||||||
:class:`telegram.User`: The user that sent this update, no matter what kind of update this
|
:class:`telegram.User`: The user that sent this update, no matter what kind of update this
|
||||||
is. Will be :obj:`None` for :attr:`channel_post` and :attr:`poll`.
|
is. If no user is associated with this update, this gives :obj:`None`. This is the case
|
||||||
|
if :attr:`channel_post`, :attr:`edited_channel_post` or :attr:`poll` is present.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
* If :attr:`message` is present, this will give
|
||||||
|
:attr:`telegram.Message.from_user`.
|
||||||
|
* If :attr:`poll_answer` is present, this will give :attr:`telegram.PollAnswer.user`.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if self._effective_user:
|
if self._effective_user:
|
||||||
|
@ -315,10 +321,15 @@ class Update(TelegramObject):
|
||||||
def effective_chat(self) -> Optional['Chat']:
|
def effective_chat(self) -> Optional['Chat']:
|
||||||
"""
|
"""
|
||||||
:class:`telegram.Chat`: The chat that this update was sent in, no matter what kind of
|
:class:`telegram.Chat`: The chat that this update was sent in, no matter what kind of
|
||||||
update this is. Will be :obj:`None` for :attr:`inline_query`,
|
update this is.
|
||||||
:attr:`chosen_inline_result`, :attr:`callback_query` from inline messages,
|
If no chat is associated with this update, this gives :obj:`None`.
|
||||||
:attr:`shipping_query`, :attr:`pre_checkout_query`, :attr:`poll` and
|
This is the case, if :attr:`inline_query`,
|
||||||
:attr:`poll_answer`.
|
:attr:`chosen_inline_result`, :attr:`callback_query` from inline messages,
|
||||||
|
:attr:`shipping_query`, :attr:`pre_checkout_query`, :attr:`poll` or
|
||||||
|
:attr:`poll_answer` is present.
|
||||||
|
|
||||||
|
Example:
|
||||||
|
If :attr:`message` is present, this will give :attr:`telegram.Message.chat`.
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if self._effective_chat:
|
if self._effective_chat:
|
||||||
|
@ -357,12 +368,10 @@ class Update(TelegramObject):
|
||||||
def effective_message(self) -> Optional[Message]:
|
def effective_message(self) -> Optional[Message]:
|
||||||
"""
|
"""
|
||||||
:class:`telegram.Message`: The message included in this update, no matter what kind of
|
:class:`telegram.Message`: The message included in this update, no matter what kind of
|
||||||
update this is. Will be :obj:`None` for :attr:`inline_query`,
|
update this is. More precisely, this will be the message contained in :attr:`message`,
|
||||||
:attr:`chosen_inline_result`, :attr:`callback_query` from inline messages,
|
:attr:`edited_message`, :attr:`channel_post`, :attr:`edited_channel_post` or
|
||||||
:attr:`shipping_query`, :attr:`pre_checkout_query`, :attr:`poll`,
|
:attr:`callback_query` (i.e. :attr:`telegram.CallbackQuery.message`) or :obj:`None`, if
|
||||||
:attr:`poll_answer`, :attr:`my_chat_member`, :attr:`chat_member` as well as
|
none of those are present.
|
||||||
:attr:`chat_join_request` in case the bot is missing the
|
|
||||||
:attr:`telegram.ChatPermissions.can_invite_users` administrator right in the chat.
|
|
||||||
|
|
||||||
"""
|
"""
|
||||||
if self._effective_message:
|
if self._effective_message:
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1591,9 +1591,9 @@ class SenderChat(_ChatUserBaseFilter):
|
||||||
so when your bot is an admin in a channel and the linked discussion group, you would
|
so when your bot is an admin in a channel and the linked discussion group, you would
|
||||||
receive the message twice (once from inside the channel, once inside the discussion
|
receive the message twice (once from inside the channel, once inside the discussion
|
||||||
group). Since v13.9, the field :attr:`telegram.Message.is_automatic_forward` will be
|
group). Since v13.9, the field :attr:`telegram.Message.is_automatic_forward` will be
|
||||||
:obj:`True` for the discussion group message.
|
:obj:`True` for the discussion group message.
|
||||||
|
|
||||||
.. seealso:: :attr:`Filters.is_automatic_forward`
|
.. seealso:: :attr:`telegram.ext.filters.IS_AUTOMATIC_FORWARD`
|
||||||
|
|
||||||
Warning:
|
Warning:
|
||||||
:attr:`chat_ids` will return a *copy* of the saved chat ids as :obj:`frozenset`. This
|
:attr:`chat_ids` will return a *copy* of the saved chat ids as :obj:`frozenset`. This
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
#!/usr/bin/env python
|
#!/usr/bin/env python
|
||||||
#
|
#
|
||||||
# A library that provides a Python interface to the Telegram Bot API
|
# A library that provides a Python interface to the Telegram Bot API
|
||||||
# Copyright (C) 2015-2021
|
# Copyright (C) 2015-2022
|
||||||
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
||||||
#
|
#
|
||||||
# This program is free software: you can redistribute it and/or modify
|
# This program is free software: you can redistribute it and/or modify
|
||||||
|
|
Loading…
Add table
Reference in a new issue