twisted.words.service.WordsRealm : API documentation

_encoding = (source)

Undocumented

(type: str)

def __init__(self, name): (source)

overridden in twisted.words.service.InMemoryWordsRealm

Undocumented

name = (source)

from twisted.words.iwords.IChatService

A short string identifying this chat service (eg, a hostname)

def userFactory(self, name): (source)

Undocumented

def groupFactory(self, name): (source)

Undocumented

def logoutFactory(self, avatar, facet): (source)

Undocumented

def requestAvatar(self, avatarId, mind, *interfaces): (source)

from twisted.cred.portal.IRealm

Return avatar which provides one of the given interfaces.

Parameters	avatarId	a string that identifies an avatar, as returned by `ICredentialsChecker.requestAvatarId` (via a Deferred). Alternatively, it may be `twisted.cred.checkers.ANONYMOUS`.
	mind	usually None. See the description of mind in `Portal.login`.
	interfaces	the interface(s) the returned avatar should implement, e.g. `IMailAccount`. See the description of `Portal.login`.
Returns	a deferred which will fire a tuple of (interface, avatarAspect, logout), or the tuple itself. The interface will be one of the interfaces passed in the 'interfaces' argument. The 'avatarAspect' will implement that interface. The 'logout' object is a callable which will detach the mind from the avatar.

def itergroups(self): (source)

from twisted.words.iwords.IChatService

overridden in twisted.words.service.InMemoryWordsRealm

Return all groups available on this service.

Returns A Deferred which fires with a list of IGroup providers. (type: twisted.internet.defer.Deferred)

createGroupOnRequest = (source)

from twisted.words.iwords.IChatService

A boolean indicating whether getGroup should implicitly create groups which are requested but which do not yet exist.

(type: bool)

createUserOnRequest = (source)

from twisted.words.iwords.IChatService

A boolean indicating whether getUser should implicitly create users which are requested but which do not yet exist.

(type: bool)

def lookupUser(self, name): (source)

overridden in twisted.words.service.InMemoryWordsRealm

Undocumented

def lookupGroup(self, group): (source)

from twisted.words.iwords.IChatService

overridden in twisted.words.service.InMemoryWordsRealm

Retrieve a group by name.

Unlike getGroup, this will never implicitly create a group.

Parameters	group	Undocumented
	name	Undocumented (type: `str`)
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`)

def addUser(self, user): (source)

overridden in twisted.words.service.InMemoryWordsRealm

Add the given user to this service.

This is an internal method intended to be overridden by WordsRealm subclasses, not called by external code.

Parameters	user	Undocumented (type: `IUser`)
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`)

def addGroup(self, group): (source)

overridden in twisted.words.service.InMemoryWordsRealm

Add the given group to this service.

Parameters	group	Undocumented (type: `IGroup`)
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`)

def getGroup(self, name): (source)

from twisted.words.iwords.IChatService

Retrieve the group by the given name.

Parameters	name	Undocumented (type: `str`)
Returns	A Deferred which fires with the group with the given name if one exists (or if one is created due to the setting of `IChatService.createGroupOnRequest`, or which fails with `twisted.words.ewords.NoSuchGroup` if no such group exists. (type: `twisted.internet.defer.Deferred`)

def getUser(self, name): (source)

from twisted.words.iwords.IChatService

Retrieve the user by the given name.

Parameters	name	Undocumented (type: `str`)
Returns	A Deferred which fires with the user with the given name if one exists (or if one is created due to the setting of `IChatService.createUserOnRequest`, or which fails with `twisted.words.ewords.NoSuchUser` if no such user exists. (type: `twisted.internet.defer.Deferred`)

def createUser(self, name): (source)

from twisted.words.iwords.IChatService

Create a new user with the given name.

Parameters	name	Undocumented (type: `str`)
Returns	A Deferred which fires with the created user, or with fails with `twisted.words.ewords.DuplicateUser` if a user by that name exists already. (type: `twisted.internet.defer.Deferred`)

def createGroup(self, name): (source)

from twisted.words.iwords.IChatService

Create a new group with the given name.

Parameters	name	Undocumented (type: `str`)
Returns	A Deferred which fires with the created group, or with fails with `twisted.words.ewords.DuplicateGroup` if a group by that name exists already. (type: `twisted.internet.defer.Deferred`)

Method	__init__	Undocumented
Instance Variable	name	A short string identifying this chat service (eg, a hostname)
Method	userFactory	Undocumented
Method	groupFactory	Undocumented
Method	logoutFactory	Undocumented
Method	requestAvatar	Return avatar which provides one of the given interfaces.
Method	itergroups	Return all groups available on this service.
Class Variable	createGroupOnRequest	A boolean indicating whether `getGroup` should implicitly create groups which are requested but which do not yet exist.
Class Variable	createUserOnRequest	A boolean indicating whether `getUser` should implicitly create users which are requested but which do not yet exist.
Method	lookupUser	Undocumented
Method	lookupGroup	Retrieve a group by name.
Method	addUser	Add the given user to this service.
Method	addGroup	Add the given group to this service.
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.
Class Variable	_encoding	Undocumented