XEP 0249¶

class slixmpp.plugins.xep_0249.XEP_0249(xmpp, config=None)[source]¶

XEP-0249: Direct MUC Invitations

send_invitation(jid, roomjid, password=None, reason=None, *, mfrom=None)[source]¶

Send a direct MUC invitation to an XMPP entity.

Parameters

jid (JID) – The JID of the entity that will receive the invitation
roomjid (JID) – the address of the groupchat room to be joined
password (str) – a password needed for entry into a password-protected room (OPTIONAL).
reason (str) – a human-readable purpose for the invitation (OPTIONAL).

stanza = <module 'slixmpp.plugins.xep_0249.stanza' from '/home/docs/checkouts/readthedocs.org/user_builds/slixmpp/checkouts/slix-1.6.0/slixmpp/plugins/xep_0249/stanza.py'>¶

Stanza elements¶

See the file LICENSE for copying permission.

class slixmpp.plugins.xep_0249.stanza.Invite(xml=None, parent=None)[source]¶

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)

interfaces = ('jid', 'password', 'reason')¶

name = 'x'¶

namespace = 'jabber:x:conference'¶

plugin_attrib = 'groupchat_invite'¶

XEP 0249

1.6 Documentation

XEP 0249¶

Stanza elements¶