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`.`interfaces`.`IAccount``

interface documentation

`class IAccount(Interface): (source)`

Known implementations: `twisted.words.im.ircsupport.IRCAccount`, `twisted.words.im.pbsupport.PBAccount`

View In Hierarchy

I represent a user's account with a chat service.

Method | `__init__` | No summary
Method | `getGroup` | No summary
Method | `getPerson` | No summary
Method | `isOnline` | Am I online?
Method | `logOff` | Sign off.
Method | `logOn` | Go on-line.
Attribute | `client` | The `IClient` currently connecting to this account, if any.
Attribute | `gatewayType` | A `str` that identifies the protocol used by this account.

def __init__(accountName, autoLogin, username, password, host, port): (source)

Parameters
accountName:string | A name to refer to the account by locally.
autoLogin:boolean | Undocumented
username:string | Undocumented
password:string | Undocumented
host:string | Undocumented
port:integer | Undocumented

def getGroup(groupName): (source)

Returns
`Group` | Undocumented

def getPerson(personName): (source)

Returns
`Person` | Undocumented

def isOnline(): (source)

Am I online?

Returns
boolean | Undocumented

def logOff(): (source)

Sign off.

def logOn(chatui): (source)

Go on-line.

Parameters
chatui:Implementor of `IChatUI` | Undocumented
Returns
`Deferred` with an eventual `IClient` result. | Undocumented

client = (source)

The `IClient` currently connecting to this account, if any.

gatewayType = (source)

A `str` that identifies the protocol used by this account.