jshiffer/slixmpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Expand support of XEP-0172 (user nickname) to include PEP.

Browse Source
This commit is contained in:
Lance Stout
2012-03-11 00:22:28 -08:00
parent 10ec92f7c6
commit 7d89fa27a8
6 changed files with 178 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
sleekxmpp/stanza/nick.py
View File

@@ -6,67 +6,12 @@
See the file LICENSE for copying permission.
"""
# The nickname stanza has been moved to its own plugin, but the existing
# references are kept for backwards compatibility.
from sleekxmpp.stanza import Message, Presence
from sleekxmpp.xmlstream import ElementBase, register_stanza_plugin
class Nick(ElementBase):
"""
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.
Methods:
setup -- Overrides ElementBase.setup.
get_nick -- Return the nickname in the <nick> element.
set_nick -- Add a <nick> element with the given nickname.
del_nick -- Remove the <nick> element.
"""
namespace = 'http://jabber.org/protocol/nick'
name = 'nick'
plugin_attrib = name
interfaces = set(('nick',))
def set_nick(self, nick):
"""
Add a <nick> element with the given nickname.
Arguments:
nick -- A human readable, informal name.
"""
self.xml.text = nick
def get_nick(self):
"""Return the nickname in the <nick> element."""
return self.xml.text
def del_nick(self):
"""Remove the <nick> element."""
if self.parent is not None:
self.parent().xml.remove(self.xml)
from sleekxmpp.xmlstream import register_stanza_plugin
from sleekxmpp.plugins.xep_0172 import UserNick as Nick
register_stanza_plugin(Message, Nick)
register_stanza_plugin(Presence, Nick)