twisted.words.im.basesupport.AbstractAccount

class documentation

class twisted.words.im.basesupport.AbstractAccount(styles.Versioned): (source)

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

View In Hierarchy

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 Variable accountName
Instance Variable autoLogin
Instance Variable username
Instance Variable password
Instance Variable host
Instance Variable port
Instance Variable client Undocumented
Class Variable persistanceVersion Undocumented
Method __init__ Undocumented
Method upgrateToVersion2 Undocumented
Method __getstate__ Get state, adding a version number to it on its way out.
Method isOnline Undocumented
Method logOn Log on to this account.
Method getGroup Group factory.
Method getPerson Person factory.
Method __repr__ Undocumented
Class Variable _groupFactory A Callable that will return a IGroup appropriate for this account type.
Class Variable _personFactory A Callable that will return a IPerson appropriate for this account type.
Instance Variable _isConnecting Whether I am in the process of establishing a connection to the server.
Instance Variable _isOnline Whether I am currently on-line with the server.
Instance Variable _groups Undocumented
Instance Variable _persons Undocumented
Method _startLogOn Start the sign on process.
Method _cb_logOn Undocumented
Method _loginFailed Errorback for logOn.
Method _clientLost Undocumented

Inherited from Versioned:

Class Variable persistenceVersion Undocumented
Class Variable persistenceForgets Undocumented
Method __setstate__ Undocumented
Instance Variable __dict__ Undocumented
Method versionUpgrade (internal) Do a version upgrade.
_groupFactory = (source)
A Callable that will return a IGroup appropriate for this account type.
_personFactory = (source)
A Callable that will return a IPerson appropriate for this account type.
_isConnecting = (source)
overridden in twisted.words.im.pbsupport.PBAccount
Whether I am in the process of establishing a connection to the server.
(type: boolean)
_isOnline = (source)
Whether I am currently on-line with the server.
(type: boolean)
accountName = (source)
autoLogin = (source)
username = (source)
password = (source)
host = (source)
port = (source)
client = (source)

Undocumented

persistanceVersion = (source)

Undocumented

(type: int)
def __init__(self, accountName, autoLogin, username, password, host, port): (source)
overridden in twisted.words.im.ircsupport.IRCAccount, twisted.words.im.pbsupport.PBAccount

Undocumented

_groups = (source)

Undocumented

(type: dict)
_persons = (source)

Undocumented

(type: dict)
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.

ReturnsUndocumented (type: Deferred interfaces.IClient)
def getGroup(self, name): (source)

Group factory.

ParametersnameName of the group on this account. (type: string)
def getPerson(self, name): (source)

Person factory.

ParametersnameName 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

Start the sign on process.

Factored out of logOn.

ReturnsUndocumented (type: Deferred interfaces.IClient)
def _cb_logOn(self, client): (source)

Undocumented

def _loginFailed(self, reason): (source)

Errorback for logOn.

ParametersreasonUndocumented (type: Failure)
Returnsreason, for further processing in the callback chain. (type: Failure)
def _clientLost(self, client, reason): (source)

Undocumented

def __repr__(self): (source)

Undocumented

ReturnsUndocumented (type: str)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.