summaryrefslogtreecommitdiff
path: root/docs/api/plugins/xep_0319.rst
blob: 7be01cb20d54d3677a8a890dbfc2f03cdae3dea5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

XEP-0319: Last User Interaction in Presence
===========================================

.. module:: slixmpp.plugins.xep_0319

.. autoclass:: XEP_0319
    :members:
    :exclude-members: session_bind, plugin_init, plugin_end


.. _api-0319:

Internal API methods
--------------------

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

.. glossary::

    set_idle
        - **jid**: :class:`~.JID` who has been idling
        - **node**: unused
        - **ifrom**: unused
        - **args**: :class:`datetime`, timestamp of the idle start

        Set the idle start for a JID.

    get_idle
        - **jid**: :class:`~.JID` to get the idle time of
        - **node**: unused
        - **ifrom**: unused
        - **args**: : unused
        - **returns**: :class:`datetime`

        Get the idle start timestamp for a JID.


Stanza elements
---------------

.. automodule:: slixmpp.plugins.xep_0319.stanza
    :members:
    :undoc-members: