twisted.im.interfaces.IPerson.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.im.interfaces.IPerson</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.im.html">Package im</a> ::
<a href="twisted.im.interfaces.html">Module interfaces</a> ::
Class IPerson
</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.im.interfaces.IPerson.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IPerson</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IPerson</b>
</pre><br />
<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><span class="summary-sig"><a href="twisted.im.interfaces.IPerson.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>account</span>)</span></code>
<br />
Initialize me.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> string (XXX: How about a scalar?)
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IPerson.html#getIdleTime" class="summary-sig-name"><code>getIdleTime</code></a>(<span class=summary-sig-arg>self</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.im.interfaces.IPerson.html#getStatus" class="summary-sig-name"><code>getStatus</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
What is my on-line status?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IPerson.html#isOnline" class="summary-sig-name"><code>isOnline</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Am I online right now?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IPerson.html#sendMessage" class="summary-sig-name"><code>sendMessage</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>text</span>,
<span class=summary-sig-arg>metadata</span>)</span></code>
<br />
Send a message to this person.</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="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>,
<span class=sig-arg>account</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Initialize me.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code> -
My name, as the server knows me.
<br /><i>
(type=string)</i>
<dd><code><b>account</b></code> -
The account I am accessed through.
<br /><i>
(type=<i>Account</i>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getIdleTime"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getIdleTime</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
string (XXX: How about a scalar?)
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getStatus"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getStatus</span>(<span class=sig-arg>self</span>)</span>
</h3>
What is my on-line status?
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="twisted.im.locals.StatusEnum.html"
class="link"><code>locals.StatusEnum</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="isOnline"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">isOnline</span>(<span class=sig-arg>self</span>)</span>
</h3>
Am I online right now?
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
boolean
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="sendMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">sendMessage</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>text</span>,
<span class=sig-arg>metadata</span>=<span class=sig-default>None</span>)</span>
</h3>
Send a message to this person.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>text</b></code>
<br /><i>
(type=string)</i>
<dd><code><b>metadata</b></code>
<br /><i>
(type=dict)</i>
</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:42 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>