twisted.words.im.interfaces.IAccount

interface documentation

class twisted.words.im.interfaces.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.

Attribute client The IClient currently connecting to this account, if any.
Attribute gatewayType A str that identifies the protocol used by this account.
Method __init__ No summary
Method isOnline Am I online?
Method logOn Go on-line.
Method logOff Sign off.
Method getGroup
Method getPerson
client = (source)

The IClient currently connecting to this account, if any.

gatewayType = (source)

A str that identifies the protocol used by this account.

def __init__(accountName, autoLogin, username, password, host, port): (source)
ParametersaccountNameA name to refer to the account by locally. (type: string)
autoLoginUndocumented (type: boolean)
usernameUndocumented (type: string)
passwordUndocumented (type: string)
hostUndocumented (type: string)
portUndocumented (type: integer)
def isOnline(): (source)

Am I online?

ReturnsUndocumented (type: boolean)
def logOn(chatui): (source)

Go on-line.

ParameterschatuiUndocumented (type: Implementor of IChatUI)
ReturnsUndocumented (type: Deferred with an eventual IClient result.)
def logOff(): (source)

Sign off.

def getGroup(groupName): (source)
ReturnsUndocumented (type: Group)
def getPerson(personName): (source)
ReturnsUndocumented (type: Person)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.