t.w.s.User(object) : class documentation

Part of twisted.words.service View Source View In Hierarchy

Implements interfaces: twisted.words.iwords.IUser

Undocumented
Method __init__ Undocumented
Method loggedIn Invoked by the associated IChatService when login occurs.
Method join Attempt to join the given group.
Method leave Discontinue participation in the given group.
Method send Send the given message to the given user or group.
Method itergroups Return an iterator of all groups of which this user is a member.
Method logout Undocumented
def __init__(self, name): (source)
Undocumented
def loggedIn(self, realm, mind): (source)
from twisted.words.iwords.IUser
Invoked by the associated IChatService when login occurs.
ParametersrealmThe IChatService through which login is occurring.
mindThe mind object used for cred login.
def join(self, group): (source)
from twisted.words.iwords.IUser
Attempt to join the given group.
Parametersgroup (type: IGroup )
Returns (type: twisted.internet.defer.Deferred )
def leave(self, group, reason=None): (source)
from twisted.words.iwords.IUser
Discontinue participation in the given group.
Parametersgroup (type: IGroup )
Returns (type: twisted.internet.defer.Deferred )
def send(self, recipient, message): (source)
from twisted.words.iwords.IUser
Send the given message to the given user or group.
Parametersrecipient (type: Either IUser or IGroup )
message (type: dict )
def itergroups(self): (source)
from twisted.words.iwords.IUser
Return an iterator of all groups of which this user is a member.
def logout(self): (source)
Undocumented
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:02:37.