twisted.im.baseaccount.AccountManager.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.baseaccount.AccountManager</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.baseaccount.html">Module baseaccount</a> ::
Class AccountManager
</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.baseaccount.AccountManager.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Class AccountManager</h2>
<hr/>
<p>I am responsible for managing a user's accounts.</p>
That is, remembering what accounts are available, their settings,
adding and removal of accounts, etc.
<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></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="addAccount"></a><span class="summary-sig"><span class="summary-sig-name">addAccount</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>account</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> Deferred <a href="twisted.im.interfaces.IClient.html"
class="link"><code>interfaces.IClient</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="twisted.im.baseaccount.AccountManager.html#connect" class="summary-sig-name"><code>connect</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>accountName</span>,
<span class=summary-sig-arg>chatui</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="delAccount"></a><span class="summary-sig"><span class="summary-sig-name">delAccount</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>accountName</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="disconnect"></a><span class="summary-sig"><span class="summary-sig-name">disconnect</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>accountName</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getConnectionInfo"></a><span class="summary-sig"><span class="summary-sig-name">getConnectionInfo</span>(<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.baseaccount.AccountManager.html#getSnapShot" class="summary-sig-name"><code>getSnapShot</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
A snapshot of all the accounts and their status.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="isEmpty"></a><span class="summary-sig"><span class="summary-sig-name">isEmpty</span>(<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><a name="quit"></a><span class="summary-sig"><span class="summary-sig-name">quit</span>(<span class=summary-sig-arg>self</span>)</span></code>
</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">mapping of strings to <a
href="twisted.im.interfaces.IAccount.html"
class="link"><code>Account</code></a>s.</font></td>
<td><b><a href="twisted.im.baseaccount.AccountManager.html#accounts"><code>accounts</code></a></b>: A collection of available accounts.</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="connect"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">connect</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>accountName</span>,
<span class=sig-arg>chatui</span>)</span>
</h3>
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
Deferred <a href="twisted.im.interfaces.IClient.html"
class="link"><code>interfaces.IClient</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getSnapShot"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getSnapShot</span>(<span class=sig-arg>self</span>)</span>
</h3>
A snapshot of all the accounts and their status.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
A list of tuples, each of the form (string:accountName,
boolean:isOnline, boolean:autoLogin, string:gatewayType)
</dd>
</dl>
</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="accounts"></a>
<h3>accounts</h3>
A collection of available accounts.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
mapping of strings to <a
href="twisted.im.interfaces.IAccount.html"
class="link"><code>Account</code></a>s.
</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:31 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>