XEP 0172¶
- class slixmpp.plugins.xep_0172.XEP_0172(xmpp, config=None)[source]¶
XEP-0172: User Nickname
- publish_nick(nick=None, options=None, ifrom=None, timeout_callback=None, callback=None, timeout=None)[source]¶
Publish the user’s current nick.
- Parameters
nick (
Optional
[str
]) – The user nickname to publish.options (
Optional
[Form
]) – Optional form of publish options.
- stanza = <module 'slixmpp.plugins.xep_0172.stanza' from '/home/docs/checkouts/readthedocs.org/user_builds/slixmpp/checkouts/slix-1.7.1/slixmpp/plugins/xep_0172/stanza.py'>¶
Stanza elements¶
Slixmpp: The Slick XMPP Library Copyright (C) 2012 Nathanael C. Fritz, Lance J.T. Stout This file is part of Slixmpp.
See the file LICENSE for copying permission.
- class slixmpp.plugins.xep_0172.stanza.UserNick(xml=None, parent=None)[source]¶
XEP-0172: User Nickname allows the addition of a <nick> element in several stanza types, including <message> and <presence> stanzas.
The nickname contained in a <nick> should be the global, friendly or informal name chosen by the owner of a bare JID. The <nick> element may be included when establishing communications with new entities, such as normal XMPP users or MUC services.
The nickname contained in a <nick> element will not necessarily be the same as the nickname used in a MUC.
Example stanzas:
<message to="user@example.com"> <nick xmlns="http://jabber.org/nick/nick">The User</nick> <body>...</body> </message> <presence to="otheruser@example.com" type="subscribe"> <nick xmlns="http://jabber.org/nick/nick">The User</nick> </presence>
Stanza Interface:
nick -- A global, friendly or informal name chosen by a user.
- interfaces = {'nick'}¶
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 = 'nick'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace = 'http://jabber.org/protocol/nick'¶
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 = 'nick'¶
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']