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

class documentation

`class PBAccount(basesupport.AbstractAccount): (source)`

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

View In Hierarchy

Undocumented

Method | `__init__` | No summary
Method | `logOff` | Sign off.
Method | `logOn` | No summary
Class Variable | `gatewayType` | A `str` that identifies the protocol used by this account.
Instance Variable | `services` | Undocumented
Method | `_cbConnected` | Undocumented
Method | `_cbIdent` | Undocumented
Method | `_ebConnected` | Undocumented
Method | `_startLogOn` | Start the sign on process.
Instance Variable | `_isConnecting` | Undocumented

Inherited from `AbstractAccount`:

Method | `__getstate__` | Get state, adding a version number to it on its way out.
Method | `__repr__` | Undocumented
Method | `getGroup` | Group factory.
Method | `getPerson` | Person factory.
Method | `isOnline` | Undocumented
Method | `upgrateToVersion2` | Undocumented
Class Variable | `persistanceVersion` | Undocumented
Instance Variable | `accountName` | No summary
Instance Variable | `autoLogin` | No summary
Instance Variable | `client` | Undocumented
Instance Variable | `host` | No summary
Instance Variable | `password` | No summary
Instance Variable | `port` | No summary
Instance Variable | `username` | No summary
Method | `_cb_logOn` | Undocumented
Method | `_clientLost` | Undocumented
Method | `_loginFailed` | Errorback for `logOn`.
Class Variable | `_groupFactory` | A Callable that will return a `IGroup` appropriate for this account type.
Class Variable | `_personFactory` | A Callable that will return a `IPerson` appropriate for this account type.
Instance Variable | `_groups` | Undocumented
Instance Variable | `_isOnline` | Whether I am currently on-line with the server.
Instance Variable | `_persons` | Undocumented

Inherited from `Versioned` (via `AbstractAccount`):

Method | `__setstate__` | Undocumented
Method | `versionUpgrade` | (internal) Do a version upgrade.
Class Variable | `persistenceForgets` | Undocumented
Class Variable | `persistenceVersion` | Undocumented
Instance Variable | `__dict__` | Undocumented

def __init__(self, accountName, autoLogin, username, password, host, port, services=None): (source)
from `twisted.words.im.interfaces.IAccount`
overrides `twisted.words.im.basesupport.AbstractAccount.__init__`

Parameters
accountName | Undocumented
autoLogin | Undocumented
username:string | The name of your PB Identity.
password | Undocumented
host | Undocumented
port | Undocumented
services | Undocumented

def logOff(self): (source)
from `twisted.words.im.interfaces.IAccount`

Sign off.

def logOn(self, chatui): (source)
from `twisted.words.im.interfaces.IAccount`
overrides `twisted.words.im.basesupport.AbstractAccount.logOn`

Returns
DeferredList of `interfaces.IClient`s | this breaks with `interfaces.IAccount`

gatewayType: `str` = (source)
from `twisted.words.im.interfaces.IAccount`

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

services: `list` = (source)

Undocumented

def _cbConnected(self, root, chatui): (source)

Undocumented

def _cbIdent(self, ident, chatui): (source)

Undocumented

def _ebConnected(self, error): (source)

Undocumented

def _startLogOn(self, chatui): (source)
overrides `twisted.words.im.basesupport.AbstractAccount._startLogOn`

Start the sign on process.

Factored out of `logOn`.

Returns
Deferred `interfaces.IClient` | Undocumented

_isConnecting: `int` = (source)
overrides `twisted.words.im.basesupport.AbstractAccount._isConnecting`

Undocumented