telegram.ext.ChosenInlineResultHandler

class telegram.ext.ChosenInlineResultHandler(callback, block=True, pattern=None)

Bases: telegram.ext.Handler

Handler class to handle Telegram updates that contain telegram.Update.chosen_inline_result.

Warning

When setting block to False, you cannot rely on adding custom attributes to telegram.ext.CallbackContext. See its docs for more info.

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.

• block (bool, optional) – Determines whether the return value of the callback should be awaited before processing the next handler in telegram.ext.Application.process_update(). Defaults to True.

• pattern (str | re.Pattern, optional) –

  Regex pattern. If not None, re.match() is used on telegram.ChosenInlineResult.result_id to determine if an update should be handled by this handler. This is accessible in the callback as telegram.ext.CallbackContext.matches.

  New in version 13.6.

callback

The callback function for this handler.

Type

coroutine function

block

Determines whether the return value of the callback should be awaited before processing the next handler in telegram.ext.Application.process_update().

Type

bool

pattern

Optional. Regex pattern to test telegram.ChosenInlineResult.result_id against.

New in version 13.6.

Type

Pattern

check_update(update)

Determines whether an update should be passed to this handler’s callback.

Parameters

update (telegram.Update | object) – Incoming update.

Returns

bool | re.match

collect_additional_context(context, update, application, check_result)

This function adds the matched regex pattern result to telegram.ext.CallbackContext.matches.