twisted.words.im.interfaces.IAccount

interface documentation

class IAccount(Interface): (source)

Constructor: IAccount(autoLogin, username, password, host, port)

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

View In Hierarchy

I represent a user's account with a chat service.

Method __init__ No summary
Method getGroup No summary
Method getPerson No summary
Method isOnline Am I online?
Method logOff Sign off.
Method logOn Go on-line.
Attribute client The IClient currently connecting to this account, if any.
Attribute gatewayType A str that identifies the protocol used by this account.
def __init__(accountName, autoLogin, username, password, host, port): (source)
Parameters
accountName:stringA name to refer to the account by locally.
autoLogin:booleanUndocumented
username:stringUndocumented
password:stringUndocumented
host:stringUndocumented
port:integerUndocumented
def getGroup(groupName): (source)
Returns
GroupUndocumented
def getPerson(personName): (source)
Returns
PersonUndocumented
def isOnline(): (source)

Am I online?

Returns
booleanUndocumented
def logOff(): (source)

Sign off.

def logOn(chatui): (source)

Go on-line.

Parameters
chatui:Implementor of IChatUIUndocumented
Returns
Deferred with an eventual IClient result.Undocumented
client = (source)

The IClient currently connecting to this account, if any.

gatewayType = (source)

A str that identifies the protocol used by this account.