| author | Sandro Knauß <knauss@netzguerilla.net> |
| Fri, 27 Jan 2012 15:01:59 +0100 | |
| branch | devel |
| changeset 114 | 1ed072cc6793 |
| parent 109 | 935b5fcaf152 |
| child 115 | 323d06431100 |
| permissions | -rw-r--r-- |
| 92 | 1 |
# -*- coding: utf-8 -*- |
|
106
d2992f011930
controller/user moved to model
Sandro Knauß <knauss@netzguerilla.net>
parents:
102
diff
changeset
|
2 |
from ..model.user import with_user |
|
114
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
3 |
from ..validate import validate, boolean, validateHash |
| 92 | 4 |
class Interface(object): |
5 |
'''class for a xmlrpc user |
|
6 |
''' |
|
7 |
||
|
114
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
8 |
@validate(kwd="detailed", func=boolean, need=False) |
|
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
9 |
@validate(kwd="id", func=validateHash, need=False) |
| 92 | 10 |
@with_user |
11 |
def status(self, user, id=None, detailed=False): |
|
12 |
'''Gibt den aktuellen Status eines Auftrages oder Mehreren zurück. |
|
13 |
||
14 |
Keywords: |
|
15 |
apikey[string]: Der API Key |
|
16 |
id[hash]: Eine Auftragsnummer |
|
17 |
detailed[boolean]: Details ausgeben |
|
18 |
||
19 |
Return: |
|
20 |
jobs[list]: Eine Liste der Aufträge. |
|
21 |
job.name[string]: Angebener Name |
|
22 |
job.status[string]: Status des Auftrages |
|
23 |
||
24 |
||
25 |
''' |
|
|
114
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
26 |
if id or detailed: |
|
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
27 |
return str(user),id,detailed |
|
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
28 |
else: |
|
1ed072cc6793
reconstructing validate decorator
Sandro Knauß <knauss@netzguerilla.net>
parents:
109
diff
changeset
|
29 |
return str(user) |
| 92 | 30 |
#return user.status(id,detailed) |
31 |
return "" |
|
32 |
||
33 |
@with_user |
|
34 |
def stop(self, user, id): |
|
35 |
'''Stoppt den angegeben Auftrag. |
|
36 |
||
37 |
Keywords: |
|
38 |
apikey[string]: Der API Key |
|
39 |
id[hash]: Eine Auftragsnummer |
|
40 |
||
41 |
Return: |
|
42 |
||
43 |
''' |
|
44 |
return "" |
|
45 |
||
46 |
@with_user |
|
47 |
def sms(self, user, message, recipients, route="default"): |
|
48 |
'''Versendet eine SMS. |
|
49 |
||
50 |
Keywords: |
|
51 |
apikey[string]: Der API Key |
|
52 |
message[string]: Nachricht |
|
53 |
recipients[list]: eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
|
54 |
route[string|list]: Route über den geschickt werden soll, |
|
55 |
oder eine Liste von Routen, um Fallbacks anzugeben |
|
56 |
||
57 |
Return: |
|
58 |
id[hash]: Die ID des Auftrages |
|
59 |
||
60 |
''' |
|
61 |
return "" |
|
62 |
||
63 |
@with_user |
|
64 |
def fax(self, user, subject, fax, recipients, route="default"): |
|
65 |
'''Versendet ein FAX. |
|
66 |
||
67 |
Keywords: |
|
68 |
apikey[string]: Der API Key |
|
69 |
subject[string]: Der Betreff |
|
70 |
fax[string]: Das PDF base64 kodiert |
|
71 |
recipients[list]: Eine Liste von Emfänger-Nummern (gemäß ITU-T E.123) |
|
72 |
route[string|list]: Route über den geschickt werden soll, |
|
73 |
oder eine Liste von Routen, um Fallbacks anzugeben |
|
74 |
||
75 |
Return: |
|
76 |
id[hash]: Die ID des Auftrages |
|
77 |
||
78 |
''' |
|
79 |
return "" |
|
80 |
||
81 |
@with_user |
|
82 |
def mail(self, user, subject, body, recipients, frm, route="default"): |
|
83 |
'''Versendet eine Email. |
|
84 |
||
85 |
Keywords: |
|
86 |
apikey[string]: Der API Key |
|
87 |
subject[string]: Der Betreff |
|
88 |
body[string]: Der Email Body |
|
89 |
recipients[list]: Eine Liste von Emailadressen |
|
90 |
frm[string]: Die Absender Emailadresse |
|
91 |
route[string|list]: Route über den geschickt werden soll, |
|
92 |
oder eine Liste von Routen, um Fallbacks anzugeben |
|
93 |
||
94 |
Return: |
|
95 |
id[hash]: Die ID des Auftrages |
|
96 |
||
97 |
''' |
|
98 |
return "" |
|
99 |
||
100 |
@with_user |
|
101 |
def routes(self, user, typ): |
|
102 |
'''Gibt eine Liste aller verfügbaren Provider zurück. |
|
103 |
||
104 |
Keywords: |
|
105 |
apikey[string]: Der API Key |
|
106 |
typ[string]: Der Typ zu dem die Providerloste ausgeben werden soll |
|
107 |
Einer der Liste ["sms","fax","mail"] |
|
108 |
||
109 |
Return: |
|
110 |
providerlist[list]: Eine Liste aller möglichen Provider |
|
111 |
||
112 |
''' |
|
113 |
return "" |
|
114 |
||
115 |
@with_user |
|
116 |
def defaultRoute(self, user, typ): |
|
117 |
'''Gibt den Standardprovider zurück. |
|
118 |
|
|
119 |
Keywords: |
|
120 |
apikey[string]: Der API Key |
|
| 109 | 121 |
typ[string]: Der Typ zu dem die Providerliste ausgeben werden soll |
| 92 | 122 |
Einer der Liste ["sms","fax","mail"] |
123 |
||
124 |
Return: |
|
125 |
provider[string]: Der Standardprovider für den angeben Typ |
|
126 |
||
127 |
||
128 |
''' |
|
129 |
return "" |
|
130 |
||
131 |
@with_user |
|
132 |
def statistic(self, user): |
|
133 |
'''Gibt eine Statik zurück über die versendendeten Nachrichten und des Preises. |
|
134 |
||
135 |
Keywords: |
|
136 |
apikey[string]: Der API Key |
|
137 |
||
138 |
Return: |
|
139 |
statistic[list]: Eine Liste nach Nachrichtentypen |
|
140 |
''' |
|
141 |
return "" |
|
142 |
||
143 |