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`.`service`.`AvatarReference``

class documentation

`class AvatarReference(pb.RemoteReference): (source)`

View In Hierarchy

Undocumented

Method | `join` | Undocumented
Method | `quit` | Undocumented

Inherited from `RemoteReference`:

Method | `__cmp__` | No summary
Method | `__del__` | Do distributed reference counting on finalization.
Method | `__hash__` | Hash me.
Method | `__init__` | (internal) Initialize me with a broker and a locally-unique ID.
Method | `callRemote` | Asynchronously invoke a remote method.
Method | `dontNotifyOnDisconnect` | Remove a callback that was registered with notifyOnDisconnect.
Method | `jellyFor` | If I am being sent back to where I came from, serialize as a local backreference.
Method | `notifyOnDisconnect` | Register a callback to be called if our broker gets disconnected.
Method | `remoteMethod` | No summary
Method | `unjellyFor` | Unjelly myself for the jellier.
Instance Variable | `broker` | The broker I am obtained through.
Instance Variable | `disconnectCallbacks` | Undocumented
Instance Variable | `doRefCount` | Undocumented
Instance Variable | `luid` | Undocumented
Instance Variable | `perspective` | Undocumented
Method | `_disconnected` | Called if we are disconnected and have callbacks registered.

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

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

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

Method | `getStateFor` | Undocumented

Inherited from `Ephemeral` (via `RemoteReference`, `Serializable`, `Jellyable`):

Method | `__getstate__` | Undocumented
Method | `__reduce__` | Serialize any subclass of `Ephemeral` in a way which replaces it with `Ephemeral` itself.
Method | `__setstate__` | Undocumented
Instance Variable | `__class__` | Undocumented

def join(self, groupName): (source)

Undocumented

def quit(self): (source)

Undocumented