XEP-0356: Privileged Entity¶
- class slixmpp.plugins.xep_0356.XEP_0356(xmpp, config=None)[source]¶
XEP-0356: Privileged Entity
Events:
privileges_advertised -- Received message/privilege from the server
- async get_roster(jid, **send_kwargs)[source]¶
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
- async set_roster(jid, roster_items, **send_kwargs)[source]¶
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 itemsroster_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”, “subscription”: “from”, “groups”: [“group3”],
},
}
- Return type
Stanza elements¶
- class slixmpp.plugins.xep_0356.stanza.Perm(xml=None, parent=None)[source]¶
- 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.
- iterables: List[ElementBase]¶
A list of child stanzas whose class is included in
plugin_iterables
.
- loaded_plugins: Set[str]¶
- name: ClassVar[str] = 'perm'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'urn:xmpp:privilege:1'¶
The XML namespace for the element. Given
<foo xmlns="bar" />
, thennamespace = "bar"
should be used. The default namespace isjabber:client
since this is being used in an XMPP library.
- parent: Optional[ReferenceType[ElementBase]]¶
A
weakref.weakref
to the parent stanza, if there is one. If not, thenparent
isNone
.
- plugin_attrib: ClassVar[str] = 'perm'¶
For
ElementBase
subclasses which are intended to be used as plugins, theplugin_attrib
value defines the plugin name. Plugins may be accessed by using theplugin_attrib
value as the interface. An example usingplugin_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, theplugin_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'])
- plugins: Dict[Tuple[str, Optional[str]], ElementBase]¶
An ordered dictionary of plugin stanzas, mapped by their
plugin_attrib
value.
- tag: str¶
The name of the tag for the stanza’s root element. It is the same as calling
tag_name()
and is formatted as'{namespace}elementname'
.
- xml: ET.Element¶
The underlying XML object for the stanza. It is a standard
xml.etree.ElementTree
object.
- class slixmpp.plugins.xep_0356.stanza.Privilege(xml=None, parent=None)[source]¶
-
- iterables: List[ElementBase]¶
A list of child stanzas whose class is included in
plugin_iterables
.
- loaded_plugins: Set[str]¶
- name: ClassVar[str] = 'privilege'¶
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'urn:xmpp:privilege:1'¶
The XML namespace for the element. Given
<foo xmlns="bar" />
, thennamespace = "bar"
should be used. The default namespace isjabber:client
since this is being used in an XMPP library.
- parent: Optional[ReferenceType[ElementBase]]¶
A
weakref.weakref
to the parent stanza, if there is one. If not, thenparent
isNone
.
- plugin_attrib: ClassVar[str] = 'privilege'¶
For
ElementBase
subclasses which are intended to be used as plugins, theplugin_attrib
value defines the plugin name. Plugins may be accessed by using theplugin_attrib
value as the interface. An example usingplugin_attrib = 'foo'
:register_stanza_plugin(Message, FooPlugin) msg = Message() msg['foo']['an_interface_from_the_foo_plugin']
- plugins: Dict[Tuple[str, Optional[str]], ElementBase]¶
An ordered dictionary of plugin stanzas, mapped by their
plugin_attrib
value.
- tag: str¶
The name of the tag for the stanza’s root element. It is the same as calling
tag_name()
and is formatted as'{namespace}elementname'
.
- xml: ET.Element¶
The underlying XML object for the stanza. It is a standard
xml.etree.ElementTree
object.