From 2fed9f9ad26bc90b18cdcde28ca18a0c17c9ce55 Mon Sep 17 00:00:00 2001
From: mathieui <mathieui@mathieui.net>
Date: Sun, 14 Feb 2021 12:03:14 +0100
Subject: XEP-0319: API changes

- ``idle`` and ``active`` are now coroutines.
---
 docs/api/plugins/xep_0319.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'docs/api')

diff --git a/docs/api/plugins/xep_0319.rst b/docs/api/plugins/xep_0319.rst
index a3ab9d28..c89cea6f 100644
--- a/docs/api/plugins/xep_0319.rst
+++ b/docs/api/plugins/xep_0319.rst
@@ -8,6 +8,30 @@ XEP-0319: Last User Interaction in Presence
     :members:
     :exclude-members: session_bind, plugin_init, plugin_end
 
+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
 ---------------
-- 
cgit v1.2.3