twisted.words.service.Group : API documentation

Method	`__init__`	Undocumented
Instance Variable	`name`	A short string, unique among groups.
Instance Variable	`users`	Undocumented
Instance Variable	`meta`	Undocumented
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.
Method	`_ebUserCall`	Undocumented
Method	`_cbUserCall`	Undocumented

def __init__(self, name): (source)

Undocumented

from twisted.words.iwords.IGroup

A short string, unique among groups.

Undocumented

(type: dict)

Undocumented

def _ebUserCall(self, err, p): (source)

Undocumented

def _cbUserCall(self, results): (source)

Undocumented

def add(self, user): (source)

from twisted.words.iwords.IGroup

Include the given user in this group.

Parameters user Undocumented (type: IUser)

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

from twisted.words.iwords.IGroup

Remove the given user from this group.

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

def size(self): (source)

from twisted.words.iwords.IGroup

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(self, sender, recipient, message): (source)

from twisted.words.iwords.IGroup

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(self, meta): (source)

from twisted.words.iwords.IGroup

Change the metadata associated with this group.

Parameters meta Undocumented (type: dict)

def iterusers(self): (source)

from twisted.words.iwords.IGroup

Return an iterator of all users in this group.