twisted.words.service.InMemoryWordsRealm(WordsRealm)
class documentationtwisted.words.service
View Source
(View In Hierarchy)
Method | __init__ | Undocumented |
Method | itergroups | Return all groups available on this service. |
Method | addUser | Add the given user to this service. |
Method | addGroup | Add the given group to this service. |
Method | lookupUser | Undocumented |
Method | lookupGroup | Retrieve a group by name. |
Inherited from WordsRealm:
Method | userFactory | Undocumented |
Method | groupFactory | Undocumented |
Method | logoutFactory | Undocumented |
Method | requestAvatar | Return avatar which provides one of the given interfaces. |
Method | getGroup | Retrieve the group by the given name. |
Method | getUser | Retrieve the user by the given name. |
Method | createUser | Create a new user with the given name. |
Method | createGroup | Create a new group with the given name. |
Return all groups available on this service.
Returns | A Deferred which fires with a list of IGroup providers. (type: twisted.internet.defer.Deferred ) |
Add the given user to this service.
This is an internal method intended to be overridden by WordsRealm
subclasses, not called by external code.
Returns | A Deferred which fires with None
when the user is added, or which fails with twisted.words.ewords.DuplicateUser
if a user with the same name exists already. (type: twisted.internet.defer.Deferred ) |
Add the given group to this service.
Returns | A Deferred which fires with None
when the group is added, or which fails with twisted.words.ewords.DuplicateGroup
if a group with the same name exists already. (type: twisted.internet.defer.Deferred ) |
Retrieve a group by name.
Unlike getGroup
, this will never implicitly create a
group.
Returns | A Deferred which fires with the group by the given name, or which fails
with twisted.words.ewords.NoSuchGroup . (type: twisted.internet.defer.Deferred ) |