Skip to content
Back to top
View this page

# XEP-0449: Stickers

XEP-0449 on xmpp.org

class slixmpp.plugins.xep_0449.XEP_0449(xmpp, config=None)

  XEP-0449: Stickers

  Raises an event on incoming stickers. Nothing related to sticker packs is supported (yet).

  stanza = <module 'slixmpp.plugins.xep_0449.stanza' from '/build/slixmpp-QRhfpR/slixmpp-1.17.0/slixmpp/plugins/xep_0449/stanza.py'>

## Stanza elements

Stanza interfaces for XEP-0449: Stickers

Basic usage:

    >>> register()  # automatically done if you use this plugin
    >>> msg = Message()
    >>> msg["sticker"]["pack"] = "some-pack-id"
    >>> msg.pretty_print()
    <message xmlns="jabber:client">
      <sticker xmlns="urn:xmpp:stickers:0" pack="some-pack-id" />
    </message>

You are supposed to also add a Stateless File Sharing payload if you do that.

class slixmpp.plugins.xep_0449.stanza.Sticker(xml=None, parent=None)
  get_jid()
    Return type:

      `JID` | `None`

  interfaces: ClassVar[set[str]] = {'jid', 'node', 'pack'}

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

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

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

  set_jid(jid)
    Return type:

      `None`

slixmpp.plugins.xep_0449.stanza.register()
  Return type:

    `None`