twisted.words.im.interfaces.IAccount

interface documentation

class IAccount(Interface): (source)

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 get​Group
Method get​Person
Method is​Online Am I online?
Method log​Off Sign off.
Method log​On Go on-line.
Attribute client The IClient currently connecting to this account, if any.
Attribute gateway​Type A str that identifies the protocol used by this account.
def __init__(accountName, autoLogin, username, password, host, port): (source)
Parameters
account​Name:stringA name to refer to the account by locally.
auto​Login: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.