BaseXMPP¶
-
class
slixmpp.basexmpp.
BaseXMPP
(jid='', default_ns='jabber:client', **kwargs)[source]¶ The BaseXMPP class adapts the generic XMLStream class for use with XMPP. It also provides a plugin mechanism to easily extend and add support for new XMPP features.
- Parameters
default_ns – Ensure that the correct default XML namespace is used during initialization.
-
api
¶ The API registry is a way to process callbacks based on JID+node combinations. Each callback in the registry is marked with:
An API name, e.g. xep_0030
The name of an action, e.g. get_info
The JID that will be affected
The node that will be affected
API handlers with no JID or node will act as global handlers, while those with a JID and no node will service all nodes for a JID, and handlers with both a JID and node will be used only for that specific combination. The handler that provides the most specificity will be used.
Auto accept or deny subscription requests.
If
True
, auto accept subscription requests. IfFalse
, auto deny subscription requests. IfNone
, don’t automatically respond.
-
property
auto_subscribe
¶ Auto send requests for mutual subscriptions.
If
True
, auto send mutual subscription requests.
-
boundjid
¶ The JabberID (JID) used by this connection, as set after session binding. This may even be a different bare JID than what was requested.
-
client_roster
¶ The single roster for the bound JID. This is the equivalent of:
self.roster[self.boundjid.bare]
-
exception
(exception)[source]¶ Process any uncaught exceptions, notably
IqError
andIqTimeout
exceptions.- Parameters
exception – An unhandled
Exception
object.
-
property
fulljid
¶ Attribute accessor for full jid
-
is_component
¶ The distinction between clients and components can be important, primarily for choosing how to handle the
'to'
and'from'
JIDs of stanzas.
-
property
jid
¶ Attribute accessor for bare jid
-
make_iq
(id=0, ifrom=None, ito=None, itype=None, iquery=None)[source]¶ Create a new Iq stanza with a given Id and from JID.
- Parameters
id – An ideally unique ID value for this stanza thread. Defaults to 0.
ifrom – The from
JID
to use for this stanza.ito – The destination
JID
for this stanza.itype – The
Iq
’s type, one of:'get'
,'set'
,'result'
, or'error'
.iquery – Optional namespace for adding a query element.
-
make_iq_error
(id, type='cancel', condition='feature-not-implemented', text=None, ito=None, ifrom=None, iq=None)[source]¶ Create an
Iq
stanza of type'error'
.- Parameters
id – An ideally unique ID value. May use
new_id()
.type – The type of the error, such as
'cancel'
or'modify'
. Defaults to'cancel'
.condition – The error condition. Defaults to
'feature-not-implemented'
.text – A message describing the cause of the error.
ito – The destination
JID
for this stanza.ifrom – The
'from'
JID
to use for this stanza.iq – Optionally use an existing stanza instead of generating a new one.
-
make_iq_get
(queryxmlns=None, ito=None, ifrom=None, iq=None)[source]¶ Create an
Iq
stanza of type'get'
.Optionally, a query element may be added.
- Parameters
queryxmlns – The namespace of the query to use.
ito – The destination
JID
for this stanza.ifrom – The
'from'
JID
to use for this stanza.iq – Optionally use an existing stanza instead of generating a new one.
-
make_iq_query
(iq=None, xmlns='', ito=None, ifrom=None)[source]¶ Create or modify an
Iq
stanza to use the given query namespace.- Parameters
iq – Optionally use an existing stanza instead of generating a new one.
xmlns – The query’s namespace.
ito – The destination
JID
for this stanza.ifrom – The
'from'
JID
to use for this stanza.
-
make_iq_result
(id=None, ito=None, ifrom=None, iq=None)[source]¶ Create an
Iq
stanza of type'result'
with the given ID value.- Parameters
id – An ideally unique ID value. May use
new_id()
.ito – The destination
JID
for this stanza.ifrom – The
'from'
JID
to use for this stanza.iq – Optionally use an existing stanza instead of generating a new one.
-
make_iq_set
(sub=None, ito=None, ifrom=None, iq=None)[source]¶ Create an
Iq
stanza of type'set'
.Optionally, a substanza may be given to use as the stanza’s payload.
- Parameters
sub – Either an
ElementBase
stanza object or anElement
XML object to use as theIq
’s payload.ito – The destination
JID
for this stanza.ifrom – The
'from'
JID
to use for this stanza.iq – Optionally use an existing stanza instead of generating a new one.
-
make_message
(mto, mbody=None, msubject=None, mtype=None, mhtml=None, mfrom=None, mnick=None)[source]¶ Create and initialize a new
Message
stanza.- Parameters
mto – The recipient of the message.
mbody – The main contents of the message.
msubject – Optional subject for the message.
mtype – The message’s type, such as
'chat'
or'groupchat'
.mhtml – Optional HTML body content in the form of a string.
mfrom – The sender of the message. if sending from a client, be aware that some servers require that the full JID of the sender be used.
mnick – Optional nickname of the sender.
-
make_presence
(pshow=None, pstatus=None, ppriority=None, pto=None, ptype=None, pfrom=None, pnick=None)[source]¶ Create and initialize a new
Presence
stanza.- Parameters
pshow – The presence’s show value.
pstatus – The presence’s status message.
ppriority – This connection’s priority.
pto – The recipient of a directed presence.
ptype – The type of presence, such as
'subscribe'
.pfrom – The sender of the presence.
pnick – Optional nickname of the presence’s sender.
-
make_query_roster
(iq=None)[source]¶ Create a roster query element.
- Parameters
iq – Optionally use an existing stanza instead of generating a new one.
-
max_redirects
¶ The maximum number of consecutive see-other-host redirections that will be followed before quitting.
-
plugin
¶ A dictionary mapping plugin names to plugins.
-
plugin_config
¶ Configuration options for whitelisted plugins. If a plugin is registered without any configuration, and there is an entry here, it will be used.
-
plugin_whitelist
¶ A list of plugins that will be loaded if
register_plugins()
is called.
-
process
(*, forever=True, timeout=None)[source]¶ Process all the available XMPP events (receiving or sending data on the socket(s), calling various registered callbacks, calling expired timers, handling signal events, etc). If timeout is None, this function will run forever. If timeout is a number, this function will return after the given time in seconds.
-
register_plugin
(plugin, pconfig=None, module=None)[source]¶ Register and configure a plugin for use in this stream.
- Parameters
plugin – The name of the plugin class. Plugin names must be unique.
pconfig – A dictionary of configuration data for the plugin. Defaults to an empty dictionary.
module – Optional refence to the module containing the plugin class if using custom plugins.
-
register_plugins
()[source]¶ Register and initialize all built-in plugins.
Optionally, the list of plugins loaded may be limited to those contained in
plugin_whitelist
.Plugin configurations stored in
plugin_config
will be used.
-
requested_jid
¶ The JabberID (JID) requested for this connection.
-
property
resource
¶ Attribute accessor for jid resource
-
roster
¶ The main roster object. This roster supports multiple owner JIDs, as in the case for components. For clients which only have a single JID, see
client_roster
.
-
send_message
(mto, mbody, msubject=None, mtype=None, mhtml=None, mfrom=None, mnick=None)[source]¶ Create, initialize, and send a new
Message
stanza.- Parameters
mto – The recipient of the message.
mbody – The main contents of the message.
msubject – Optional subject for the message.
mtype – The message’s type, such as
'chat'
or'groupchat'
.mhtml – Optional HTML body content in the form of a string.
mfrom – The sender of the message. if sending from a client, be aware that some servers require that the full JID of the sender be used.
mnick – Optional nickname of the sender.
-
send_presence
(pshow=None, pstatus=None, ppriority=None, pto=None, pfrom=None, ptype=None, pnick=None)[source]¶ Create, initialize, and send a new
Presence
stanza.- Parameters
pshow – The presence’s show value.
pstatus – The presence’s status message.
ppriority – This connection’s priority.
pto – The recipient of a directed presence.
ptype – The type of presence, such as
'subscribe'
.pfrom – The sender of the presence.
pnick – Optional nickname of the presence’s sender.
-
send_presence_subscription
(pto, pfrom=None, ptype='subscribe', pnick=None)[source]¶ Create, initialize, and send a new
Presence
stanza of type'subscribe'
.- Parameters
pto – The recipient of a directed presence.
pfrom – The sender of the presence.
ptype – The type of presence, such as
'subscribe'
.pnick – Optional nickname of the presence’s sender.
-
sentpresence
¶ Flag indicating that the initial presence broadcast has been sent. Until this happens, some servers may not behave as expected when sending stanzas.
-
property
server
¶ Attribute accessor for jid host
-
stanza
¶ A reference to
slixmpp.stanza
to make accessing stanza classes easier.
-
start_stream_handler
(xml)[source]¶ Save the stream ID once the streams have been established.
- Parameters
xml – The incoming stream’s root element.
-
stream_id
¶ An identifier for the stream as given by the server.
-
use_message_ids
¶ Messages may optionally be tagged with ID values. Setting
use_message_ids
to True will assign all outgoing messages an ID. Some plugin features require enabling this option.
-
use_origin_id
¶ XEP-0359 <origin-id/> tag that gets added to <message/> stanzas.
-
use_presence_ids
¶ Presence updates may optionally be tagged with ID values. Setting
use_message_ids
to True will assign all outgoing messages an ID.
-
property
username
¶ Attribute accessor for jid usernode