Changes between Initial Version and Version 1 of PloneSMS/PloneSMSCommunicator/Products.PloneSMSCommunicator.PloneSMSCommunicator-module.html


Ignore:
Timestamp:
Dec 23, 2005 2:55:30 PM (18 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PloneSMS/PloneSMSCommunicator/Products.PloneSMSCommunicator.PloneSMSCommunicator-module.html

    v1 v1  
     1= Products.PloneSMSCommunicator.PloneSMSCommunicator = 
     2{{{ 
     3#!html 
     4 
     5 
     6<!-- =========== START OF NAVBAR =========== --> 
     7<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> 
     8  <tr valign="center"> 
     9    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="Products.PloneSMSCommunicator-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th> 
     10    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th> 
     11    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th> 
     12    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th> 
     13    <th class="navbar" width="100%"></th> 
     14  </tr> 
     15</table> 
     16<table width="100%" cellpadding="0" cellspacing="0"> 
     17  <tr valign="top"> 
     18    <td width="100%"> 
     19      <font size="-1"><b class="breadcrumbs"> 
     20        Package&nbsp;Products :: 
     21        <a href="Products.PloneSMSCommunicator-module.html">Package&nbsp;PloneSMSCommunicator</a> :: 
     22        Module&nbsp;PloneSMSCommunicator 
     23      </b></font></br> 
     24    </td> 
     25    <td><table cellpadding="0" cellspacing="0"> 
     26      <tr><td align="right"></td></tr> 
     27    </table></td> 
     28</tr></table> 
     29 
     30<!-- =========== START OF MODULE DESCRIPTION =========== --> 
     31<h2 class="module">Module Products.PloneSMSCommunicator.PloneSMSCommunicator</h2> 
     32 
     33<p>This tool talks to XIAM gateway at cellphone operator 
     34via XIAM-XML protocol. You'd have to set XIAM gateway properties 
     35in the tool' configlet before you are able to send SMSes. 
     36This module defines the following classes:</p> 
     37<blockquote> 
     38<ul> 
     39<li><dl class="first docutils"> 
     40<dt><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html" class="link"><code>PloneSMSCommunicator</code></a>, this is the tool that carries responsibility for</dt> 
     41<dd><blockquote class="first"> 
     42<p>connection with server (message center) and sending via XIAM-XML protocol 
     43requests(short message) to server and get responses from it</p> 
     44</blockquote> 
     45<p>Methods:</p> 
     46<blockquote class="last"> 
     47<ul class="rst-simple"> 
     48<li><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html#setProperties" class="link"><code>PloneSMSCommunicator.setProperties</code></a>: set PloneSMSCommunicator properties</li> 
     49<li><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html#getProperties" class="link"><code>PloneSMSCommunicator.getProperties</code></a>: return all properties if ids == None, else return properties that in ids list</li> 
     50<li><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html#LOG" class="link"><code>PloneSMSCommunicator.LOG</code></a>: write all needed data to log file</li> 
     51<li><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html#write_sms" class="link"><code>PloneSMSCommunicator.write_sms</code></a>: write sms 'in' and sms 'out' files to sms directory</li> 
     52<li><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html#send_Request" class="link"><code>PloneSMSCommunicator.send_Request</code></a>: this function will send message to destination</li> 
     53<li><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html#Response" class="link"><code>PloneSMSCommunicator.Response</code></a>: write all data from response to xiam.log file</li> 
     54<li><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html#getAvailableSMSPolicies" class="link"><code>PloneSMSCommunicator.getAvailableSMSPolicies</code></a>: return sms policies</li> 
     55<li><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html#getServerInfo" class="link"><code>PloneSMSCommunicator.getServerInfo</code></a>: return dictionary that contains host name and ip address</li> 
     56<li><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html#getLogs" class="link"><code>PloneSMSCommunicator.getLogs</code></a>: return records from log file</li> 
     57</ul> 
     58</blockquote> 
     59</dd> 
     60</dl> 
     61</li> 
     62</ul> 
     63</blockquote> 
     64<p>Exception classes:</p> 
     65<blockquote> 
     66<ul class="rst-simple"> 
     67<li><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.SendMessageError-class.html" class="link"><code>SendMessageError</code></a></li> 
     68</ul> 
     69</blockquote> 
     70<hr/> 
     71 
     72<!-- =========== START OF CLASSES =========== --> 
     73<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> 
     74<tr bgcolor="#70b0f0" class="summary"> 
     75  <th colspan="2">Classes</th></tr> 
     76<tr><td width="15%"> 
     77  <b><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.PloneSMSCommunicator-class.html"><code>PloneSMSCommunicator</code></a></b></td> 
     78  <td>A not-so-basic Folder implementation, with Dublin Core 
     79Metadata included</td></tr> 
     80</table><br /> 
     81 
     82 
     83<!-- =========== START OF EXCEPTIONS =========== --> 
     84<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white"> 
     85<tr bgcolor="#70b0f0" class="summary"> 
     86  <th colspan="2">Exceptions</th></tr> 
     87<tr><td width="15%"> 
     88  <b><a href="Products.PloneSMSCommunicator.PloneSMSCommunicator.SendMessageError-class.html"><code>SendMessageError</code></a></b></td> 
     89  <td>&nbsp;</td></tr> 
     90</table><br /> 
     91 
     92 
     93<!-- =========== START OF NAVBAR =========== --> 
     94<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0"> 
     95  <tr valign="center"> 
     96    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="Products.PloneSMSCommunicator-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th> 
     97    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th> 
     98    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th> 
     99    <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th> 
     100    <th class="navbar" width="100%"></th> 
     101  </tr> 
     102</table> 
     103 
     104<table border="0" cellpadding="0" cellspacing="0" width="100%"> 
     105  <tr> 
     106    <td align="left"><font size="-2">Generated by Epydoc 2.1 on Fri Dec 23 14:45:44 2005</font></td> 
     107    <td align="right"><a href="http://epydoc.sourceforge.net" 
     108                      ><font size="-2">http://epydoc.sf.net</font></a></td> 
     109  </tr> 
     110</table> 
     111 
     112}}}