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

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

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

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	_isConnecting	Whether I am in the process of establishing a connection to the server. (type: boolean )
	_isOnline	Whether I am currently on-line with the server. (type: boolean )
	accountName
	autoLogin
	username
	password
	host
	port
Class Variables	_groupFactory	A Callable that will return a `IGroup` appropriate for this account type.
	_personFactory	A Callable that will return a `IPerson` appropriate for this account type.

Split Table into Classes Show Methods in One Table

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.
265	Method	__repr__	Undocumented
232	Method	_startLogOn	Start the sign on process.
241	Method	_cb_logOn	Undocumented
247	Method	_loginFailed	Errorback for `logOn`.
259	Method	_clientLost	Undocumented

Inherited from Versioned:

Line #	Kind	Name	Docs
187	Method	__setstate__	Undocumented
207	Method	versionUpgrade	(internal) Do a version upgrade.

Line #	Kind	Name	Docs
173	Method	__getstate__	Get state, adding a version number to it on its way out.
156	Method	__init__	Undocumented
265	Method	__repr__	Undocumented
187	Method	__setstate__	Undocumented
208	Method	getGroup	Group factory.
220	Method	getPerson	Person factory.
182	Method	isOnline	Undocumented
185	Method	logOn	Log on to this account.
167	Method	upgrateToVersion2	Undocumented
207	Method	versionUpgrade	(internal) Do a version upgrade.
241	Method	_cb_logOn	Undocumented
259	Method	_clientLost	Undocumented
247	Method	_loginFailed	Errorback for `logOn`.
232	Method	_startLogOn	Start the sign on process.

def __init__(self, accountName, autoLogin, username, password, host, port): (source)

overridden in twisted.words.im.ircsupport.IRCAccount, twisted.words.im.pbsupport.PBAccount

Undocumented

def upgrateToVersion2(self): (source)

Undocumented

def __getstate__(self): (source)

overrides twisted.persisted.styles.Versioned.__getstate__

Get state, adding a version number to it on its way out.

def isOnline(self): (source)

Undocumented

def logOn(self, chatui): (source)

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): (source)

Group factory.

Parameters name Name of the group on this account. (type: string )

def getPerson(self, name): (source)

Person factory.

Parameters name Name of the person on this account. (type: string )

def _startLogOn(self, chatui): (source)

overridden in twisted.words.im.ircsupport.IRCAccount, twisted.words.im.pbsupport.PBAccount, twisted.words.im.tocsupport.TOCAccount

Start the sign on process.

Factored out of logOn.

Returns (type: Deferred interfaces.IClient )

def _cb_logOn(self, client): (source)

Undocumented

def _loginFailed(self, reason): (source)

Errorback for logOn.

Parameters	reason	(type: Failure )
Returns	reason, for further processing in the callback chain. (type: Failure )

def _clientLost(self, client, reason): (source)

Undocumented

def __repr__(self): (source)

Undocumented

API Documentation for Twisted, generated by pydoctor at 2008-10-26 16:12:37.