API docs for “services.scheduler.botService”

Class s.s.botService(service.MultiService):

Part of services.scheduler View Source View In Hierarchy

No class docstring
Method __init__ Undocumented
Method callLater executes function after time seconds with arguments *args and keyword arguments **kwargs
Method cancelCallLater cancel a delayed call
Method callPeriodic executes function every delay seconds with keyword arguments **kwargs

Inherited from MultiService:

Method privilegedStartService Do preparation work for starting the service.
Method startService Start the service.
Method stopService Stop the service.
Method getServiceNamed Get the child service with a given name.
Method __iter__ Get an iterator over all child services.
Method addService Add a child service.
Method removeService Remove a child service.

Inherited from Service (via MultiService):

Method __getstate__ Undocumented
Method setName Set the name of the service.
Method setServiceParent Set the parent of the service.
Method disownServiceParent Use this API to remove an IService from an IServiceCollection.
def __init__(self, root, parent): (source)
def callLater(self, time, function, *args, **kwargs): (source)
executes function after time seconds with arguments *args and keyword arguments **kwargs
Parameterstimeseconds to wait before executing function (type: int )
functionthe function to call (type: callable )
*argsarguments for the function (type: tuple )
**kwargskeyworded arguments for the function (type: dict )
def cancelCallLater(self, callID): (source)
cancel a delayed call
ParameterscallIDthe call to cancel (id returned in callLater)
def callPeriodic(self, delay, function, kwargs={}): (source)
executes function every delay seconds with keyword arguments **kwargs
Parametersdelaythe delay between two runs of the function (type: int )
functionthe function to be called (type: callable )
kwargsthe keyworded arguments for the function (type: dict )
Noteadd the possibility to give a *args-tuple (need to know how to merge two tuples)
API Documentation for OtfBot - the friendly Bot, generated by pydoctor at 2010-01-04 01:40:56.