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`.`TwistedWordsPerson``

class documentation

`class TwistedWordsPerson(basesupport.AbstractPerson): (source)`

View In Hierarchy

I a facade for a person you can talk to through a twisted.words service.

Method | `__init__` | Undocumented
Method | `getStatus` | Undocumented
Method | `isOnline` | Undocumented
Method | `metadataFailed` | Undocumented
Method | `sendMessage` | Return a deferred...
Method | `setStatus` | Undocumented
Instance Variable | `status` | Undocumented

Inherited from `AbstractPerson`:

Method | `__repr__` | Undocumented
Method | `__str__` | Undocumented
Method | `getIdleTime` | Returns a string.
Method | `getPersonCommands` | finds person commands
Instance Variable | `account` | Undocumented
Instance Variable | `name` | Undocumented

def __init__(self, name, wordsAccount): (source)
overrides `twisted.words.im.basesupport.AbstractPerson.__init__`

Undocumented

def getStatus(self): (source)

Undocumented

def isOnline(self): (source)

Undocumented

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

Undocumented

def sendMessage(self, text, metadata): (source)

Return a deferred...

def setStatus(self, status): (source)

Undocumented

status = (source)
overrides `twisted.words.im.basesupport.AbstractPerson.status`

Undocumented