telegram.ext.MessageHandler

class telegram.ext.MessageHandler(filters, callback, pass_update_queue=False, pass_job_queue=False, pass_user_data=False, pass_chat_data=False, message_updates=None, channel_post_updates=None, edited_updates=None)

Bases: telegram.ext.handler.Handler

Handler class to handle telegram messages. They might contain text, media or status updates.

filters

Only allow updates with these Filters. See telegram.ext.filters for a full list of all available filters.

Type:Filter
callback

The callback function for this handler.

Type:callable
pass_update_queue

Determines whether update_queue will be passed to the callback function.

Type:bool
pass_job_queue

Determines whether job_queue will be passed to the callback function.

Type:bool
pass_user_data

Determines whether user_data will be passed to the callback function.

Type:bool
pass_chat_data

Determines whether chat_data will be passed to the callback function.

Type:bool
message_updates

Should “normal” message updates be handled? Default is None.

Type:bool
channel_post_updates

Should channel posts updates be handled? Default is None.

Type:bool
edited_updates

Should “edited” message updates be handled? Default is None.

Type:bool

Note

pass_user_data and pass_chat_data determine whether a dict you can use to keep any data in will be sent to the callback function. Related to either the user or the chat that the update was sent in. For each update from the same user or in the same chat, it will be the same dict.

Note that this is DEPRECATED, and you should use context based callbacks. See https://git.io/fxJuV for more info.

Parameters:
  • filters (telegram.ext.BaseFilter, optional) – A filter inheriting from telegram.ext.filters.BaseFilter. Standard filters can be found in telegram.ext.filters.Filters. Filters can be combined using bitwise operators (& for and, | for or, ~ for not). Default is telegram.ext.filters.Filters.update. This defaults to all message_type updates being: message, edited_message, channel_post and edited_channel_post. If you don’t want or need any of those pass ~Filters.update.* in the filter argument.
  • callback (callable) –

    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 for context based API:

    def callback(update: Update, context: CallbackContext)

    The return value of the callback is usually ignored except for the special case of telegram.ext.ConversationHandler.

  • pass_update_queue (bool, optional) – If set to True, a keyword argument called update_queue will be passed to the callback function. It will be the Queue instance used by the telegram.ext.Updater and telegram.ext.Dispatcher that contains new updates which can be used to insert updates. Default is False. DEPRECATED: Please switch to context based callbacks.
  • pass_job_queue (bool, optional) – If set to True, a keyword argument called job_queue will be passed to the callback function. It will be a telegram.ext.JobQueue instance created by the telegram.ext.Updater which can be used to schedule new jobs. Default is False. DEPRECATED: Please switch to context based callbacks.
  • pass_user_data (bool, optional) – If set to True, a keyword argument called user_data will be passed to the callback function. Default is False. DEPRECATED: Please switch to context based callbacks.
  • pass_chat_data (bool, optional) – If set to True, a keyword argument called chat_data will be passed to the callback function. Default is False. DEPRECATED: Please switch to context based callbacks.
  • message_updates (bool, optional) – Should “normal” message updates be handled? Default is None. DEPRECATED: Please switch to filters for update filtering.
  • channel_post_updates (bool, optional) – Should channel posts updates be handled? Default is None. DEPRECATED: Please switch to filters for update filtering.
  • edited_updates (bool, optional) – Should “edited” message updates be handled? Default is None. DEPRECATED: Please switch to filters for update filtering.
Raises:

ValueError
check_update(update)

Determines whether an update should be passed to this handlers callback.

Parameters:update (telegram.Update) – Incoming telegram update.
Returns:bool
collect_additional_context(context, update, dispatcher, check_result)

Prepares additional arguments for the context. Override if needed.

Parameters: