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.6.0/slixmpp/plugins/xep_0172/stanza.py'>¶

stop(ifrom=None, timeout_callback=None, callback=None, timeout=None)[source]¶: Clear existing user nick information to stop notifications.

Stanza elements¶

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.

del_nick()[source]¶: Remove the <nick> element.

get_nick()[source]¶: Return the nickname in the <nick> element.

interfaces = {'nick'}¶

name = 'nick'¶

namespace = 'http://jabber.org/protocol/nick'¶

plugin_attrib = 'nick'¶

set_nick(nick)[source]¶

Add a <nick> element with the given nickname.

Arguments:: nick – A human readable, informal name.

XEP 0172

1.6 Documentation

XEP 0172¶

Stanza elements¶