telegram.ext.stringcommandhandler module

This module contains the StringCommandHandler class

class telegram.ext.stringcommandhandler.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 /.

Parameters:
  • command (str) – The name of the command this handler should listen for.
  • callback (function) – A function that takes bot, update as positional arguments. It will be called when the check_update has determined that an update should be processed by this handler.
  • pass_args (optional[bool]) – If 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 (optional[bool]) – 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 Updater and Dispatcher that contains new updates which can be used to insert updates. Default is False.
  • pass_job_queue (optional[bool]) – If set to True, a keyword argument called job_queue will be passed to the callback function. It will be a JobQueue instance created by the Updater which can be used to schedule new jobs. Default is False.
check_update(update)
handle_update(update, dispatcher)