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.

Changed in version 1.8.0: This function now returns a Future.

Return type

Future

end_idle(jid=None)[source]#

Remove the last activity of a JID.

Changed in version 1.8.0: This function now returns a Future.

Return type

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

set_last_activity(jid=None, seconds=None, status=None)[source]#

Set last activity for a JID.

Changed in version 1.8.0: This function now returns a Future.

Return type

Future

start_uptime(status=None)[source]#

Changed in version 1.8.0: This function now returns a Future.

Return type

Future

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 activity

  • node: unused

  • ifrom: who the request is from (None = local)

  • args: None or an Iq that is requesting the

  • returns information.

Get the last activity of a JID from the storage.

set_last_activity#
  • jid: JID of whom to set the last activity

  • node: 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 storage

  • node: 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]#
del_status()[source]#
get_seconds()[source]#
get_status()[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.

iterables: List[ElementBase]#

A list of child stanzas whose class is included in plugin_iterables.

loaded_plugins: Set[str]#
name: ClassVar[str] = 'query'#

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 = 'jabber:iq:last'#

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.

parent: Optional[ReferenceType[ElementBase]]#

A weakref.weakref to the parent stanza, if there is one. If not, then parent is None.

plugin_attrib: ClassVar[str] = 'last_activity'#

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']
plugins: Dict[Tuple[str, Optional[str]], ElementBase]#

An ordered dictionary of plugin stanzas, mapped by their plugin_attrib value.

set_seconds(value)[source]#
set_status(value)[source]#
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.