2016-04-12 06:12:35 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2022-01-03 08:15:18 +01:00
|
|
|
# Copyright (C) 2015-2022
|
2016-04-12 06:12:35 +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/].
|
2017-09-01 08:43:08 +02:00
|
|
|
"""This module contains the classes that represent Telegram InlineQueryResultArticle."""
|
2016-04-14 01:01:36 +02:00
|
|
|
|
2022-10-07 11:51:53 +02:00
|
|
|
from typing import TYPE_CHECKING
|
2020-10-31 16:33:34 +01:00
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup
|
|
|
|
from telegram._inline.inlinequeryresult import InlineQueryResult
|
2022-10-07 11:51:53 +02:00
|
|
|
from telegram._utils.types import JSONDict
|
2021-10-19 18:28:19 +02:00
|
|
|
from telegram.constants import InlineQueryResultType
|
2020-10-09 17:22:07 +02:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
if TYPE_CHECKING:
|
2022-01-19 18:00:21 +01:00
|
|
|
from telegram import InputMessageContent
|
2016-04-13 14:59:48 +02:00
|
|
|
|
|
|
|
|
|
|
|
class InlineQueryResultArticle(InlineQueryResult):
|
|
|
|
"""This object represents a Telegram InlineQueryResultArticle.
|
|
|
|
|
Documentation Improvements (#3214, #3217, #3218, #3271, #3289, #3292, #3303, #3312, #3306, #3319, #3326, #3314)
Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com>
Co-authored-by: Simon Fong <44134941+simonfongnt@users.noreply.github.com>
Co-authored-by: Piotr Rogulski <rivinek@gmail.com>
Co-authored-by: poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: Or Bin <or@raftt.io>
Co-authored-by: Sandro <j32g7f67hb@liamekaens.com>
Co-authored-by: Hatim Zahid <63000127+HatimZ@users.noreply.github.com>
Co-authored-by: Robi <53259730+RobiMez@users.noreply.github.com>
Co-authored-by: Dmitry Kolomatskiy <58207913+lemontree210@users.noreply.github.com>
2022-11-15 09:06:23 +01:00
|
|
|
Examples:
|
|
|
|
:any:`Inline Bot <examples.inlinebot>`
|
2022-08-27 11:46:51 +02:00
|
|
|
|
2016-04-13 14:59:48 +02:00
|
|
|
Args:
|
2017-07-23 22:33:08 +02:00
|
|
|
id (:obj:`str`): Unique identifier for this result, 1-64 Bytes.
|
|
|
|
title (:obj:`str`): Title of the result.
|
|
|
|
input_message_content (:class:`telegram.InputMessageContent`): Content of the message to
|
|
|
|
be sent.
|
2022-01-19 18:00:21 +01:00
|
|
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): Inline keyboard attached
|
|
|
|
to the message.
|
2017-07-23 22:33:08 +02:00
|
|
|
url (:obj:`str`, optional): URL of the result.
|
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
|
|
|
hide_url (:obj:`bool`, optional): Pass :obj:`True`, if you don't want the URL to be shown
|
|
|
|
in the message.
|
2017-07-23 22:33:08 +02:00
|
|
|
description (:obj:`str`, optional): Short description of the result.
|
|
|
|
thumb_url (:obj:`str`, optional): Url of the thumbnail for the result.
|
|
|
|
thumb_width (:obj:`int`, optional): Thumbnail width.
|
|
|
|
thumb_height (:obj:`int`, optional): Thumbnail height.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2020-12-30 15:59:50 +01:00
|
|
|
Attributes:
|
2021-10-19 18:28:19 +02:00
|
|
|
type (:obj:`str`): :tg-const:`telegram.constants.InlineQueryResultType.ARTICLE`.
|
2020-12-30 15:59:50 +01:00
|
|
|
id (:obj:`str`): Unique identifier for this result, 1-64 Bytes.
|
|
|
|
title (:obj:`str`): Title of the result.
|
|
|
|
input_message_content (:class:`telegram.InputMessageContent`): Content of the message to
|
|
|
|
be sent.
|
2022-01-19 18:00:21 +01:00
|
|
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`): Optional. Inline keyboard attached
|
|
|
|
to the message.
|
2020-12-30 15:59:50 +01:00
|
|
|
url (:obj:`str`): Optional. URL of the result.
|
|
|
|
hide_url (:obj:`bool`): Optional. Pass :obj:`True`, if you don't want the URL to be shown
|
|
|
|
in the message.
|
|
|
|
description (:obj:`str`): Optional. Short description of the result.
|
|
|
|
thumb_url (:obj:`str`): Optional. Url of the thumbnail for the result.
|
|
|
|
thumb_width (:obj:`int`): Optional. Thumbnail width.
|
|
|
|
thumb_height (:obj:`int`): Optional. Thumbnail height.
|
|
|
|
|
2016-04-13 14:59:48 +02:00
|
|
|
"""
|
|
|
|
|
2021-05-29 16:18:16 +02:00
|
|
|
__slots__ = (
|
2022-05-05 17:40:22 +02:00
|
|
|
"reply_markup",
|
|
|
|
"thumb_width",
|
|
|
|
"thumb_height",
|
|
|
|
"hide_url",
|
|
|
|
"url",
|
|
|
|
"title",
|
|
|
|
"description",
|
|
|
|
"input_message_content",
|
|
|
|
"thumb_url",
|
2021-05-29 16:18:16 +02:00
|
|
|
)
|
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
def __init__(
|
|
|
|
self,
|
2021-10-08 08:17:00 +02:00
|
|
|
id: str, # pylint: disable=redefined-builtin
|
2020-10-09 17:22:07 +02:00
|
|
|
title: str,
|
2022-05-05 17:40:22 +02:00
|
|
|
input_message_content: "InputMessageContent",
|
2022-01-19 18:00:21 +01:00
|
|
|
reply_markup: InlineKeyboardMarkup = None,
|
2020-10-09 17:22:07 +02:00
|
|
|
url: str = None,
|
|
|
|
hide_url: bool = None,
|
|
|
|
description: str = None,
|
|
|
|
thumb_url: str = None,
|
|
|
|
thumb_width: int = None,
|
|
|
|
thumb_height: int = None,
|
2022-10-07 11:51:53 +02:00
|
|
|
*,
|
|
|
|
api_kwargs: JSONDict = None,
|
2020-10-09 17:22:07 +02:00
|
|
|
):
|
2016-04-13 14:59:48 +02:00
|
|
|
|
|
|
|
# Required
|
2022-10-07 11:51:53 +02:00
|
|
|
super().__init__(InlineQueryResultType.ARTICLE, id, api_kwargs=api_kwargs)
|
2016-04-13 14:59:48 +02:00
|
|
|
self.title = title
|
2016-04-16 17:30:18 +02:00
|
|
|
self.input_message_content = input_message_content
|
2016-04-13 14:59:48 +02:00
|
|
|
|
|
|
|
# Optional
|
2019-11-23 17:05:03 +01:00
|
|
|
self.reply_markup = reply_markup
|
|
|
|
self.url = url
|
|
|
|
self.hide_url = hide_url
|
|
|
|
self.description = description
|
|
|
|
self.thumb_url = thumb_url
|
|
|
|
self.thumb_width = thumb_width
|
|
|
|
self.thumb_height = thumb_height
|