Skip to content
Back to top
View this page

# XEP-0428: Fallback Indication

XEP-0428 on xmpp.org

class slixmpp.plugins.xep_0428.XEP_0428(xmpp, config=None)

  XEP-0428: Fallback Indication

## Stanza elements

class slixmpp.plugins.xep_0428.stanza.Fallback(xml=None, parent=None)
  get_stripped_body(fallback_for, element='body')

    Get the body of a message, with the fallback part stripped

    Parameters:

      - fallback_for (`str`) – namespace of the fallback to strip

      - element (`Literal`[`'body'`, `'subject'`]) – set this to “subject” get the stripped subject instead of body

    Return type:

      `str`

    Returns:

      body (or subject) content minus the fallback part

  interfaces: ClassVar[set[str]] = {'for'}

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

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

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

  plugin_multi_attrib: ClassVar[str] = 'fallbacks'

    For `ElementBase` subclasses that are intended to be an iterable group of items, the `plugin_multi_attrib` value defines an interface for the parent stanza which returns the entire group of matching substanzas. So the following are equivalent:

        # Given stanza class Foo, with plugin_multi_attrib = 'foos'
        parent['foos']
        filter(isinstance(item, Foo), parent['substanzas'])

class slixmpp.plugins.xep_0428.stanza.FallbackBody(xml=None, parent=None)
  name: ClassVar[str] = 'body'

    The XML tag name of the element, not including any namespace prefixes. For example, an `ElementBase` object for `<message />` would use `name = 'message'`.

  plugin_attrib: ClassVar[str] = 'body'

    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_0428.stanza.FallbackMixin
  get_end()
  get_start()
  interfaces = {'end', 'start'}
  name = NotImplemented
  namespace = 'urn:xmpp:fallback:0'
  plugin_attrib = NotImplemented
  set_end(v)
  set_start(v)

class slixmpp.plugins.xep_0428.stanza.FallbackSubject(xml=None, parent=None)
  name: ClassVar[str] = 'subject'

    The XML tag name of the element, not including any namespace prefixes. For example, an `ElementBase` object for `<message />` would use `name = 'message'`.

  plugin_attrib: ClassVar[str] = 'subject'

    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_0428.stanza.register_plugins()