telegram.ext.Handler¶
-
class
telegram.ext.
Handler
(callback, pass_update_queue=False, pass_job_queue=False, pass_user_data=False, pass_chat_data=False)¶ Bases:
object
The base class for all update handlers. Create custom handlers by inheriting from it.
-
callback
¶ callable
– The callback function for this handler.
-
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.
-
pass_user_data
¶ bool
– Optional. Determines whetheruser_data
will be passed to the callback function.
-
pass_chat_data
¶ bool
– Optional. Determines whetherchat_data
will be passed to the callback function.
Note
pass_user_data
andpass_chat_data
determine whether adict
you can use to keep any data in will be sent to thecallback
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 samedict
.Parameters: - 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. - 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
. - pass_user_data (
bool
, optional) – If set toTrue
, a keyword argument calleduser_data
will be passed to the callback function. Default isFalse
. - pass_chat_data (
bool
, optional) – If set toTrue
, a keyword argument calledchat_data
will be passed to the callback function. Default isFalse
.
-
check_update
(update)¶ This method is called to determine if an update should be handled by this handler instance. It should always be overridden.
Parameters: update ( str
|telegram.Update
) – The update to be tested.Returns: bool
-
collect_optional_args
(dispatcher, update=None)¶ Prepares the optional arguments that are the same for all types of handlers.
Parameters: dispatcher ( telegram.ext.Dispatcher
) – The dispatcher.
-
handle_update
(update, dispatcher)¶ This method is called if it was determined that an update should indeed be handled by this instance. It should also be overridden, but in most cases call
self.callback(dispatcher.bot, update)
, possibly along with optional arguments. To work with theConversationHandler
, this method should return the value returned fromself.callback
Parameters: - update (
str
|telegram.Update
) – The update to be handled. - dispatcher (
telegram.ext.Dispatcher
) – The dispatcher to collect optional args.
- update (
-