t.w.p.j.client : module documentation

Part of twisted.words.protocols.jabber View Source

No module docstring
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.
def basicClientFactory(jid, secret): (source)
Undocumented
def XMPPClientFactory(jid, password): (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).

ParametersjidJabber ID to connect with. (type: jid.JID)
passwordpassword to authenticate with. (type: unicode)
ReturnsXML stream factory. (type: xmlstream.XmlStreamFactory)
See AlsoThe notes at XMPPAuthenticator describe how the jid and password parameters are to be used.
API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.