twisted.words.im.interfaces.IAccount(Interface) interface documentation

Part of twisted.words.im.interfaces (View In Hierarchy)

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

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 =

The IClient currently connecting to this account, if any.

gatewayType =

A str that identifies the protocol used by this account.

def __init__(accountName, autoLogin, username, password, host, port):
ParametersaccountNameA name to refer to the account by locally. (type: string)
def isOnline():

Am I online?

Returns (type: boolean)
def logOn(chatui):

Go on-line.

Returns (type: Deferred with an eventual IClient result.)
def logOff():

Sign off.

def getGroup(groupName):
Returns (type: Group)
def getPerson(personName):
Returns (type: Person)
API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.