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.
-
callback
¶ callable
– The callback function for this handler.
-
strict
¶ bool
– Optional. Usetype
instead ofisinstance
. Default isFalse
-
pass_update_queue
¶ bool
– Optional. Determines whetherupdate_queue
will be passed to the callback function.
-
pass_job_queue
¶ bool
– Optional. Determines whetherjob_queue
will be passed to the callback function.
Parameters: - type (
type
) – Thetype
of updates this handler should process, as determined byisinstance
- callback (
callable
) – A function that takesbot, update
as positional arguments. It will be called when thecheck_update
has determined that an update should be processed by this handler. - strict (
bool
, optional) – Usetype
instead ofisinstance
. Default isFalse
- pass_update_queue (
bool
, optional) – If set toTrue
, a keyword argument calledupdate_queue
will be passed to the callback function. It will be theQueue
instance used by thetelegram.ext.Updater
andtelegram.ext.Dispatcher
that contains new updates which can be used to insert updates. Default isFalse
. - pass_job_queue (
bool
, optional) – If set toTrue
, a keyword argument calledjob_queue
will be passed to the callback function. It will be atelegram.ext.JobQueue
instance created by thetelegram.ext.Updater
which 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 (
-