Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`words`.`im`.`pbsupport`.`TwistedWordsGroup``

class documentation

`class TwistedWordsGroup(basesupport.AbstractGroup): (source)`

Constructor: `TwistedWordsGroup(name, wordsClient)`

Implements interfaces: `twisted.words.im.interfaces.IGroup`

View In Hierarchy

Undocumented

Method | `__init__` | Initialize me.
Method | `joining` | Undocumented
Method | `leave` | Depart this group.
Method | `leaving` | Undocumented
Method | `metadataFailed` | Undocumented
Method | `sendGroupMessage` | Return a deferred.
Method | `setTopic` | Set this Groups topic on the server.
Instance Variable | `joined` | Undocumented

Inherited from `AbstractGroup`:

Method | `__repr__` | Undocumented
Method | `__str__` | Undocumented
Method | `getGroupCommands` | finds group commands
Method | `getTargetCommands` | finds group commands
Method | `join` | Undocumented
Instance Variable | `account` | Undocumented
Instance Variable | `name` | Undocumented

def __init__(self, name, wordsClient): (source)
from `twisted.words.im.interfaces.IGroup`
overrides `twisted.words.im.basesupport.AbstractGroup.__init__`

Initialize me.

Parameters
name:str | My name, as the server knows me.
wordsClient | Undocumented
account:`Account` | The account I am accessed through.

def joining(self): (source)

Undocumented

def leave(self): (source)
from `twisted.words.im.interfaces.IGroup`
overrides `twisted.words.im.basesupport.AbstractGroup.leave`

Depart this group.

def leaving(self): (source)

Undocumented

def metadataFailed(self, result, text): (source)

Undocumented

def sendGroupMessage(self, text, metadata=None): (source)
from `twisted.words.im.interfaces.IGroup`

Return a deferred.

def setTopic(self, text): (source)
from `twisted.words.im.interfaces.IGroup`

Set this Groups topic on the server.

Parameters
text:string | Undocumented

joined: `int` = (source)

Undocumented