--- a/iro/user.py Fri Nov 18 22:47:25 2011 +0100
+++ b/iro/user.py Tue Dec 06 19:44:50 2011 +0100
@@ -38,9 +38,20 @@
self.features=["mail", "sms", "fax", ]
def status(self,id=None,detailed=False):
- '''
- gets the status for a job
- if the id is None all Jobs of an user are given back
+ u'''Gibt den aktuellen Status eines Auftrages zurück.
+
+ Keywords:
+ id[hash]: Eine Auftragsnummer
+ default - alle Aufträge ausgeben
+ detailed[boolean]: Details ausgeben
+ default - False
+
+ Return:
+ jobs[list]: Eine Liste der Aufträge.
+ job.name[string]: Angebener Name
+ job.status[string]: Status des Auftrages
+
+
'''
try:
jobs={}
@@ -66,8 +77,13 @@
return {}
def stop(self,id):
- '''
- stops an job with id
+ u'''Stoppt den angegeben Auftrag.
+
+ Keywords:
+ id[hash]: Eine Auftragsnummer
+
+ Return:
+
'''
try:
job=self.jobs[id]
@@ -78,8 +94,17 @@
def startSMS(self, message, recipients, provider="default"):
- '''
- starts the SMS with message to recipients
+ u'''Versendet eine SMS.
+
+ Keywords:
+ message[string]: Nachricht
+ recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
+ provider[string]: Provider über den geschickt werden soll;
+ default - verschickt über den Standardprovider
+
+ Return:
+ id[hash]: Die ID des Auftrages
+
'''
if not "sms" in self.features:
raise NotSupportedFeature("sms")
@@ -89,8 +114,18 @@
def startFAX(self, subject, fax, recipients, provider="default"):
- '''
- starts the FAX with the pdf file fax and the subject
+ u'''Versendet ein FAX.
+
+ Keywords:
+ subject[string]: der Betreff
+ fax[string]: das pdf base64 kodiert
+ recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)
+ provider[string]: Provider über den geschickt werden soll;
+ default - verschickt über den Standardprovider
+
+ Return:
+ id[hash]: Die ID des Auftrages
+
'''
logger.debug("startFAX(%s,%s,%s,%s)"%(subject, fax, recipients, provider))
if not "fax" in self.features:
@@ -105,6 +140,20 @@
return id
def startMail(self, subject, body, recipients, frm, provider="default"):
+ u'''Versendet eine Email.
+
+ Keywords:
+ subject[string]: der Betreff
+ body[string]: der Email Body
+ recipients[list]: eine Liste von Emailadressen
+ frm[string]: Die Absender Emailadresse
+ provider[string]: Provider über den geschickt werden soll;
+ default - verschickt über den Standardprovider
+
+ Return:
+ id[hash]: Die ID des Auftrages
+
+ '''
if not "mail" in self.features:
raise NotSupportedFeature("mail")
logger.debug("startMail(%s,%s,%s,%s,%s)"%(subject, body, recipients, frm, provider))
@@ -112,17 +161,38 @@
self.jobs[id]=self.jobqueue[id]
return id
- def getProvider(self, name):
- if not name in self.features:
- raise NotSupportedFeature(name)
+ def getProvider(self, typ):
+ u'''Gibt eine Liste aller verfügbaren Provider zurück.
+
+ Keywords:
+ typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll
+ Einer der Liste ["sms","fax","mail"]
+
+ Return:
+ providerlist[list]: Eine Liste aller möglichen Provider
+
+ '''
+ if not typ in self.features:
+ raise NotSupportedFeature(typ)
- return self.jobqueue.providerlist.getProviderlist(name)
+ return self.jobqueue.providerlist.getProviderlist(typ)
- def getDefaultProvider(self, name):
- if not name in self.features:
- raise NotSupportedFeature(name)
+ def getDefaultProvider(self, typ):
+ u'''Gibt den Standardprovider zurück.
+
+ Keywords:
+ typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll
+ Einer der Liste ["sms","fax","mail"]
+
+ Return:
+ provider[string]: Der Standardprovider für den angeben Typ
+
+
+ '''
+ if not typ in self.features:
+ raise NotSupportedFeature(typ)
- return self.jobqueue.providerlist.getDefault(name)["name"]
+ return self.jobqueue.providerlist.getDefault(typ)["name"]
class Admin(User):
def __init__(self, name, jobqueue):