doc/current.html
changeset 73 f2f247a5b6c9
parent 72 e7b44716a564
child 74 c471fed3cab8
equal deleted inserted replaced
72:e7b44716a564 73:f2f247a5b6c9
    66 			</div>
    66 			</div>
    67 		</div><div class="item" id="api-methods">
    67 		</div><div class="item" id="api-methods">
    68 			<h3>Methoden</h3>
    68 			<h3>Methoden</h3>
    69 			<div class="item" id="method-startSMS">
    69 			<div class="item" id="method-startSMS">
    70 				<h4>StartSMS</h4>
    70 				<h4>StartSMS</h4>
    71 				<p><code>startSMS</code></p>
    71 				<p><code>startSMS(self, message, recipients, provider='default')</code></p>
    72 				<p>Versendet eine SMS.</p>
    72 				<p>Versendet eine SMS.</p>
    73 				<h5>Parameter</h5>
    73 				<h5>Parameter</h5>
    74 				<table class="docs">
    74 				<table class="docs">
    75 					<thead>
    75 					<thead>
    76 						<tr>
    76 						<tr>
    89 							<td>list</td>
    89 							<td>list</td>
    90 							<td> eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)</td>
    90 							<td> eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)</td>
    91 						</tr><tr>
    91 						</tr><tr>
    92 							<td>provider</td>
    92 							<td>provider</td>
    93 							<td>string</td>
    93 							<td>string</td>
    94 							<td> Provider über den geschickt werden soll;
    94 							<td> Provider über den geschickt werden soll</td>
    95 default - verschickt über den Standardprovider</td>
       
    96 						</tr>
    95 						</tr>
    97 					</tbody>
    96 					</tbody>
    98 				</table>
    97 				</table>
    99 				<h5>Ausgabe</h5>
    98 				<h5>Ausgabe</h5>
   100 				<table class="docs">
    99 				<table class="docs">
   113 						</tr>
   112 						</tr>
   114 					</tbody>
   113 					</tbody>
   115 				</table>
   114 				</table>
   116 			</div><div class="item" id="method-startFAX">
   115 			</div><div class="item" id="method-startFAX">
   117 				<h4>StartFAX</h4>
   116 				<h4>StartFAX</h4>
   118 				<p><code>startFAX</code></p>
   117 				<p><code>startFAX(self, subject, fax, recipients, provider='default')</code></p>
   119 				<p>Versendet ein FAX.</p>
   118 				<p>Versendet ein FAX.</p>
   120 				<h5>Parameter</h5>
   119 				<h5>Parameter</h5>
   121 				<table class="docs">
   120 				<table class="docs">
   122 					<thead>
   121 					<thead>
   123 						<tr>
   122 						<tr>
   140 							<td>list</td>
   139 							<td>list</td>
   141 							<td> eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)</td>
   140 							<td> eine Liste von Emfänger-Nummern (gemäß ITU-T E.123)</td>
   142 						</tr><tr>
   141 						</tr><tr>
   143 							<td>provider</td>
   142 							<td>provider</td>
   144 							<td>string</td>
   143 							<td>string</td>
   145 							<td> Provider über den geschickt werden soll;
   144 							<td> Provider über den geschickt werden soll</td>
   146 default - verschickt über den Standardprovider</td>
       
   147 						</tr>
   145 						</tr>
   148 					</tbody>
   146 					</tbody>
   149 				</table>
   147 				</table>
   150 				<h5>Ausgabe</h5>
   148 				<h5>Ausgabe</h5>
   151 				<table class="docs">
   149 				<table class="docs">
   164 						</tr>
   162 						</tr>
   165 					</tbody>
   163 					</tbody>
   166 				</table>
   164 				</table>
   167 			</div><div class="item" id="method-startMail">
   165 			</div><div class="item" id="method-startMail">
   168 				<h4>StartMail</h4>
   166 				<h4>StartMail</h4>
   169 				<p><code>startMail</code></p>
   167 				<p><code>startMail(self, subject, body, recipients, frm, provider='default')</code></p>
   170 				<p>Versendet eine Email.</p>
   168 				<p>Versendet eine Email.</p>
   171 				<h5>Parameter</h5>
   169 				<h5>Parameter</h5>
   172 				<table class="docs">
   170 				<table class="docs">
   173 					<thead>
   171 					<thead>
   174 						<tr>
   172 						<tr>
   195 							<td>string</td>
   193 							<td>string</td>
   196 							<td> Die Absender Emailadresse</td>
   194 							<td> Die Absender Emailadresse</td>
   197 						</tr><tr>
   195 						</tr><tr>
   198 							<td>provider</td>
   196 							<td>provider</td>
   199 							<td>string</td>
   197 							<td>string</td>
   200 							<td> Provider über den geschickt werden soll;
   198 							<td> Provider über den geschickt werden soll</td>
   201 default - verschickt über den Standardprovider</td>
       
   202 						</tr>
   199 						</tr>
   203 					</tbody>
   200 					</tbody>
   204 				</table>
   201 				</table>
   205 				<h5>Ausgabe</h5>
   202 				<h5>Ausgabe</h5>
   206 				<table class="docs">
   203 				<table class="docs">
   219 						</tr>
   216 						</tr>
   220 					</tbody>
   217 					</tbody>
   221 				</table>
   218 				</table>
   222 			</div><div class="item" id="method-status">
   219 			</div><div class="item" id="method-status">
   223 				<h4>Status</h4>
   220 				<h4>Status</h4>
   224 				<p><code>status</code></p>
   221 				<p><code>status(self, id=None, detailed=False)</code></p>
   225 				<p>Gibt den aktuellen Status eines Auftrages zurück.</p>
   222 				<p>Gibt den aktuellen Status eines Auftrages zurück.</p>
   226 				<h5>Parameter</h5>
   223 				<h5>Parameter</h5>
   227 				<table class="docs">
   224 				<table class="docs">
   228 					<thead>
   225 					<thead>
   229 						<tr>
   226 						<tr>
   234 					</thead>
   231 					</thead>
   235 					<tbody>
   232 					<tbody>
   236 						<tr>
   233 						<tr>
   237 							<td>id</td>
   234 							<td>id</td>
   238 							<td>hash</td>
   235 							<td>hash</td>
   239 							<td> Eine Auftragsnummer
   236 							<td> Eine Auftragsnummer</td>
   240 default - alle Aufträge ausgeben</td>
       
   241 						</tr><tr>
   237 						</tr><tr>
   242 							<td>detailed</td>
   238 							<td>detailed</td>
   243 							<td>boolean</td>
   239 							<td>boolean</td>
   244 							<td> Details ausgeben
   240 							<td> Details ausgeben</td>
   245 default - False</td>
       
   246 						</tr>
   241 						</tr>
   247 					</tbody>
   242 					</tbody>
   248 				</table>
   243 				</table>
   249 				<h5>Ausgabe</h5>
   244 				<h5>Ausgabe</h5>
   250 				<table class="docs">
   245 				<table class="docs">
   271 						</tr>
   266 						</tr>
   272 					</tbody>
   267 					</tbody>
   273 				</table>
   268 				</table>
   274 			</div><div class="item" id="method-stop">
   269 			</div><div class="item" id="method-stop">
   275 				<h4>Stop</h4>
   270 				<h4>Stop</h4>
   276 				<p><code>stop</code></p>
   271 				<p><code>stop(self, id)</code></p>
   277 				<p>Stoppt den angegeben Auftrag.</p>
   272 				<p>Stoppt den angegeben Auftrag.</p>
   278 				<h5>Parameter</h5>
   273 				<h5>Parameter</h5>
   279 				<table class="docs">
   274 				<table class="docs">
   280 					<thead>
   275 					<thead>
   281 						<tr>
   276 						<tr>
   292 						</tr>
   287 						</tr>
   293 					</tbody>
   288 					</tbody>
   294 				</table>
   289 				</table>
   295 			</div><div class="item" id="method-getProvider">
   290 			</div><div class="item" id="method-getProvider">
   296 				<h4>GetProvider</h4>
   291 				<h4>GetProvider</h4>
   297 				<p><code>getProvider</code></p>
   292 				<p><code>getProvider(self, typ)</code></p>
   298 				<p>Gibt eine Liste aller verfügbaren Provider zurück.</p>
   293 				<p>Gibt eine Liste aller verfügbaren Provider zurück.</p>
   299 				<h5>Parameter</h5>
   294 				<h5>Parameter</h5>
   300 				<table class="docs">
   295 				<table class="docs">
   301 					<thead>
   296 					<thead>
   302 						<tr>
   297 						<tr>
   331 						</tr>
   326 						</tr>
   332 					</tbody>
   327 					</tbody>
   333 				</table>
   328 				</table>
   334 			</div><div class="item" id="method-getDefaultProvider">
   329 			</div><div class="item" id="method-getDefaultProvider">
   335 				<h4>GetDefaultProvider</h4>
   330 				<h4>GetDefaultProvider</h4>
   336 				<p><code>getDefaultProvider</code></p>
   331 				<p><code>getDefaultProvider(self, typ)</code></p>
   337 				<p>Gibt den Standardprovider zurück.</p>
   332 				<p>Gibt den Standardprovider zurück.</p>
   338 				<h5>Parameter</h5>
   333 				<h5>Parameter</h5>
   339 				<table class="docs">
   334 				<table class="docs">
   340 					<thead>
   335 					<thead>
   341 						<tr>
   336 						<tr>