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`.`ircsupport`.`IRCGroup``

class documentation

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

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

View In Hierarchy

Undocumented

Method | `imgroup_testAction` | Undocumented
Method | `imtarget_kick` | Undocumented
Method | `leave` | Depart this group.
Method | `sendGroupMessage` | Send a message to this group.
Method | `setTopic` | Set this Groups topic on the server.

Inherited from `AbstractGroup`:

Method | `__init__` | Undocumented
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 imgroup_testAction(self): (source)

Undocumented

def imtarget_kick(self, target): (source)

Undocumented

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

Depart this group.

def sendGroupMessage(self, text, meta={}): (source)
from `twisted.words.im.interfaces.IGroup`

Send a message to this group.

Parameters
text:str | Undocumented
meta | Undocumented

metadata:dict

Valid keys for this dictionary include:

- `'style'`: associated with one of:
  - `'emote'`: indicates this is an action

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

Set this Groups topic on the server.

Parameters
topic | Undocumented
text:string | Undocumented