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 passed args.

pass_update_queue

bool – Optional. Determines whether update_queue will be passed to the callback function.

pass_job_queue

bool – Optional. Determines whether job_queue will be passed to the callback function.

Parameters:
  • command (str) – The command this handler should listen for.
  • callback (callable) – A function that takes bot, update as positional arguments. It will be called when the check_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 called args. It will contain a list of strings, which is the text following the command split on single or consecutive whitespace characters. Default is False
  • pass_update_queue (bool, optional) – If set to True, a keyword argument called update_queue will be passed to the callback function. It will be the Queue instance used by the telegram.ext.Updater and telegram.ext.Dispatcher that contains new updates which can be used to insert updates. Default is False.
  • pass_job_queue (bool, optional) – If set to True, a keyword argument called job_queue will be passed to the callback function. It will be a class:telegram.ext.JobQueue instance created by the telegram.ext.Updater which can be used to schedule new jobs. Default is False.
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.