telegram.ext.TypeHandler

class telegram.ext.TypeHandler(type, callback, strict=False, pass_update_queue=False, pass_job_queue=False)

Bases: telegram.ext.handler.Handler

Handler class to handle updates of custom types.

type

type – The type of updates this handler should process.

callback

callable – The callback function for this handler.

strict

bool – Use type instead of isinstance. Default is False.

pass_update_queue

bool – Determines whether update_queue will be passed to the callback function.

pass_job_queue

bool – Determines whether job_queue will be passed to the callback function.

Parameters:
  • type (type) – The type of updates this handler should process, as determined by isinstance
  • 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.

  • strict (bool, optional) – Use type instead of isinstance. Default is False
  • 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.
check_update(update)

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

Parameters:update (telegram.Update) – Incoming telegram update.
Returns:bool