twisted.im.pbsupport.TwistedWordsClient.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.pbsupport.TwistedWordsClient</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.pbsupport.html">Module pbsupport</a> ::
Class TwistedWordsClient
</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.pbsupport.TwistedWordsClient.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class TwistedWordsClient</h2>
<pre class="base-tree">
<a href="twisted.im.basesupport.AbstractClientMixin.html"><code>AbstractClientMixin</code></a> --+
|
<a href="twisted.spread.jelly.Jellyable.html"><code>Jellyable</code></a> --+ |
| |
<a href="twisted.spread.flavors.Serializable.html"><code>Serializable</code></a> --+ |
| |
<a href="twisted.spread.flavors.Referenceable.html"><code>Referenceable</code></a> --+
|
<b>TwistedWordsClient</b>
</pre><br />
<hr/>
In some cases, this acts as an Account, since it a source of text
messages (multiple Words instances may be on a single PB connection)
<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>acct</span>,
<span class=summary-sig-arg>serviceName</span>,
<span class=summary-sig-arg>perspectiveName</span>,
<span class=summary-sig-arg>chatui</span>,
<span class=summary-sig-arg>_logonDeferred</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_cbGroupJoined"></a><span class="summary-sig"><span class="summary-sig-name">_cbGroupJoined</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>result</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_cbGroupLeft"></a><span class="summary-sig"><span class="summary-sig-name">_cbGroupLeft</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>result</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="addContact"></a><span class="summary-sig"><span class="summary-sig-name">addContact</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="connected"></a><span class="summary-sig"><span class="summary-sig-name">connected</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>perspective</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getGroup"></a><span class="summary-sig"><span class="summary-sig-name">getGroup</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getGroupConversation"></a><span class="summary-sig"><span class="summary-sig-name">getGroupConversation</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getPerson"></a><span class="summary-sig"><span class="summary-sig-name">getPerson</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="joinGroup"></a><span class="summary-sig"><span class="summary-sig-name">joinGroup</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="leaveGroup"></a><span class="summary-sig"><span class="summary-sig-name">leaveGroup</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="remote_memberJoined"></a><span class="summary-sig"><span class="summary-sig-name">remote_memberJoined</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>member</span>,
<span class=summary-sig-arg>group</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="remote_memberLeft"></a><span class="summary-sig"><span class="summary-sig-name">remote_memberLeft</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>member</span>,
<span class=summary-sig-arg>group</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="remote_notifyStatusChanged"></a><span class="summary-sig"><span class="summary-sig-name">remote_notifyStatusChanged</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</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><a name="remote_receiveContactList"></a><span class="summary-sig"><span class="summary-sig-name">remote_receiveContactList</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>clist</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="remote_receiveDirectMessage"></a><span class="summary-sig"><span class="summary-sig-name">remote_receiveDirectMessage</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>name</span>,
<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>metadata</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="remote_receiveGroupMembers"></a><span class="summary-sig"><span class="summary-sig-name">remote_receiveGroupMembers</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>names</span>,
<span class=summary-sig-arg>group</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="remote_receiveGroupMessage"></a><span class="summary-sig"><span class="summary-sig-name">remote_receiveGroupMessage</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>sender</span>,
<span class=summary-sig-arg>group</span>,
<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>metadata</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="remote_setGroupMetadata"></a><span class="summary-sig"><span class="summary-sig-name">remote_setGroupMetadata</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>dict_</span>,
<span class=summary-sig-arg>groupName</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Referenceable</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.flavors.Referenceable.html#jellyFor" class="summary-sig-name"><code>jellyFor</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>jellier</span>)</span></code>
<br />
(internal)</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.flavors.Referenceable.html#remoteMessageReceived" class="summary-sig-name"><code>remoteMessageReceived</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>broker</span>,
<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>args</span>,
<span class=summary-sig-arg>kw</span>)</span></code>
<br />
A remote message has been received.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Serializable</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.flavors.Serializable.html#processUniqueID" class="summary-sig-name"><code>processUniqueID</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Return an ID which uniquely represents this object for this
process.</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Jellyable</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.spread.jelly.Jellyable.html#getStateFor" class="summary-sig-name"><code>getStateFor</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>jellier</span>)</span></code>
</td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from AbstractClientMixin</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.basesupport.AbstractClientMixin.html#connectionLost" class="summary-sig-name"><code>connectionLost</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>reason</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.basesupport.AbstractClientMixin.html#connectionMade" class="summary-sig-name"><code>connectionMade</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.basesupport.AbstractClientMixin.html#unregisterAsAccountClient" class="summary-sig-name"><code>unregisterAsAccountClient</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Tell the chat UI that I have `signed off'.</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 bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from AbstractClientMixin</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="twisted.im.basesupport.AbstractClientMixin.html#_logonDeferred"><code>_logonDeferred</code></a></b>: Fired when I am done logging in.</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 bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Referenceable</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>NoneType</code></font></td>
<td><b><a href="twisted.spread.flavors.Referenceable.html#perspective"><code>perspective</code></a></b> = <span title="None">None </span></td></tr>
<tr bgcolor="#e8f0f8" class="group">
<th colspan="2"> Inherited from Jellyable</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>tuple</code></font></td>
<td><b><a href="twisted.spread.jelly.Jellyable.html#__implements__"><code>__implements__</code></a></b> = <span title="(<class twisted.spread.interfaces.IJellyable at 0x840e324>,)"><code>(<class twisted.spread.interfaces.IJell<span class="variable-ellipsis">...</span></code>
</span></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:17 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>