Skip to content
Back to top
View this page

# XEP-0172: User Nickname

class slixmpp.plugins.xep_0172.XEP_0172(xmpp, config=None)

  XEP-0172: User Nickname

  dependencies: ClassVar[Set[str]] = {'xep_0163'}

    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-0172: User Nickname'

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

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

  publish_nick(nick=None, **pubsubkwargs)

    Publish the user’s current nick.

    Parameters:

      nick (`str` | `None`) – The user nickname to publish.

    Return type:

      `Future`

  stop(**pubsubkwargs)

    Clear existing user nick information to stop notifications.

    Return type:

      `Future`

## Stanza elements

class slixmpp.plugins.xep_0172.stanza.UserNick(xml=None, parent=None)

  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()

    Remove the <nick> element.

  get_nick()

    Return the nickname in the <nick> element.

  interfaces: ClassVar[Set[str]] = {'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: ClassVar[str] = 'nick'

    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 = 'http://jabber.org/protocol/nick'

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

    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_nick(nick)

    Add a <nick> element with the given nickname.

    Arguments:

      nick – A human readable, informal name.