twisted.protocols.msn.MSNMessage.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.protocols.msn.MSNMessage</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.protocols.html">Package protocols</a> ::
<a href="twisted.protocols.msn.html">Module msn</a> ::
Class MSNMessage
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.protocols.msn.MSNMessage.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class MSNMessage</h2>
<hr/>
I am the class used to represent an 'instant' message.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>length</span>,
<span class=summary-sig-arg>userHandle</span>,
<span class=summary-sig-arg>screenName</span>,
<span class=summary-sig-arg>message</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.msn.MSNMessage.html#_calcMessageLen" class="summary-sig-name"><code>_calcMessageLen</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
used to calculte the number to send as the message length when sending
a message.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.msn.MSNMessage.html#getHeader" class="summary-sig-name"><code>getHeader</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>header</span>)</span></code>
<br />
get the desired header value</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.msn.MSNMessage.html#getMessage" class="summary-sig-name"><code>getMessage</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
return the message - not including headers</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.msn.MSNMessage.html#hasHeader" class="summary-sig-name"><code>hasHeader</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>header</span>)</span></code>
<br />
check to see if the desired header exists</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.msn.MSNMessage.html#setHeader" class="summary-sig-name"><code>setHeader</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>header</span>,
<span class=summary-sig-arg>value</span>)</span></code>
<br />
set the desired header</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.protocols.msn.MSNMessage.html#setMessage" class="summary-sig-name"><code>setMessage</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>message</span>)</span></code>
<br />
set the message text</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.protocols.msn.MSNMessage.html#ack"><code>ack</code></a></b>: This variable is used to tell the server how to respond once the
message has been sent.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">dict</font></td>
<td><b><a href="twisted.protocols.msn.MSNMessage.html#headers"><code>headers</code></a></b>: The message headers</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.protocols.msn.MSNMessage.html#length"><code>length</code></a></b>: The message length (including headers and line endings)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.protocols.msn.MSNMessage.html#message"><code>message</code></a></b>: The message</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.protocols.msn.MSNMessage.html#screenName"><code>screenName</code></a></b>: The screen name of the sender (this is only used when receiving a
message)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.protocols.msn.MSNMessage.html#userHandle"><code>userHandle</code></a></b>: The user handle (passport) of the sender (this is only used when
receiving a message)</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.protocols.msn.MSNMessage.html#MESSAGE_ACK"><code>MESSAGE_ACK</code></a></b> = <span title="'A'"><code><span class="variable-quote">'</span>A<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.protocols.msn.MSNMessage.html#MESSAGE_ACK_NONE"><code>MESSAGE_ACK_NONE</code></a></b> = <span title="'U'"><code><span class="variable-quote">'</span>U<span class="variable-quote">'</span> </code>
</span></td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="twisted.protocols.msn.MSNMessage.html#MESSAGE_NACK"><code>MESSAGE_NACK</code></a></b> = <span title="'N'"><code><span class="variable-quote">'</span>N<span class="variable-quote">'</span> </code>
</span></td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="_calcMessageLen"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">_calcMessageLen</span>(<span class=sig-arg>self</span>)</span>
</h3>
used to calculte the number to send as the message length when
sending a message.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getHeader"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getHeader</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>header</span>)</span>
</h3>
get the desired header value
<dl><dt></dt><dd>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>KeyError</b></code> -
if no such header exists.
</dl>
</dd></dl>
</td></tr></table>
<a name="getMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getMessage</span>(<span class=sig-arg>self</span>)</span>
</h3>
return the message - not including headers
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="hasHeader"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">hasHeader</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>header</span>)</span>
</h3>
check to see if the desired header exists
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setHeader"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setHeader</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>header</span>,
<span class=sig-arg>value</span>)</span>
</h3>
set the desired header
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setMessage</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>message</span>)</span>
</h3>
set the message text
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="ack"></a>
<h3>ack</h3>
This variable is used to tell the server how to respond once the
message has been sent. If set to MESSAGE_ACK (default) the server will
respond with an ACK upon receiving the message, if set to MESSAGE_NACK
the server will respond with a NACK upon failure to receive the message.
If set to MESSAGE_ACK_NONE the server will do nothing. This is relevant
for the return value of SwitchboardClient.sendMessage (which will return
a Deferred if ack is set to either MESSAGE_ACK or MESSAGE_NACK and will
fire when the respective ACK or NACK is received). If set to
MESSAGE_ACK_NONE sendMessage will return None.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'A'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>A<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="headers"></a>
<h3>headers</h3>
The message headers
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
dict
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="length"></a>
<h3>length</h3>
The message length (including headers and line endings)
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="message"></a>
<h3>message</h3>
The message
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="screenName"></a>
<h3>screenName</h3>
The screen name of the sender (this is only used when receiving a
message)
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="userHandle"></a>
<h3>userHandle</h3>
The user handle (passport) of the sender (this is only used when
receiving a message)
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="MESSAGE_ACK"></a>
<h3>MESSAGE_ACK</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'A'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>A<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="MESSAGE_ACK_NONE"></a>
<h3>MESSAGE_ACK_NONE</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'U'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>U<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="MESSAGE_NACK"></a>
<h3>MESSAGE_NACK</h3>
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'N'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>N<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:24 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>