XEP-0444: Message Reactions¶
- class slixmpp.plugins.xep_0444.XEP_0444(xmpp, config=None)[source]¶
XEP-0444: Message Reactions.
If the python-emoji library is present, setting emojis as reactions will be checked against known emoji, and trying to set non-emoji characters as reactions will raise a
ValueError
. This behavior can be disabled by passingall_chars=True
to theReaction.set_value()
call.- dependencies: ClassVar[Set[str]] = {'xep_0030', 'xep_0334'}¶
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-0444: Message Reactions'¶
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_0444'¶
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_0444.stanza.Reaction(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'value'}¶
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] = 'reaction'¶
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:reactions:0'¶
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.
- class slixmpp.plugins.xep_0444.stanza.Reactions(xml=None, parent=None)[source]¶
-
- interfaces: ClassVar[Set[str]] = {'id', 'values'}¶
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] = 'reactions'¶
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:reactions:0'¶
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.
- plugin_attrib: ClassVar[str] = 'reactions'¶
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']