Skip to content
Back to top
View this page

# XEP-0421: Anonymous unique occupant identifiers for MUCs

XEP-0421 on xmpp.org

class slixmpp.plugins.xep_0421.XEP_0421(xmpp, config=None)

  XEP-0421: Anonymous unique occupant identifiers for MUCs

  async has_feature(jid, **discokwargs)

    Check if the remote JID supports Occupant-Id This method can take all the additional kwargs that can be provided to XEP-0030’s get_info.

    Parameters:

      jid (`JID`) – JID of the remote entity.

    Return type:

      `bool`

    Returns:

      `True` if the server supports occupant-id.

## Stanza elements

class slixmpp.plugins.xep_0421.stanza.OccupantId(xml=None, parent=None)

  An Occupant-id tag.

  An <occupant-id/> tag is set by the MUC.

  This is useful in semi-anon MUCs (and MUC-PMs) as a stable identifier to prevent the usual races with nicknames.

  Without occupant-id, getting the following messages from MUC history would prevent a client from asserting senders are the same entity:

      <message type='groupchat' from='foo@muc/nick1' id='message1'>
          <body>Some message</body>
          <occupant-id xmlns='urn:xmpp:occupant-id:0' id='unique-opaque-id1'/>
      </message>
      <message type='groupchat' from='foo@muc/nick2' id='message2'>
          <body>Some correction</body>
          <occupant-id xmlns='urn:xmpp:occupant-id:0' id='unique-opaque-id1'/>
          <replace xmlns='urn:xmpp:message-correct:0' id='message1'/>
      </message>

  interface = {'id'}
  name: ClassVar[str] = 'occupant-id'

    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 = 'urn:xmpp:occupant-id:0'

    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] = 'occupant-id'

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