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`.`iwords`.`IProtocolPlugin``

interface documentation

`class IProtocolPlugin(Interface): (source)`

View In Hierarchy

Interface for plugins providing an interface to a Words service

Method | `getFactory` | Retrieve a `twisted.internet.interfaces.IServerFactory` provider
Attribute | `name` | A single word describing what kind of interface this is (eg, irc or web)

def getFactory(realm, portal): (source)

Retrieve a `twisted.internet.interfaces.IServerFactory` provider

Parameters
realm | An object providing `twisted.cred.portal.IRealm` and `IChatService`, with which service information should be looked up.
portal | An object providing `twisted.cred.portal.IPortal`, through which logins should be performed.

name = (source)

A single word describing what kind of interface this is (eg, irc or web)