SleekXMPP/sleekxmpp/plugins/xep_0249/stanza.py
2011-01-11 04:11:05 +08:00

29 lines
No EOL
977 B
Python

from sleekxmpp.xmlstream import ElementBase
class Invite(ElementBase):
"""
XMPP allows for an agent in an MUC room to directly invite another
user to join the chat room (as opposed to a mediated invitation
done through the server).
Example invite stanza:
<message from='crone1@shakespeare.lit/desktop'
to='hecate@shakespeare.lit'>
<x xmlns='jabber:x:conference'
jid='darkcave@macbeth.shakespeare.lit'
password='cauldronburn'
reason='Hey Hecate, this is the place for all good witches!'/>
</message>
Stanza Interface:
jid -- The JID of the groupchat room
password -- The password used to gain entry in the room
(optional)
reason -- The reason for the invitation (optional)
"""
name = "x"
namespace = "jabber:x:conference"
plugin_attrib = "groupchat_invite"
interfaces = ("jid", "password", "reason")