diff options
| author | mathieui <mathieui@mathieui.net> | 2021-02-27 13:16:18 +0100 |
|---|---|---|
| committer | mathieui <mathieui@mathieui.net> | 2021-02-27 13:16:18 +0100 |
| commit | 059cb290d8ae567ef189d83c45a1e38b1f3ab9dc (patch) | |
| tree | b8a85ab9a91bf7663701a077607a67a07fcc485a /docs/api/plugins/xep_0319.rst | |
| parent | 5f9ab45a5e161c3035a844184736b3180dae6047 (diff) | |
| parent | 3cdec464a550b775d8c251f37b863a6e2212c5d5 (diff) | |
| download | slixmpp-059cb290d8ae567ef189d83c45a1e38b1f3ab9dc.tar.gz slixmpp-059cb290d8ae567ef189d83c45a1e38b1f3ab9dc.tar.bz2 slixmpp-059cb290d8ae567ef189d83c45a1e38b1f3ab9dc.tar.xz slixmpp-059cb290d8ae567ef189d83c45a1e38b1f3ab9dc.zip | |
Merge branch 'async-interal-api-break-everything' into 'master'
Make the internal "api" async
See merge request poezio/slixmpp!128
Diffstat (limited to 'docs/api/plugins/xep_0319.rst')
| -rw-r--r-- | docs/api/plugins/xep_0319.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/api/plugins/xep_0319.rst b/docs/api/plugins/xep_0319.rst index a3ab9d28..7be01cb2 100644 --- a/docs/api/plugins/xep_0319.rst +++ b/docs/api/plugins/xep_0319.rst @@ -9,6 +9,33 @@ XEP-0319: Last User Interaction in Presence :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 --------------- |