telegram.ext.TypeHandler¶
-
class
telegram.ext.TypeHandler(type, callback, strict=False, pass_update_queue=False, pass_job_queue=False)¶ Bases:
telegram.ext.handler.HandlerHandler class to handle updates of custom types.
-
callback¶ callable– The callback function for this handler.
-
strict¶ bool– Optional. Usetypeinstead ofisinstance. Default isFalse
-
pass_update_queue¶ bool– Optional. Determines whetherupdate_queuewill be passed to the callback function.
-
pass_job_queue¶ bool– Optional. Determines whetherjob_queuewill be passed to the callback function.
Parameters: - type (
type) – Thetypeof updates this handler should process, as determined byisinstance - callback (
callable) – A function that takesbot, updateas positional arguments. It will be called when thecheck_updatehas determined that an update should be processed by this handler. - strict (
bool, optional) – Usetypeinstead ofisinstance. Default isFalse - pass_update_queue (
bool, optional) – If set toTrue, a keyword argument calledupdate_queuewill be passed to the callback function. It will be theQueueinstance used by thetelegram.ext.Updaterandtelegram.ext.Dispatcherthat contains new updates which can be used to insert updates. Default isFalse. - pass_job_queue (
bool, optional) – If set toTrue, a keyword argument calledjob_queuewill be passed to the callback function. It will be atelegram.ext.JobQueueinstance created by thetelegram.ext.Updaterwhich can be used to schedule new jobs. Default isFalse.
-
check_update(update)¶ Determines whether an update should be passed to this handlers
callback.Parameters: update ( telegram.Update) – Incoming telegram update.Returns: bool
-
handle_update(update, dispatcher)¶ Send the update to the
callback.Parameters: - update (
telegram.Update) – Incoming telegram update. - dispatcher (
telegram.ext.Dispatcher) – Dispatcher that originated the Update.
- update (
-