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`.`protocols`.`jabber`.`sasl_mechanisms`.`Plain``

class documentation

`class Plain: (source)`

Implements interfaces: `twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism`

View In Hierarchy

Implements the PLAIN SASL authentication mechanism.

The PLAIN SASL authentication mechanism is defined in RFC 2595.

Method | `__init__` | No summary
Method | `getInitialResponse` | Get the initial client response, if defined for this mechanism.
Method | `getResponse` | Get the response to a server challenge.
Class Variable | `name` | Common name for the SASL Mechanism.
Instance Variable | `authcid` | Undocumented
Instance Variable | `authzid` | Undocumented
Instance Variable | `password` | Undocumented

def __init__(self, authzid, authcid, password): (source)

Parameters
authzid:`unicode` | The authorization identity.
authcid:`unicode` | The authentication identity.
password:`unicode` | The plain-text password.

def getInitialResponse(self): (source)
from `twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism`

Get the initial client response, if defined for this mechanism.

Returns
`str`. | initial client response string.

def getResponse(self, challenge): (source)
from `twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism`

Get the response to a server challenge.

Parameters
challenge:`str`. | server challenge.
Returns
`str`. | client response.

name: `str` = (source)
from `twisted.words.protocols.jabber.sasl_mechanisms.ISASLMechanism`

Common name for the SASL Mechanism.

authcid = (source)

Undocumented

authzid = (source)

Undocumented

password = (source)

Undocumented