XEP-0012: Last Activity#
- class slixmpp.plugins.xep_0012.XEP_0012(xmpp, config=None)[source]#
XEP-0012 Last Activity
- begin_idle(jid=None, status=None)[source]#
Reset the last activity for the given JID.
Changed in version 1.8.0: This function now returns a Future.
- Parameters:
status (
Optional
[str
]) – Optional status.- Return type:
Future
- del_last_activity(jid)[source]#
Remove the last activity of a JID. :rtype:
Future
Changed in version 1.8.0: This function now returns a Future.
- dependencies: ClassVar[Set[str]] = {'xep_0030'}#
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-0012: Last Activity'#
A longer name for the plugin, describing its purpose. For example, a plugin for XEP-0030 would use ‘Service Discovery’ as its description value.
- end_idle(jid=None)[source]#
Remove the last activity of a JID. :rtype:
Future
Changed in version 1.8.0: This function now returns a Future.
- get_last_activity(jid, local=False, ifrom=None, **iqkwargs)[source]#
Get last activity for a specific JID.
- Parameters:
local (
bool
) – Fetch the value from the local cache.- Return type:
Future
- name: str = 'xep_0012'#
A short name for the plugin based on the implemented specification. For example, a plugin for XEP-0030 would use ‘xep_0030’.
Internal API methods#
This plugin uses an in-memory storage by default to keep track of the received and sent last activities.
- get_last_activity#
jid:
JID
of whom to retrieve the last activitynode: unused
ifrom: who the request is from (None = local)
args:
None
or anIq
that is requesting thereturns information.
Get the last activity of a JID from the storage.
- set_last_activity#
jid:
JID
of whom to set the last activitynode: unused
ifrom: unused
args: A dict containing
'seconds'
and'status'
{'seconds': Optional[int], 'status': Optional[str]}
Set the last activity of a JID in the storage.
- del_last_activity#
jid:
JID
to delete from the storagenode: unused
ifrom: unused
args: unused
Remove the last activity of a JID from the storage.
Stanza elements#
- class slixmpp.plugins.xep_0012.stanza.LastActivity(xml=None, parent=None)[source]#
-
- interfaces: ClassVar[Set[str]] = {'seconds', 'status'}#
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] = 'query'#
The XML tag name of the element, not including any namespace prefixes. For example, an
ElementBase
object for<message />
would usename = 'message'
.
- namespace: str = 'jabber:iq:last'#
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] = 'last_activity'#
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']