Main classes

This section of the API covers the classes which are directly instantiated or used to communicate with an XMPP server.

• node — XMPP network nodes (clients, mostly)
  • Using XMPP
  • Connecting streams low-level
  • Utilities
• stream — Stanza stream
  • Context managers
  • Low-level stanza tracking
  • Filters
  • Exceptions
• stanza — XSOs for dealing with stanzas
  • Top-level classes
  • Payload classes
  • Exceptions
• security_layer — Implementations to negotiate stream security
  • Certificate verifiers
  • SASL providers
  • Abstract base classes
  • Deprecated functionality

Protocol part and XEP implementations

This section contains services (cf. aioxmpp.service) which can be summoned (cf. aioxmpp.Client.summon()) into a client, to extend its functionality or provide backwards compatibility.

• adhoc — Ad-Hoc Commands support (XEP-0050)
  • Client-side
  • Server-side
  • XSOs
• avatar — User avatar support (XEP-0084)
  • Services
  • Data Representation
  • Helpers
• blocking — Blocking Command support (XEP-0191)
• bookmarks – Bookmark support (XEP-0048)
  • Service
  • XSOs
  • Notes on usage
• carbons – Message Carbons (XEP-0280)
  • Service
  • XSOs
• disco — Service discovery support (XEP-0030)
  • Services
  • disco.xso — IQ payloads
• entitycaps — Entity Capabilities support (XEP-0390, XEP-0115)
  • Service
• forms — Data Forms support (XEP-0004)
  • Attributes added to stanzas
  • Declarative-style Forms
  • Bound fields
  • XSOs
• hashes — Hash Functions for use with XMPP (XEP-0300)
  • Utilities for Working with Hash Algorithm Identifiers
  • XSOs
• im — Instant Messaging Utilities and Services
  • Terminology
  • im.p2p — One-on-one conversations
  • aioxmpp.muc — Multi-User-Chats (XEP-0045)
  • Core Services
  • Enumerations
  • Abstract base classes
• muc — Multi-User-Chat support (XEP-0045)
  • Using Multi-User-Chats
  • Forms
  • XSOs
• ping — XMPP Ping (XEP-0199)
  • Service
  • XSOs
• presence — Peer presence bookkeeping
• pep — PEP support (XEP-0163)
• private_xml – Private XML Storage support (XEP-0049)
• pubsub — Publish-Subscribe support (XEP-0060)
  • Using Publish-Subscribe
  • XSOs
• roster — RFC 6121 roster implementation
  • roster.xso — IQ payloads and stream feature
• rfc6120 – Stanza payloads for RFC 6120 implementation
• rfc3921 — XSOs for legacy protocol parts
• rsm – Result Set Management (XEP-0059)
  • XSO
• shim — Stanza Headers and Internet Metadata (XEP-0131)

Less common and helper classes

The modules in this section implement some of the tools which are used to provide the functionality of the main classes (such as aioxmpp.callbacks). In addition, classes and modules which are rarely used directly by basic clients (such as the aioxmpp.sasl module) are sorted into this section.

• structs — Simple data holders for common data types
  • Stanza types
  • Jabber IDs
  • Presence
  • Languages
• tracking — Interfaces for high-level message tracking
  • General Remarks about Tracking and Memory Consumption
  • Tracking implementations
  • Interfaces
• nonza — Non-stanza stream-level XSOs (Nonzas)
  • General XSOs
  • StartTLS related XSOs
  • SASL related XSOs
  • Stream management related XSOs
• sasl – SASL helpers
• errors — Exception classes
  • Exception classes mapping to XMPP stream errors
  • Exception classes mapping to XMPP stanza errors
  • Stream negotiation exceptions
  • I18N exceptions
  • Other exceptions
• i18n – Helper functions for localizing text
  • Shorthand functions
• callbacks – Synchronous and asynchronous callbacks
  • Descriptor vs. ad-hoc
  • Class overview
  • Filters
• connector — Ways to establish XML streams
  • Abstract base class
  • Specific connectors
• dispatcher — Dispatch stanzas to callbacks
  • Stanza Dispatchers for Messages and Presences
  • Decorators for aioxmpp.service.Service Methods
  • Base Class for Stanza Dispatchers
• misc – Miscellaneous XSOs
  • Delayed Delivery (XEP-0203)
  • Stanza Forwarding (XEP-0297)

APIs mainly relevant for extension developers

These APIs are used by many of the other modules, but detailed knowledge is usually required (for users of aioxmpp) only if extensions are to be developed.

• service — Utilities for implementing Client services
  • Decorators and Descriptors
  • Metaclass
• xso — Working with XML stream contents
  • Terminology
  • General functions
  • Object declaration with aioxmpp.xso.model
  • Types and validators from types
  • Querying data from XSOs
  • Predefined XSO base classes