XEP-0356: Privileged Entity

class slixmpp.plugins.xep_0356.XEP_0356(xmpp, config=None)

XEP-0356: Privileged Entity

Events:

privileges_advertised  -- Received message/privilege from the server

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

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-0356: Privileged Entity'

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

async get_roster(jid, **send_kwargs)

Return the roster of user on the server the component has privileged access to.

Raises ValueError if the server did not advertise the corresponding privileges

Parameters:

jid (Union[JID, str]) – user we want to fetch the roster from

Return type:

Iq

name: str = 'xep_0356'

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

async send_privileged_iq(encapsulated_iq, iq_id=None)

Send an IQ on behalf of a user

Caution: the IQ must have the jabber:client namespace

async set_roster(jid, roster_items, **send_kwargs)

Return the roster of user on the server the component has privileged access to.

Raises ValueError if the server did not advertise the corresponding privileges

Parameters:

• jid (Union[JID, str]) – user we want to add or modify roster items

• roster_items (dict) –

  a dict containing the roster items’ JIDs as keys and nested dicts containing names, subscriptions and groups. Example: {

  ”friend1@example.com”: {

  “name”: “Friend 1”, “subscription”: “both”, “groups”: [“group1”, “group2”],

  }, “friend2@example.com”: {

  ”name”: “Friend 2”,

Return type:

Iq

”subscription”: “from”, “groups”: [“group3”],

},

}

Stanza elements

class slixmpp.plugins.xep_0356.stanza.NameSpace(xml=None, parent=None)

interfaces: ClassVar[Set[str]] = {'ns', 'type'}

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

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:privilege:2'

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

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

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_0356.stanza.Perm(xml=None, parent=None)

interfaces: ClassVar[Set[str]] = {'access', 'type'}

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

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:privilege:2'

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

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

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_0356.stanza.Privilege(xml=None, parent=None)

add_perm(access, type_)

message()

name: ClassVar[str] = 'privilege'

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:privilege:2'

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.

permission(access)

plugin_attrib: ClassVar[str] = 'privilege'

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

presence()

roster()

class slixmpp.plugins.xep_0356.stanza.PrivilegedIq(xml=None, parent=None)

name: ClassVar[str] = 'privileged_iq'

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:privilege:2'

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

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_0356.stanza.register()