mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-12-26 22:40:24 +01:00
109 lines
4.2 KiB
Python
109 lines
4.2 KiB
Python
#!/usr/bin/env python
|
|
# pylint: disable=too-many-arguments
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2024
|
|
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser Public License as published by
|
|
# the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser Public License
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
"""This module contains an object that represents a Telegram ChosenInlineResult."""
|
|
|
|
from typing import TYPE_CHECKING, Optional
|
|
|
|
from telegram._files.location import Location
|
|
from telegram._telegramobject import TelegramObject
|
|
from telegram._user import User
|
|
from telegram._utils.types import JSONDict
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram import Bot
|
|
|
|
|
|
class ChosenInlineResult(TelegramObject):
|
|
"""
|
|
Represents a result of an inline query that was chosen by the user and sent to their chat
|
|
partner.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`result_id` is equal.
|
|
|
|
Note:
|
|
* In Python :keyword:`from` is a reserved word. Use :paramref:`from_user` instead.
|
|
* It is necessary to enable inline feedback via `@Botfather <https://t.me/BotFather>`_ in
|
|
order to receive these objects in updates.
|
|
|
|
Args:
|
|
result_id (:obj:`str`): The unique identifier for the result that was chosen.
|
|
from_user (:class:`telegram.User`): The user that chose the result.
|
|
location (:class:`telegram.Location`, optional): Sender location, only for bots that
|
|
require user location.
|
|
inline_message_id (:obj:`str`, optional): Identifier of the sent inline message. Available
|
|
only if there is an inline keyboard attached to the message. Will be also received in
|
|
callback queries and can be used to edit the message.
|
|
query (:obj:`str`): The query that was used to obtain the result.
|
|
|
|
Attributes:
|
|
result_id (:obj:`str`): The unique identifier for the result that was chosen.
|
|
from_user (:class:`telegram.User`): The user that chose the result.
|
|
location (:class:`telegram.Location`): Optional. Sender location, only for bots that
|
|
require user location.
|
|
inline_message_id (:obj:`str`): Optional. Identifier of the sent inline message. Available
|
|
only if there is an inline keyboard attached to the message. Will be also received in
|
|
callback queries and can be used to edit the message.
|
|
query (:obj:`str`): The query that was used to obtain the result.
|
|
|
|
"""
|
|
|
|
__slots__ = ("from_user", "inline_message_id", "location", "query", "result_id")
|
|
|
|
def __init__(
|
|
self,
|
|
result_id: str,
|
|
from_user: User,
|
|
query: str,
|
|
location: Optional[Location] = None,
|
|
inline_message_id: Optional[str] = None,
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
):
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
|
|
# Required
|
|
self.result_id: str = result_id
|
|
self.from_user: User = from_user
|
|
self.query: str = query
|
|
# Optionals
|
|
self.location: Optional[Location] = location
|
|
self.inline_message_id: Optional[str] = inline_message_id
|
|
|
|
self._id_attrs = (self.result_id,)
|
|
|
|
self._freeze()
|
|
|
|
@classmethod
|
|
def de_json(
|
|
cls, data: Optional[JSONDict], bot: Optional["Bot"] = None
|
|
) -> Optional["ChosenInlineResult"]:
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
data = cls._parse_data(data)
|
|
|
|
if not data:
|
|
return None
|
|
|
|
# Required
|
|
data["from_user"] = User.de_json(data.pop("from", None), bot)
|
|
# Optionals
|
|
data["location"] = Location.de_json(data.get("location"), bot)
|
|
|
|
return super().de_json(data=data, bot=bot)
|