XEP-0009: Jabber-RPC#
- class slixmpp.plugins.xep_0009.XEP_0009(xmpp, config=None)[source]#
- 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-0009: Jabber-RPC'#
A longer name for the plugin, describing its purpose. For example, a plugin for XEP-0030 would use ‘Service Discovery’ as its description value.
- name: str = 'xep_0009'#
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_0009.stanza.RPC.MethodCall(xml=None, parent=None)[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 usename = 'message'
.
- namespace: str = 'jabber:iq:rpc'#
The XML namespace for the element. Given
<foo xmlns="bar" />
, thennamespace = "bar"
should be used. The default namespace isjabber: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, theplugin_attrib
value defines the plugin name. Plugins may be accessed by using theplugin_attrib
value as the interface. An example usingplugin_attrib = 'foo'
:register_stanza_plugin(Message, FooPlugin) msg = Message() msg['foo']['an_interface_from_the_foo_plugin']
- plugin_attrib_map: ClassVar[Dict[str, Type[ElementBase]]] = {}#
A mapping of the
plugin_attrib
values of registered plugins to their respective classes.
- plugin_tag_map: ClassVar[Dict[str, Type[ElementBase]]] = {}#
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.
- subinterfaces = {}#
- class slixmpp.plugins.xep_0009.stanza.RPC.MethodResponse(xml=None, parent=None)[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 usename = 'message'
.
- namespace: str = 'jabber:iq:rpc'#
The XML namespace for the element. Given
<foo xmlns="bar" />
, thennamespace = "bar"
should be used. The default namespace isjabber: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, theplugin_attrib
value defines the plugin name. Plugins may be accessed by using theplugin_attrib
value as the interface. An example usingplugin_attrib = 'foo'
:register_stanza_plugin(Message, FooPlugin) msg = Message() msg['foo']['an_interface_from_the_foo_plugin']
- plugin_attrib_map: ClassVar[Dict[str, Type[ElementBase]]] = {}#
A mapping of the
plugin_attrib
values of registered plugins to their respective classes.
- plugin_tag_map: ClassVar[Dict[str, Type[ElementBase]]] = {}#
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.
- subinterfaces = {}#
- class slixmpp.plugins.xep_0009.stanza.RPC.RPCQuery(xml=None, parent=None)[source]#
- interfaces: ClassVar[Set[str]] = {}#
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 usename = 'message'
.
- namespace: str = 'jabber:iq:rpc'#
The XML namespace for the element. Given
<foo xmlns="bar" />
, thennamespace = "bar"
should be used. The default namespace isjabber: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, theplugin_attrib
value defines the plugin name. Plugins may be accessed by using theplugin_attrib
value as the interface. An example usingplugin_attrib = 'foo'
:register_stanza_plugin(Message, FooPlugin) msg = Message() msg['foo']['an_interface_from_the_foo_plugin']
- plugin_attrib_map: ClassVar[Dict[str, Type[ElementBase]]] = {}#
A mapping of the
plugin_attrib
values of registered plugins to their respective classes.
- plugin_tag_map: ClassVar[Dict[str, Type[ElementBase]]] = {}#
A mapping of root element tag names (in
'{namespace}elementname'
format) to the plugin classes responsible for them.
- subinterfaces = {}#