Skip to content
Back to top
View this page

# XEP-0461: Message Replies

XEP-0461 on xmpp.org

class slixmpp.plugins.xep_0461.XEP_0461(xmpp, config=None)

  XEP-0461: Message Replies

  make_reply(reply_to, reply_id, fallback=None, quoted_nick=None, **msg_kwargs)

    Create a replies message stanza

    Parameters:

      - reply_to (`str` | `JID`) – Full JID of the quoted author

      - reply_id (`str`) – ID of the message to reply to

      - fallback (`str` | `None`) – Body of the quoted message

      - quoted_nick (`str` | `None`) – nickname of the quoted participant

      - msg_kwargs – Parameters are consistent with the make_message method, required parameters are `mto` and `mbody`

  send_reply(reply_to, reply_id, fallback=None, quoted_nick=None, **msg_kwargs)
    Parameters:

      - reply_to (`str` | `JID`) – Full JID of the quoted author

      - reply_id (`str`) – ID of the message to reply to

      - fallback (`str` | `None`) – Body of the quoted message

      - quoted_nick (`str` | `None`) – nickname of the quoted participant

## Stanza elements

class slixmpp.plugins.xep_0461.stanza.Reply(xml=None, parent=None)
  add_quoted_fallback(fallback, nickname=None)

    Add plain text fallback for clients not implementing XEP-0461.

    `msg["reply"].add_quoted_fallback("Some text", "Bob")` will prepend `> Bob:\n> Some text\n` to the body of the message, and set the fallback_body attributes accordingly, so that clients implementing XEP-0461 can hide the fallback text.

    Parameters:

      - fallback (`str`) – Body of the quoted message.

      - nickname (`str` | `None`) – Optional, nickname of the quoted participant.

    Return type:

      `None`

  get_fallback_body()

    Get the string containing the fallback body from the parent.

    Return type:

      `str`

  interfaces: ClassVar[set[str]] = {'id', 'to'}

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

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

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

  strip_fallback_content()

    Remove the fallback contents from the parent body.

    Return type:

      `str`

slixmpp.plugins.xep_0461.stanza.register_plugins()
  Return type:

    `None`