telegram.ext.StringCommandHandler¶
-
class
telegram.ext.
StringCommandHandler
(command, callback, pass_args=False, pass_update_queue=False, pass_job_queue=False)¶ Bases:
telegram.ext.handler.Handler
Handler class to handle string commands. Commands are string updates that start with
/
.Note
This handler is not used to handle Telegram
telegram.Update
, but strings manually put in the queue. For example to send messages with the bot using command line or API.-
command
¶ str
– The command this handler should listen for.
-
callback
¶ callable
– The callback function for this handler.
-
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.
Parameters: - command (
str
) – The command 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 a command should be processed by this handler. - 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 a class:telegram.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 ( str
) – An incomming command.Returns: bool
-
handle_update
(update, dispatcher)¶ Send the update to the
callback
.Parameters: - update (
str
) – An incomming command. - dispatcher (
telegram.ext.Dispatcher
) – Dispatcher that originated the command.
- update (
-