telegram.InlineQuery¶
- class telegram.InlineQuery(*args, **kwargs)[source]¶
Bases:
telegram.TelegramObject
This object represents an incoming inline query. When the user sends an empty query, your bot could return some default or trending results.
Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their
id
is equal.Changed in version 20.0:
The following are now keyword-only arguments in Bot methods:
{read, write, connect, pool}_timeout
,answer.api_kwargs
,auto_pagination
. Use a named argument for those, and notice that some positional arguments changed position as a result.
- Parameters
from_user (
telegram.User
) – Sender.offset (
str
) – Offset of the results to be returned, can be controlled by the bot.Type of the chat, from which the inline query was sent. Can be either
'sender'
for a private chat with the inline query sender,'private'
,'group'
,'supergroup'
or'channel'
. The chat type should be always known for requests sent from official clients and most third-party clients, unless the request was sent from a secret chat.New in version 13.5.
location (
telegram.Location
, optional) – Sender location, only for bots that request user location.bot (
telegram.Bot
, optional) – The Bot to use for instance methods.
- chat_type[source]¶
Type of the chat, from which the inline query was sent.
New in version 13.5.
- Type
str
, optional
- MAX_RESULTS = 50[source]¶
telegram.constants.InlineQueryLimit.RESULTS
New in version 13.2.
- MAX_SWITCH_PM_TEXT_LENGTH = 64[source]¶
telegram.constants.InlineQueryLimit.SWITCH_PM_TEXT_LENGTH
New in version 20.0.
- async answer(results, cache_time=None, is_personal=None, next_offset=None, switch_pm_text=None, switch_pm_parameter=None, *, current_offset=None, auto_pagination=False, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)[source]¶
Shortcut for:
await bot.answer_inline_query( update.inline_query.id, *args, current_offset=self.offset if auto_pagination else None, **kwargs )
For the documentation of the arguments, please see
telegram.Bot.answer_inline_query()
.Changed in version 20.0: Raises
ValueError
instead ofTypeError
.- Keyword Arguments
auto_pagination (
bool
, optional) – If set toTrue
,offset
will be passed ascurrent_offset
totelegram.Bot.answer_inline_query()
. Defaults toFalse
.- Raises
ValueError – If both
current_offset
andauto_pagination
are supplied.