telegram.ext.CommandHandler¶
-
class
telegram.ext.
CommandHandler
(command, callback, filters=None, allow_edited=False, pass_args=False, pass_update_queue=False, pass_job_queue=False, pass_user_data=False, pass_chat_data=False)¶ Bases:
telegram.ext.handler.Handler
Handler class to handle Telegram commands.
Commands are Telegram messages that start with
/
, optionally followed by an@
and the bot’s name and/or some additional text.-
command
¶ str
| List[str
] – The command or list of commands this handler should listen for.
-
callback
¶ callable
– The callback function for this handler.
-
filters
¶ telegram.ext.BaseFilter
– Optional. Only allow updates with these Filters.
-
allow_edited
¶ bool
– Optional. Determines Whether the handler should also accept edited messages.
-
pass_args
¶ bool
– Optional. Determines whether the handler should be passedargs
.
-
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: - command (
str
| List[str
]) – The command or list of commands this handler should listen for. - 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. - filters (
telegram.ext.BaseFilter
, optional) – A filter inheriting fromtelegram.ext.filters.BaseFilter
. Standard filters can be found intelegram.ext.filters.Filters
. Filters can be combined using bitwise operators (& for and, | for or, ~ for not). - allow_edited (
bool
, optional) – Determines whether the handler should also accept edited messages. Default isFalse
. - pass_args (
bool
, optional) – Determines whether the handler should be passed the arguments passed to the command as a keyword argument calledargs
. It will contain a list of strings, which is the text following the command split on single or consecutive whitespace characters. 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
. - 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)¶ 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 (
-