class documentation

class User: (source)

Implements interfaces: twisted.words.iwords.IUser

View In Hierarchy

Undocumented

Instance Variable realm A reference to the Realm to which this user belongs. Set if and only if the user is logged in.
Instance Variable mind A reference to the mind which logged in to this user. Set if and only if the user is logged in.
Method __init__ Undocumented
Instance Variable name A short string, unique among users.
Instance Variable groups Undocumented
Instance Variable lastMessage A POSIX timestamp indicating the time of the last message received from this user.
Method loggedIn Invoked by the associated IChatService when login occurs.
Instance Variable signOn A POSIX timestamp indicating this user's most recent sign on time.
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
realm = (source)

A reference to the Realm to which this user belongs. Set if and only if the user is logged in.

mind = (source)

A reference to the mind which logged in to this user. Set if and only if the user is logged in.

def __init__(self, name): (source)

Undocumented

name = (source)

A short string, unique among users.

groups = (source)

Undocumented

(type: list)
lastMessage = (source)

A POSIX timestamp indicating the time of the last message received from this user.

def loggedIn(self, realm, mind): (source)

Invoked by the associated IChatService when login occurs.

ParametersrealmThe IChatService through which login is occurring.
mindThe mind object used for cred login.
signOn = (source)

A POSIX timestamp indicating this user's most recent sign on time.

def join(self, group): (source)

Attempt to join the given group.

ParametersgroupUndocumented (type: IGroup)
ReturnsUndocumented (type: twisted.internet.defer.Deferred)
def leave(self, group, reason=None): (source)

Discontinue participation in the given group.

ParametersgroupUndocumented (type: IGroup)
reasonUndocumented
ReturnsUndocumented (type: twisted.internet.defer.Deferred)
def send(self, recipient, message): (source)

Send the given message to the given user or group.

ParametersrecipientUndocumented (type: Either IUser or IGroup)
messageUndocumented (type: dict)
def itergroups(self): (source)

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 21.2.0 at 2021-02-28 21:00:42.