Skip to content
Back to top
View this page

# XEP-0249: Direct MUC Invitations

XEP-0249 on xmpp.org

class slixmpp.plugins.xep_0249.XEP_0249(xmpp, config=None)

  XEP-0249: Direct MUC Invitations

  send_invitation(jid, roomjid, password=None, reason=None, *, mfrom=None)

    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` | `None`) – a password needed for entry into a password-protected room (OPTIONAL).

      - reason (`str` | `None`) – a human-readable purpose for the invitation (OPTIONAL).

## Stanza elements

class slixmpp.plugins.xep_0249.stanza.Invite(xml=None, parent=None)

  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: ClassVar[set[str]] = ('jid', 'password', 'reason')

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

    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 = 'jabber:x:conference'

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

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