Class t.w.i.b.AbstractAccount(styles.Versioned):

Part of twisted.words.im.basesupport View Source View In Hierarchy

Known subclasses: twisted.words.im.pbsupport.PBAccount, twisted.words.im.tocsupport.TOCAccount, twisted.words.im.ircsupport.IRCAccount

Base class for Accounts.

I am the start of an implementation of IAccount, I implement isOnline and most of logOn, though you'll need to implement _startLogOn in a subclass.
Instance Variables_isConnectingWhether I am in the process of establishing a connection to the server. (type: boolean )
_isOnlineWhether I am currently on-line with the server. (type: boolean )
accountName
autoLogin
username
password
host
port
Class Variables_groupFactoryA Callable that will return a IGroup appropriate for this account type.
_personFactoryA Callable that will return a IPerson appropriate for this account type.
Line # Kind Name Docs
156 Method __init__ Undocumented
167 Method upgrateToVersion2 Undocumented
173 Method __getstate__ Get state, adding a version number to it on its way out.
182 Method isOnline Undocumented
185 Method logOn Log on to this account.
208 Method getGroup Group factory.
220 Method getPerson Person factory.
232 Method _startLogOn Start the sign on process.
241 Method _cb_logOn Undocumented
247 Method _loginFailed Errorback for logOn.
259 Method _clientLost Undocumented
265 Method __repr__ Undocumented

Inherited from Versioned:

Line # Kind Name Docs
187 Method __setstate__ Undocumented
207 Method versionUpgrade (internal) Do a version upgrade.
def __init__(self, accountName, autoLogin, username, password, host, port):
overridden in twisted.words.im.pbsupport.PBAccount, twisted.words.im.ircsupport.IRCAccount
Undocumented
def upgrateToVersion2(self):
Undocumented
def __getstate__(self):
overrides twisted.persisted.styles.Versioned.__getstate__
Get state, adding a version number to it on its way out.
def isOnline(self):
Undocumented
def logOn(self, chatui):
overridden in twisted.words.im.pbsupport.PBAccount

Log on to this account.

Takes care to not start a connection if a connection is already in progress. You will need to implement _startLogOn for this to work, and it would be a good idea to override _loginFailed too.
Returns(type: Deferred interfaces.IClient )
def getGroup(self, name):
Group factory.
ParametersnameName of the group on this account. (type: string )
def getPerson(self, name):
Person factory.
ParametersnameName of the person on this account. (type: string )
def _startLogOn(self, chatui):
overridden in twisted.words.im.pbsupport.PBAccount, twisted.words.im.tocsupport.TOCAccount, twisted.words.im.ircsupport.IRCAccount

Start the sign on process.

Factored out of logOn.
Returns(type: Deferred interfaces.IClient )
def _cb_logOn(self, client):
Undocumented
def _loginFailed(self, reason):
Errorback for logOn.
Parametersreason(type: Failure )
Returnsreason, for further processing in the callback chain. (type: Failure )
def _clientLost(self, client, reason):
Undocumented
def __repr__(self):
Undocumented