twisted.words.iwords.IGroup(Interface)
interface documentationtwisted.words.iwords
View Source
(View In Hierarchy)
Known implementations: twisted.words.service.Group, twisted.words.service.PBGroupReference
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. |
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 ) |
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 ) |