XEP-0009: Jabber-RPC

XEP-0009 on xmpp.org

class slixmpp.plugins.xep_0009.XEP_0009(xmpp, config=None)[source]

Stanza elements

class slixmpp.plugins.xep_0009.stanza.MethodCall(xml=None, parent=None)[source]
get_method_name()[source]
get_params()[source]
interfaces: ClassVar[set[str]] = {'method_name', 'params'}

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] = 'methodCall'

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:rpc'

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] = 'method_call'

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']
set_method_name(value)[source]
set_params(params)[source]
class slixmpp.plugins.xep_0009.stanza.MethodResponse(xml=None, parent=None)[source]
get_fault()[source]
Return type:

<module ‘xml.etree.ElementTree’ from ‘/usr/lib/python3.14/xml/etree/ElementTree.py’>

get_params()[source]
interfaces: ClassVar[set[str]] = {'fault', 'params'}

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] = 'methodResponse'

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:rpc'

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] = 'method_response'

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']
set_fault(fault)[source]
Return type:

None

set_params(params)[source]
class slixmpp.plugins.xep_0009.stanza.RPCQuery(xml=None, parent=None)[source]
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:rpc'

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] = 'rpc_query'

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']