XEP-0424: Message Retraction

class slixmpp.plugins.xep_0424.XEP_0424(xmpp, config=None)[source]

XEP-0424: Message Retraction

send_retraction(mto, id, mtype='chat', include_fallback=True, fallback_text=None, *, mfrom=None)[source]

Send a message retraction

Parameters
  • mto (JID) – The JID to retract the message from

  • id (str) – Message ID to retract

  • mtype (str) – Message type

  • include_fallback (bool) – Whether to include a fallback body

  • fallback_text (Optional[str]) – The content of the fallback body. None will set the default value.

Stanza elements

class slixmpp.plugins.xep_0424.stanza.Retract(xml=None, parent=None)[source]
name: ClassVar[str] = 'retract'

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:message-retract: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] = 'retract'

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']
class slixmpp.plugins.xep_0424.stanza.Retracted(xml=None, parent=None)[source]
interfaces: ClassVar[Set[str]] = {'stamp'}

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

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:message-retract: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] = 'retracted'

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']
slixmpp.plugins.xep_0424.stanza.register_plugins()[source]