twisted.words.iwords.IChatService

Method	`createGroup`	Create a new group with the given name.
Method	`createUser`	Create a new user with the given name.
Method	`getGroup`	Retrieve the group by the given name.
Method	`getUser`	Retrieve the user by the given name.
Method	`itergroups`	Return all groups available on this service.
Method	`lookupGroup`	Retrieve a group by name.
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.
Attribute	`name`	A short string identifying this chat service (eg, a hostname)

def createGroup(name): (source)

Create a new group with the given name.

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

def createUser(name): (source)

Create a new user with the given name.

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

def getGroup(name): (source)

Retrieve the group by the given name.

Parameters
name:`str`	Undocumented
Returns
`twisted.internet.defer.Deferred`	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.

def getUser(name): (source)

Retrieve the user by the given name.

Parameters
name:`str`	Undocumented
Returns
`twisted.internet.defer.Deferred`	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.

def itergroups(): (source)

Return all groups available on this service.

Returns
`twisted.internet.defer.Deferred`	A Deferred which fires with a list of `IGroup` providers.

def lookupGroup(name): (source)

Retrieve a group by name.

Unlike getGroup, this will never implicitly create a group.

Parameters
name:`str`	Undocumented
Returns
`twisted.internet.defer.Deferred`	A Deferred which fires with the group by the given name, or which fails with `twisted.words.ewords.NoSuchGroup`.

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.

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