twisted.im.interfaces.IChatUI.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.IChatUI</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 IChatUI
</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.IChatUI.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class IChatUI</h2>
<pre class="base-tree">
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
|
<b>IChatUI</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.IChatUI.html#contactChangedNick" class="summary-sig-name"><code>contactChangedNick</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>oldnick</span>,
<span class=summary-sig-arg>newnick</span>)</span></code>
<br />
For the given person, changes the person's name to newnick, and tells
the contact list and any conversation windows with that person to change
as well.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>ContactsList</code>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IChatUI.html#getContactsList" class="summary-sig-name"><code>getContactsList</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="twisted.im.interfaces.IConversation.html"
class="link"><code>Conversation</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IChatUI.html#getConversation" class="summary-sig-name"><code>getConversation</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>person</span>,
<span class=summary-sig-arg>Class</span>,
<span class=summary-sig-arg>stayHidden</span>)</span></code>
<br />
For the given person object, returns the conversation window or
creates and returns a new conversation window if one does not exist.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="twisted.im.interfaces.IGroup.html"
class="link"><code>Group</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IChatUI.html#getGroup" class="summary-sig-name"><code>getGroup</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>client</span>)</span></code>
<br />
Get a Group for a client.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="twisted.im.interfaces.IGroupConversation.html"
class="link"><code>GroupConversation</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IChatUI.html#getGroupConversation" class="summary-sig-name"><code>getGroupConversation</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>group</span>,
<span class=summary-sig-arg>Class</span>,
<span class=summary-sig-arg>stayHidden</span>)</span></code>
<br />
For the given group object, returns the group conversation window or
creates and returns a new group conversation window if it doesn't
exist.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="twisted.im.interfaces.IPerson.html"
class="link"><code>Person</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IChatUI.html#getPerson" class="summary-sig-name"><code>getPerson</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>client</span>)</span></code>
<br />
Get a Person for a client.</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.IChatUI.html#registerAccountClient" class="summary-sig-name"><code>registerAccountClient</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>client</span>)</span></code>
<br />
Notifies user that an account has been signed on to.</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.IChatUI.html#unregisterAccountClient" class="summary-sig-name"><code>unregisterAccountClient</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>client</span>)</span></code>
<br />
Notifies user that an account has been signed off or disconnected</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="contactChangedNick"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">contactChangedNick</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>oldnick</span>,
<span class=sig-arg>newnick</span>)</span>
</h3>
For the given person, changes the person's name to newnick, and
tells the contact list and any conversation windows with that person to
change as well.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>oldnick</b></code>
<br /><i>
(type=string)</i>
<dd><code><b>newnick</b></code>
<br /><i>
(type=string)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getContactsList"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getContactsList</span>(<span class=sig-arg>self</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>ContactsList</code>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getConversation"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getConversation</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>person</span>,
<span class=sig-arg>Class</span>,
<span class=sig-arg>stayHidden</span>=<span class=sig-default>0</span>)</span>
</h3>
For the given person object, returns the conversation window or
creates and returns a new conversation window if one does not
exist.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>person</b></code>
<br /><i>
(type=<a href="twisted.im.interfaces.IPerson.html"
class="link"><code>Person</code></a>)</i>
<dd><code><b>Class</b></code>
<br /><i>
(type=<a href="twisted.im.interfaces.IConversation.html"
class="link"><code>Conversation</code></a> class)</i>
<dd><code><b>stayHidden</b></code>
<br /><i>
(type=boolean)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="twisted.im.interfaces.IConversation.html"
class="link"><code>Conversation</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getGroup"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getGroup</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>,
<span class=sig-arg>client</span>)</span>
</h3>
<p>Get a Group for a client.</p>
Duplicates <a href="twisted.im.interfaces.html#getGroup"
class="link"><code>IAccount.getGroup</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code>
<br /><i>
(type=string)</i>
<dd><code><b>client</b></code>
<br /><i>
(type=<a href="twisted.im.interfaces.IClient.html"
class="link"><code>Client</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="twisted.im.interfaces.IGroup.html"
class="link"><code>Group</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getGroupConversation"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getGroupConversation</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>group</span>,
<span class=sig-arg>Class</span>,
<span class=sig-arg>stayHidden</span>=<span class=sig-default>0</span>)</span>
</h3>
For the given group object, returns the group conversation window or
creates and returns a new group conversation window if it doesn't
exist.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>group</b></code>
<br /><i>
(type=<a href="twisted.im.interfaces.IGroup.html"
class="link"><code>Group</code></a>)</i>
<dd><code><b>Class</b></code>
<br /><i>
(type=<a href="twisted.im.interfaces.IConversation.html"
class="link"><code>Conversation</code></a> class)</i>
<dd><code><b>stayHidden</b></code>
<br /><i>
(type=boolean)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="twisted.im.interfaces.IGroupConversation.html"
class="link"><code>GroupConversation</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getPerson"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getPerson</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>name</span>,
<span class=sig-arg>client</span>)</span>
</h3>
<p>Get a Person for a client.</p>
Duplicates <a href="twisted.im.interfaces.html#getPerson"
class="link"><code>IAccount.getPerson</code></a>.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>name</b></code>
<br /><i>
(type=string)</i>
<dd><code><b>client</b></code>
<br /><i>
(type=<a href="twisted.im.interfaces.IClient.html"
class="link"><code>Client</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="twisted.im.interfaces.IPerson.html"
class="link"><code>Person</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="registerAccountClient"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">registerAccountClient</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>client</span>)</span>
</h3>
Notifies user that an account has been signed on to.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>client</b></code>
<br /><i>
(type=<a href="twisted.im.interfaces.IClient.html"
class="link"><code>Client</code></a>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="unregisterAccountClient"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">unregisterAccountClient</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>client</span>)</span>
</h3>
Notifies user that an account has been signed off or
disconnected
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>client</b></code>
<br /><i>
(type=<a href="twisted.im.interfaces.IClient.html"
class="link"><code>Client</code></a>)</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:18 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>