1
<?xml version="1.0" encoding="iso-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
"DTD/xhtml1-transitional.dtd">
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
<title>twisted.im.interfaces.IAccount</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
24
</p></th></tr></table>
28
<table width="100%" cellpadding="0" cellspacing="0">
31
<font size="-1"><b class="breadcrumbs">
32
<a href="twisted.html">Package twisted</a> ::
33
<a href="twisted.im.html">Package im</a> ::
34
<a href="twisted.im.interfaces.html">Module interfaces</a> ::
38
<td><table cellpadding="0" cellspacing="0">
39
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.im.interfaces.IAccount.html" target="_top">no frames</a>]</font></td></tr>
43
<!-- =========== START OF CLASS DESCRIPTION =========== -->
44
<h2 class="class">Class IAccount</h2>
46
<pre class="base-tree">
47
<a href="twisted.python.components.Interface.html"><code>Interface</code></a> --+
54
I represent a user's account with a chat service.
58
<!-- =========== START OF METHOD SUMMARY =========== -->
59
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
60
<tr bgcolor="#70b0f0" class="summary">
61
<th colspan="2">Method Summary</th></tr>
62
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
63
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IAccount.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
64
<span class=summary-sig-arg>accountName</span>,
65
<span class=summary-sig-arg>autoLogin</span>,
66
<span class=summary-sig-arg>username</span>,
67
<span class=summary-sig-arg>password</span>,
68
<span class=summary-sig-arg>host</span>,
69
<span class=summary-sig-arg>port</span>)</span></code>
71
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="twisted.im.interfaces.IGroup.html"
72
class="link"><code>Group</code></a>
74
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IAccount.html#getGroup" class="summary-sig-name"><code>getGroup</code></a>(<span class=summary-sig-arg>self</span>,
75
<span class=summary-sig-arg>groupName</span>)</span></code>
77
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="twisted.im.interfaces.IPerson.html"
78
class="link"><code>Person</code></a>
80
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IAccount.html#getPerson" class="summary-sig-name"><code>getPerson</code></a>(<span class=summary-sig-arg>self</span>,
81
<span class=summary-sig-arg>personName</span>)</span></code>
83
<tr><td align="right" valign="top" width="15%"><font size="-1"> boolean
85
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IAccount.html#isOnline" class="summary-sig-name"><code>isOnline</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
87
Am I online?</td></tr>
88
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
89
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IAccount.html#logOff" class="summary-sig-name"><code>logOff</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
92
<tr><td align="right" valign="top" width="15%"><font size="-1"> Deferred <code>Client</code>
94
<td><code><span class="summary-sig"><a href="twisted.im.interfaces.IAccount.html#logOn" class="summary-sig-name"><code>logOn</code></a>(<span class=summary-sig-arg>self</span>,
95
<span class=summary-sig-arg>chatui</span>)</span></code>
101
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
102
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
103
<tr bgcolor="#70b0f0" class="summary">
104
<th colspan="2">Instance Variable Summary</th></tr>
105
<tr><td align="right" valign="top" width="15%"><font size="-1"><a href="twisted.im.interfaces.IClient.html"
106
class="link"><code>IClient</code></a></font></td>
107
<td><b><a href="twisted.im.interfaces.IAccount.html#client"><code>client</code></a></b>: The Client currently connecting to this account, if any.</td></tr>
111
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
112
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
113
<tr bgcolor="#70b0f0" class="summary">
114
<th colspan="2">Class Variable Summary</th></tr>
115
<tr><td align="right" valign="top" width="15%"><font size="-1">string</font></td>
116
<td><b><a href="twisted.im.interfaces.IAccount.html#gatewayType"><code>gatewayType</code></a></b>: Identifies the protocol used by this account.</td></tr>
120
<!-- =========== START OF METHOD DETAILS =========== -->
121
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
122
<tr bgcolor="#70b0f0" class="details">
123
<th colspan="2">Method Details</th></tr>
126
<a name="__init__"></a>
127
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
128
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
129
<span class=sig-arg>accountName</span>,
130
<span class=sig-arg>autoLogin</span>,
131
<span class=sig-arg>username</span>,
132
<span class=sig-arg>password</span>,
133
<span class=sig-arg>host</span>,
134
<span class=sig-arg>port</span>)</span>
135
<br /><i>(Constructor)</i>
138
<dl><dt><b>Parameters:</b></dt>
139
<dd><code><b>accountName</b></code> -
140
A name to refer to the account by locally.
141
<br /><i>
143
<dd><code><b>autoLogin</b></code>
144
<br /><i>
146
<dd><code><b>username</b></code>
147
<br /><i>
149
<dd><code><b>password</b></code>
150
<br /><i>
152
<dd><code><b>host</b></code>
153
<br /><i>
155
<dd><code><b>port</b></code>
156
<br /><i>
163
<a name="getGroup"></a>
164
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
165
<h3><span class="sig"><span class="sig-name">getGroup</span>(<span class=sig-arg>self</span>,
166
<span class=sig-arg>groupName</span>)</span>
169
<dl><dt><b>Returns:</b></dt>
171
<a href="twisted.im.interfaces.IGroup.html"
172
class="link"><code>Group</code></a>
178
<a name="getPerson"></a>
179
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
180
<h3><span class="sig"><span class="sig-name">getPerson</span>(<span class=sig-arg>self</span>,
181
<span class=sig-arg>personName</span>)</span>
184
<dl><dt><b>Returns:</b></dt>
186
<a href="twisted.im.interfaces.IPerson.html"
187
class="link"><code>Person</code></a>
193
<a name="isOnline"></a>
194
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
195
<h3><span class="sig"><span class="sig-name">isOnline</span>(<span class=sig-arg>self</span>)</span>
199
<dl><dt><b>Returns:</b></dt>
207
<a name="logOff"></a>
208
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
209
<h3><span class="sig"><span class="sig-name">logOff</span>(<span class=sig-arg>self</span>)</span>
217
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
218
<h3><span class="sig"><span class="sig-name">logOn</span>(<span class=sig-arg>self</span>,
219
<span class=sig-arg>chatui</span>)</span>
223
<dl><dt><b>Parameters:</b></dt>
224
<dd><code><b>chatui</b></code>
225
<br /><i>
226
(type=Implementor of <code>IChatUI</code>)</i>
229
<dl><dt><b>Returns:</b></dt>
231
Deferred <code>Client</code>
239
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
240
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
241
<tr bgcolor="#70b0f0" class="details">
242
<th colspan="2">Instance Variable Details</th></tr>
244
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
245
<a name="client"></a>
247
The Client currently connecting to this account, if any.
252
<dt><b>Type:</b></dt>
254
<a href="twisted.im.interfaces.IClient.html"
255
class="link"><code>IClient</code></a>
260
</dl></td></tr></table>
264
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
265
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
266
<tr bgcolor="#70b0f0" class="details">
267
<th colspan="2">Class Variable Details</th></tr>
269
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
270
<a name="gatewayType"></a>
272
Identifies the protocol used by this account.
277
<dt><b>Type:</b></dt>
284
</dl></td></tr></table>
288
<!-- =========== START OF NAVBAR =========== -->
289
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
291
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
292
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
293
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
294
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
295
<th class="navbar" align="right" width="100%">
296
<table border="0" cellpadding="0" cellspacing="0">
297
<tr><th class="navbar" align="center">
299
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
300
</p></th></tr></table>
305
<table border="0" cellpadding="0" cellspacing="0" width="100%">
307
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:05 2004</font></td>
308
<td align="right"><a href="http://epydoc.sourceforge.net"
309
><font size="-2">http://epydoc.sf.net</font></a></td>
added
removed
doc/api/twisted.im.interfaces.IAccount.html
