telegram.InlineQuery¶
-
class
telegram.
InlineQuery
(id: str, from_user: telegram.user.User, query: str, offset: str, location: telegram.files.location.Location = None, bot: Bot = None, **kwargs)¶ Bases:
telegram.base.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.Note
- In Python from is a reserved word, use from_user instead.
-
id
¶ Unique identifier for this query.
Type: str
-
from_user
¶ Sender.
Type: telegram.User
-
location
¶ Optional. Sender location, only for bots that request user location.
Type: telegram.Location
-
query
¶ Text of the query (up to 256 characters).
Type: str
-
offset
¶ Offset of the results to be returned, can be controlled by the bot.
Type: str
Parameters: - id (
str
) – Unique identifier for this query. - from_user (
telegram.User
) – Sender. - location (
telegram.Location
, optional) – Sender location, only for bots that request user location. - query (
str
) – Text of the query (up to 256 characters). - offset (
str
) – Offset of the results to be returned, can be controlled by the bot. - bot (
telegram.Bot
, optional) – The Bot to use for instance methods. - **kwargs (
dict
) – Arbitrary keyword arguments.
-
answer
(*args, auto_pagination: bool = False, **kwargs) → bool¶ Shortcut for:
bot.answer_inline_query(update.inline_query.id, *args, current_offset=self.offset if auto_pagination else None, **kwargs)
Parameters: - results (List[
telegram.InlineQueryResult
] | Callable) – A list of results for the inline query. In caseauto_pagination
is set toTrue
,results
may also be a callable may also be a callable accepts the current page index starting from 0. It must return either a list oftelegram.InlineResult
instances orNone
if there are no more results. - cache_time (
int
, optional) – The maximum amount of time in seconds that the result of the inline query may be cached on the server. Defaults to 300. - is_personal (
bool
, optional) – PassTrue
, if results may be cached on the server side only for the user that sent the query. By default, results may be returned to any user who sends the same query. - next_offset (
str
, optional) – Pass the offset that a client should send in the next query with the same text to receive more results. Pass an empty string if there are no more results or if you don’t support pagination. Offset length can’t exceed 64 bytes. - switch_pm_text (
str
, optional) – If passed, clients will display a button with specified text that switches the user to a private chat with the bot and sends the bot a start message with the parameter switch_pm_parameter. - switch_pm_parameter (
str
, optional) – Deep-linking parameter for the /start message sent to the bot when user presses the switch button. 1-64 characters, only A-Z, a-z, 0-9, _ and - are allowed. - auto_pagination (
bool
, optional) – If set toTrue
,offset
will be passed ascurrent_offset
to :meth:telegram.Bot.answer_inline_query`. Defaults toFalse
.
- results (List[