twisted.words.protocols.jabber.client : API documentation

Variable	NS_XMPP_STREAMS	Undocumented
Variable	NS_XMPP_BIND	Undocumented
Variable	NS_XMPP_SESSION	Undocumented
Variable	NS_IQ_AUTH_FEATURE	Undocumented
Variable	DigestAuthQry	Undocumented
Variable	PlaintextAuthQry	Undocumented
Function	basicClientFactory	Undocumented
Class	IQ	Wrapper for a Info/Query packet.
Class	IQAuthInitializer	Non-SASL Authentication initializer for the initiating entity.
Class	BasicAuthenticator	Authenticates an XmlStream against a Jabber server as a Client.
Class	CheckVersionInitializer	Initializer that checks if the minimum common stream version number is 1.0.
Class	BindInitializer	Initializer that implements Resource Binding for the initiating entity.
Class	SessionInitializer	Initializer that implements session establishment for the initiating entity.
Function	XMPPClientFactory	Client factory for XMPP 1.0 (only).
Class	XMPPAuthenticator	Initializes an XmlStream connecting to an XMPP server as a Client.

NS_XMPP_STREAMS = (source)

Undocumented

(type: str)

NS_XMPP_BIND = (source)

Undocumented

(type: str)

NS_XMPP_SESSION = (source)

Undocumented

(type: str)

NS_IQ_AUTH_FEATURE = (source)

Undocumented

(type: str)

DigestAuthQry = (source)

Undocumented

PlaintextAuthQry = (source)

Undocumented

def basicClientFactory(jid, secret): (source)

Undocumented

def XMPPClientFactory(jid, password, configurationForTLS=None): (source)

Client factory for XMPP 1.0 (only).

This returns a xmlstream.XmlStreamFactory with an XMPPAuthenticator object to perform the stream initialization steps (such as authentication).

Parameters	jid	Jabber ID to connect with. (type: `jid.JID`)
	password	password to authenticate with. (type: `unicode`)
	configurationForTLS	An object which creates appropriately configured TLS connections. This is passed to `startTLS` on the transport and is preferably created using `twisted.internet.ssl.optionsForClientTLS`. If `None`, the default is to verify the server certificate against the trust roots as provided by the platform. See `twisted.internet._sslverify.platformTrust`. (type: `IOpenSSLClientConnectionCreator` or `None`)
Returns	XML stream factory. (type: `xmlstream.XmlStreamFactory`)
See Also	The notes at `XMPPAuthenticator` describe how the `jid` and `password` parameters are to be used.