twisted.words.iwords.IGroup : API documentation

Include the given user in this group.

Parameters user Undocumented (type: IUser)

def remove(user, reason=None): (source)

Remove the given user from this group.

Parameters	user	Undocumented (type: `IUser`)
	reason	Undocumented (type: `unicode`)

def size(): (source)

Return the number of participants in this group.

Returns A Deferred which fires with an int representing the number of participants in this group. (type: twisted.internet.defer.Deferred)

def receive(sender, recipient, message): (source)

Broadcast the given message from the given sender to other users in group.

The message is not re-transmitted to the sender.

Parameters	sender	`IUser`
	recipient	This is probably a wart. Maybe it will be removed in the future. For now, it should be the group object the message is being delivered to. (type: `IGroup`)
	message	`dict`
Returns	A Deferred which fires with None when delivery has been attempted for all users. (type: `twisted.internet.defer.Deferred`)

def setMetadata(meta): (source)

Change the metadata associated with this group.

Parameters meta Undocumented (type: dict)

def iterusers(): (source)

Return an iterator of all users in this group.

Attribute	name	A short string, unique among groups.
Method	add	Include the given user in this group.
Method	remove	Remove the given user from this group.
Method	size	Return the number of participants in this group.
Method	receive	Broadcast the given message from the given sender to other users in group.
Method	setMetadata	Change the metadata associated with this group.
Method	iterusers	Return an iterator of all users in this group.