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

class documentation

`class TwistedWordsClient(pb.Referenceable, basesupport.AbstractClientMixin): (source)`

View In Hierarchy

In some cases, this acts as an Account, since it a source of text messages (multiple Words instances may be on a single PB connection)

Method | `__init__` | Undocumented
Method | `addContact` | Undocumented
Method | `connected` | Undocumented
Method | `getGroup` | Undocumented
Method | `getGroupConversation` | Undocumented
Method | `getPerson` | Undocumented
Method | `joinGroup` | Undocumented
Method | `leaveGroup` | Undocumented
Method | `remote_memberJoined` | Undocumented
Method | `remote_memberLeft` | Undocumented
Method | `remote_notifyStatusChanged` | Undocumented
Method | `remote_receiveContactList` | Undocumented
Method | `remote_receiveDirectMessage` | Undocumented
Method | `remote_receiveGroupMembers` | Undocumented
Method | `remote_receiveGroupMessage` | Undocumented
Method | `remote_setGroupMetadata` | Undocumented
Instance Variable | `account` | Undocumented
Instance Variable | `accountName` | Undocumented
Instance Variable | `chat` | Undocumented
Instance Variable | `name` | Undocumented
Instance Variable | `perspective` | I am an object sent remotely as a direct reference.
Method | `_cbGroupJoined` | Undocumented
Method | `_cbGroupLeft` | Undocumented
Instance Variable | `_logonDeferred` | Undocumented

Inherited from `Referenceable`:

Method | `jellyFor` | (internal)
Method | `remoteMessageReceived` | A remote message has been received. Dispatch it appropriately.

Inherited from `Serializable` (via `Referenceable`):

Method | `processUniqueID` | Return an ID which uniquely represents this object for this process.

Inherited from `Jellyable` (via `Referenceable`, `Serializable`):

Method | `getStateFor` | Undocumented

Inherited from `AbstractClientMixin` (via `Referenceable`, `Serializable`, `Jellyable`):

Method | `connectionLost` | Undocumented
Method | `connectionMade` | Undocumented
Method | `unregisterAsAccountClient` | Tell the chat UI that I have `signed off'.
Class Variable | `_protoBase` | Undocumented

def __init__(self, acct, serviceName, perspectiveName, chatui, _logonDeferred=None): (source)
overrides `twisted.words.im.basesupport.AbstractClientMixin.__init__`

Undocumented

def addContact(self, name): (source)

Undocumented

def connected(self, perspective): (source)

Undocumented

def getGroup(self, name): (source)

Undocumented

def getGroupConversation(self, name): (source)

Undocumented

def getPerson(self, name): (source)

Undocumented

def joinGroup(self, name): (source)

Undocumented

def leaveGroup(self, name): (source)

Undocumented

def remote_memberJoined(self, member, group): (source)

Undocumented

def remote_memberLeft(self, member, group): (source)

Undocumented

def remote_notifyStatusChanged(self, name, status): (source)

Undocumented

def remote_receiveContactList(self, clist): (source)

Undocumented

def remote_receiveDirectMessage(self, name, message, metadata=None): (source)

Undocumented

def remote_receiveGroupMembers(self, names, group): (source)

Undocumented

def remote_receiveGroupMessage(self, sender, group, message, metadata=None): (source)

Undocumented

def remote_setGroupMetadata(self, dict_, groupName): (source)

Undocumented

account = (source)
overrides `twisted.words.im.basesupport.AbstractClientMixin.account`

Undocumented

accountName = (source)

Undocumented

chat = (source)
overrides `twisted.words.im.basesupport.AbstractClientMixin.chat`

Undocumented

name = (source)

Undocumented

perspective = (source)
overrides `twisted.spread.pb.Referenceable.perspective`

I am an object sent remotely as a direct reference.

When one of my subclasses is sent as an argument to or returned from a remote method call, I will be serialized by default as a direct reference.

This means that the peer will be able to call methods on me; a method call xxx() from my peer will be resolved to methods of the name remote_xxx.

def _cbGroupJoined(self, result, name): (source)

Undocumented

def _cbGroupLeft(self, result, name): (source)

Undocumented

_logonDeferred = (source)
overrides `twisted.words.im.basesupport.AbstractClientMixin._logonDeferred`

Undocumented