t.w.s.InMemoryWordsRealm(WordsRealm) : class documentation

Part of twisted.words.service View Source View In Hierarchy

Undocumented
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.
def __init__(self, *a, **kw): (source)
Undocumented
def itergroups(self): (source)
Return all groups available on this service.
ReturnsA Deferred which fires with a list of IGroup providers. (type: twisted.internet.defer.Deferred )
def addUser(self, user): (source)

Add the given user to this service.

This is an internal method intented to be overridden by WordsRealm subclasses, not called by external code.
Parametersuser (type: IUser )
ReturnsA 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 )
def addGroup(self, group): (source)
Add the given group to this service.
Parametersgroup (type: IGroup )
ReturnsA 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 )
def lookupUser(self, name): (source)
Undocumented
def lookupGroup(self, name): (source)

Retrieve a group by name.

Unlike getGroup, this will never implicitly create a group.
Parametersname (type: str )
ReturnsA Deferred which fires with the group by the given name, or which fails with twisted.words.ewords.NoSuchGroup. (type: twisted.internet.defer.Deferred )
API Documentation for Twisted, generated by pydoctor at 2011-10-27 16:17:34.