Skip to content
Back to top
View this page

# XEP-0319: Last User Interaction in Presence

class slixmpp.plugins.xep_0319.XEP_0319(xmpp, config=None)
  async active(jid=None)

    Reset the idle timer.

    Changed in version 1.8.0: This function is now a coroutine.

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

    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-0319: Last User Interaction in Presence'

    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 idle(jid=None, since=None)

    Set an idle duration for a JID

    Changed in version 1.8.0: This function is now a coroutine.

  name: str = 'xep_0319'

    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

The default API manages an in-memory cache of idle periods.

set_idle

  - jid: `JID` who has been idling

  - node: unused

  - ifrom: unused

  - args: `datetime`, timestamp of the idle start

  Set the idle start for a JID.

get_idle

  - jid: `JID` to get the idle time of

  - node: unused

  - ifrom: unused

  - args: : unused

  - returns: `datetime`

  Get the idle start timestamp for a JID.

## Stanza elements

class slixmpp.plugins.xep_0319.stanza.Idle(xml=None, parent=None)
  get_since()
  interfaces: ClassVar[Set[str]] = {'since'}

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

    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:idle:1'

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

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

  set_since(value)