InlineQueryHandler¶
- class telegram.ext.InlineQueryHandler(callback, pattern=None, block=True, chat_types=None)[source]¶
Bases:
telegram.ext.BaseHandler
BaseHandler class to handle Telegram updates that contain a
telegram.Update.inline_query
. Optionally based on a regex. Read the documentation of there
module for more information.Warning
When setting
block
toFalse
, you cannot rely on adding custom attributes totelegram.ext.CallbackContext
. See its docs for more info.telegram.InlineQuery.chat_type
will not be set for inline queries from secret chats and may not be set for inline queries coming from third-party clients. These updates won’t be handled, ifchat_types
is passed.
Examples
Available In
- Parameters:
callback (coroutine function) –
The callback function for this handler. Will be called when
check_update()
has determined that an update should be processed by this handler. Callback signature:async def callback(update: Update, context: CallbackContext)
The return value of the callback is usually ignored except for the special case of
telegram.ext.ConversationHandler
.pattern (
str
|re.Pattern
, optional) – Regex pattern. If notNone
,re.match()
is used ontelegram.InlineQuery.query
to determine if an update should be handled by this handler.Determines whether the return value of the callback should be awaited before processing the next handler in
telegram.ext.Application.process_update()
. Defaults toTrue
.See also
chat_types (list[
str
], optional) –List of allowed chat types. If passed, will only handle inline queries with the appropriate
telegram.InlineQuery.chat_type
.Added in version 13.5.
- pattern[source]¶
Optional. Regex pattern to test
telegram.InlineQuery.query
against.- Type:
- block[source]¶
Determines whether the return value of the callback should be awaited before processing the next handler in
telegram.ext.Application.process_update()
.- Type:
- check_update(update)[source]¶
Determines whether an update should be passed to this handler’s
callback
.- Parameters:
update (
telegram.Update
|object
) – Incoming update.- Returns:
- collect_additional_context(context, update, application, check_result)[source]¶
Add the result of
re.match(pattern, update.inline_query.query)
toCallbackContext.matches
as list with one element.