Skip to content
Back to top
View this page

# XEP-0469: Bookmark Pinning

class slixmpp.plugins.xep_0469.XEP_0469(xmpp, config=None)

  XEP-0469: Bookmark Pinning

  dependencies: ClassVar[Set[str]] = {'xep_0402'}

    Some plugins may depend on others in order to function properly. Any plugin names included in `dependencies` will be initialized as needed if this plugin is enabled.

  description: str = 'XEP-0469: Bookmark Pinning'

    A longer name for the plugin, describing its purpose. For example, a plugin for XEP-0030 would use ‘Service Discovery’ as its description value.

  name: str = 'xep_0469'

    A short name for the plugin based on the implemented specification. For example, a plugin for XEP-0030 would use ‘xep_0030’.

## Stanza elements

class slixmpp.plugins.xep_0469.stanza.Pinned(xml=None, parent=None)

  Pinned bookmark element

  To enable it on a Conference element, use enable() like this:

  Which will add the <pinned> element to the <extensions> element.

  bool_interfaces: ClassVar[Set[str]] = {'pinned'}

    A subset of `interfaces` which maps the presence of subelements to boolean values. Using this set allows for quickly checking for the existence of empty subelements like `<required />`.

    Added in version 1.1.

  interfaces: ClassVar[Set[str]] = {'pinned'}

    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.

  is_extension: ClassVar[bool] = True

    If you need to add a new interface to an existing stanza, you can create a plugin and set `is_extension = True`. Be sure to set the `plugin_attrib` value to the desired interface name, and that it is the only interface listed in `interfaces`. Requests for the new interface from the parent stanza will be passed to the plugin directly.

    Added in version 1.0-Beta5.

  name: ClassVar[str] = 'pinned'

    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:bookmarks-pinning: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] = 'pinned'

    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_0469.stanza.register_plugin()