twisted.words.iwords.IChatService : API documentation

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

createGroupOnRequest = (source)

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

createUserOnRequest = (source)

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

def itergroups(): (source)

Return all groups available on this service.

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

def getGroup(name): (source)

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 createGroup(name): (source)

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`)

def lookupGroup(name): (source)

Retrieve a group by name.

Unlike getGroup, this will never implicitly create a group.

Parameters	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 getUser(name): (source)

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(name): (source)

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`)

Attribute	name	A short string identifying this chat service (eg, a hostname)
Attribute	createGroupOnRequest	A boolean indicating whether `getGroup` should implicitly create groups which are requested but which do not yet exist.
Attribute	createUserOnRequest	A boolean indicating whether `getUser` should implicitly create users which are requested but which do not yet exist.
Method	itergroups	Return all groups available on this service.
Method	getGroup	Retrieve the group by the given name.
Method	createGroup	Create a new group with the given name.
Method	lookupGroup	Retrieve a group by name.
Method	getUser	Retrieve the user by the given name.
Method	createUser	Create a new user with the given name.