twisted.words.iwords.IUser : API documentation

interface documentation

class twisted.words.iwords.IUser(Interface): (source)

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.

A short string, unique among users.

lastMessage = (source)

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

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

def loggedIn(realm, mind): (source)

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.

def send(recipient, message): (source)

Send the given message to the given user or group.

Parameters	recipient	Undocumented (type: Either `IUser` or `IGroup`)
	message	Undocumented (type: `dict`)

def join(group): (source)

Attempt to join the given group.

Parameters	group	Undocumented (type: `IGroup`)
Returns	Undocumented (type: `twisted.internet.defer.Deferred`)

def leave(group): (source)

Discontinue participation in the given group.

Parameters	group	Undocumented (type: `IGroup`)
Returns	Undocumented (type: `twisted.internet.defer.Deferred`)

def itergroups(): (source)

Return an iterator of all groups of which this user is a member.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.