twisted.words.iwords.IUser(Interface)
interface documentationtwisted.words.iwords
View Source
(View In Hierarchy)
Known implementations: twisted.words.service.User
Interface through which clients interact with IChatService.
Attribute | realm | A reference to the Realm to which this user belongs. Set if and only if the user is logged in. |
Attribute | mind | A reference to the mind which logged in to this user. Set if and only if the user is logged in. |
Attribute | name | A short string, unique among users. |
Attribute | lastMessage | A POSIX timestamp indicating the time of the last message received from this user. |
Attribute | signOn | A POSIX timestamp indicating this user's most recent sign on time. |
Method | loggedIn | Invoked by the associated IChatService
when login occurs. |
Method | send | Send the given message to the given user or group. |
Method | join | Attempt to join the given group. |
Method | leave | Discontinue participation in the given group. |
Method | itergroups | Return an iterator of all groups of which this user is a member. |
A reference to the Realm to which this user belongs. Set if and only if the user is logged in.
A reference to the mind which logged in to this user. Set if and only if the user is logged in.
Invoked by the associated IChatService
when login occurs.
Parameters | realm | The IChatService
through which login is occurring. |
mind | The mind object used for cred login. |
Attempt to join the given group.
Returns | (type: twisted.internet.defer.Deferred ) |
Discontinue participation in the given group.
Returns | (type: twisted.internet.defer.Deferred ) |