XEP-0092: Software Version#

class slixmpp.plugins.xep_0092.XEP_0092(xmpp, config=None)[source]#

XEP-0092: Software Version

default_config: ClassVar[Dict[str, Any]] = {'os': '', 'software_name': 'Slixmpp', 'version': '1.8.5'}#

The basic, standard configuration for the plugin, which may be overridden when initializing the plugin. The configuration fields included here may be accessed directly as attributes of the plugin. For example, including the configuration field ‘foo’ would mean accessing plugin.foo returns the current value of plugin.config[‘foo’].

dependencies: ClassVar[Set[str]] = {'xep_0030'}#

Some plugins may depend on others in order to function properly. Any plugin names included in dependencies will be initialized as needed if this plugin is enabled.

description: str = 'XEP-0092: Software Version'#

A longer name for the plugin, describing its purpose. For example, a plugin for XEP-0030 would use ‘Service Discovery’ as its description value.

get_version(jid, ifrom=None, **iqkwargs)[source]#

Retrieve the software version of a remote agent.

Parameters:

jid (JID) – The JID of the entity to query.

Return type:

Future

name: str = 'xep_0092'#

A short name for the plugin based on the implemented specification. For example, a plugin for XEP-0030 would use ‘xep_0030’.

Stanza elements#

class slixmpp.plugins.xep_0092.stanza.Version(xml=None, parent=None)[source]#

XMPP allows for an agent to advertise the name and version of the underlying software libraries, as well as the operating system that the agent is running on.

Example version stanzas:

<iq type="get">
  <query xmlns="jabber:iq:version" />
</iq>

<iq type="result">
  <query xmlns="jabber:iq:version">
    <name>Slixmpp</name>
    <version>1.0</version>
    <os>Linux</os>
  </query>
</iq>

Stanza Interface:

name    -- The human readable name of the software.
version -- The specific version of the software.
os      -- The name of the operating system running the program.
interfaces: ClassVar[Set[str]] = {'name', 'os', 'version'}#

The set of keys that the stanza provides for accessing and manipulating the underlying XML object. This set may be augmented with the plugin_attrib value of any registered stanza plugins.

name: ClassVar[str] = 'query'#

The XML tag name of the element, not including any namespace prefixes. For example, an ElementBase object for <message /> would use name = 'message'.

namespace: str = 'jabber:iq:version'#

The XML namespace for the element. Given <foo xmlns="bar" />, then namespace = "bar" should be used. The default namespace is jabber:client since this is being used in an XMPP library.

plugin_attrib: ClassVar[str] = 'software_version'#

For ElementBase subclasses which are intended to be used as plugins, the plugin_attrib value defines the plugin name. Plugins may be accessed by using the plugin_attrib value as the interface. An example using plugin_attrib = 'foo':

register_stanza_plugin(Message, FooPlugin)
msg = Message()
msg['foo']['an_interface_from_the_foo_plugin']
sub_interfaces: ClassVar[Set[str]] = {'name', 'os', 'version'}#

A subset of interfaces which maps interfaces to direct subelements of the underlying XML object. Using this set, the text of these subelements may be set, retrieved, or removed without needing to define custom methods.