twisted.protocols.msn.MSNContact.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.MSNContact</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 MSNContact
</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.MSNContact.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class MSNContact</h2>
<hr/>
This class represents a contact (user).
<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>userHandle</span>,
<span class=summary-sig-arg>screenName</span>,
<span class=summary-sig-arg>lists</span>,
<span class=summary-sig-arg>groups</span>,
<span class=summary-sig-arg>status</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.MSNContact.html#addToList" class="summary-sig-name"><code>addToList</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>listType</span>)</span></code>
<br />
Update the lists attribute to reflect being part of the given
list.</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.MSNContact.html#removeFromList" class="summary-sig-name"><code>removeFromList</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>listType</span>)</span></code>
<br />
Update the lists attribute to reflect being removed from the given
list.</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.MSNContact.html#setPhone" class="summary-sig-name"><code>setPhone</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>phoneType</span>,
<span class=summary-sig-arg>value</span>)</span></code>
<br />
set phone numbers/values for this specific user.</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"> </font></td>
<td><b><a href="twisted.protocols.msn.MSNContact.html#groups"><code>groups</code></a></b>: A list of all the group IDs which this contact belongs to.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.protocols.msn.MSNContact.html#hasPager"><code>hasPager</code></a></b>: Whether or not this user has a mobile pager (true=yes, false=no)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">str if known, otherwise None.</font></td>
<td><b><a href="twisted.protocols.msn.MSNContact.html#homePhone"><code>homePhone</code></a></b>: The contact's home phone number.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.protocols.msn.MSNContact.html#lists"><code>lists</code></a></b>: An integer representing the sum of all lists that this contact belongs
to.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">str if known, otherwise None.</font></td>
<td><b><a href="twisted.protocols.msn.MSNContact.html#mobilePhone"><code>mobilePhone</code></a></b>: The contact's mobile phone number.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.protocols.msn.MSNContact.html#screenName"><code>screenName</code></a></b>: The contact's screen name.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">str if contact's status is known, None otherwise.</font></td>
<td><b><a href="twisted.protocols.msn.MSNContact.html#status"><code>status</code></a></b>: The contact's status code.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.protocols.msn.MSNContact.html#userHandle"><code>userHandle</code></a></b>: The contact's user handle (passport).</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">str if known, otherwise None.</font></td>
<td><b><a href="twisted.protocols.msn.MSNContact.html#workPhone"><code>workPhone</code></a></b>: The contact's work phone number.</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="addToList"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addToList</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>listType</span>)</span>
</h3>
Update the lists attribute to reflect being part of the given
list.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="removeFromList"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeFromList</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>listType</span>)</span>
</h3>
Update the lists attribute to reflect being removed from the given
list.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setPhone"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setPhone</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>phoneType</span>,
<span class=sig-arg>value</span>)</span>
</h3>
set phone numbers/values for this specific user. for phoneType check
the *_PHONE constants and HAS_PAGER
<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="groups"></a>
<h3>groups</h3>
A list of all the group IDs which this contact belongs to.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="hasPager"></a>
<h3>hasPager</h3>
Whether or not this user has a mobile pager (true=yes, false=no)
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="homePhone"></a>
<h3>homePhone</h3>
The contact's home phone number.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
str if known, otherwise None.
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="lists"></a>
<h3>lists</h3>
An integer representing the sum of all lists that this contact belongs
to.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="mobilePhone"></a>
<h3>mobilePhone</h3>
The contact's mobile phone number.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
str if known, otherwise None.
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="screenName"></a>
<h3>screenName</h3>
The contact's screen name.
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="status"></a>
<h3>status</h3>
The contact's status code.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
str if contact's status is known, None otherwise.
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="userHandle"></a>
<h3>userHandle</h3>
The contact's user handle (passport).
</td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="workPhone"></a>
<h3>workPhone</h3>
The contact's work phone number.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
str if known, otherwise None.
</dd>
</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:00 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>