From 0b6326e1cce9e85430fa8015f35a9c19d5d59aaf Mon Sep 17 00:00:00 2001 From: mathieui Date: Sun, 14 Feb 2021 11:45:03 +0100 Subject: XEP-0012: API changes. --- docs/api/plugins/xep_0012.rst | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) (limited to 'docs') diff --git a/docs/api/plugins/xep_0012.rst b/docs/api/plugins/xep_0012.rst index 9a12eac3..8e72ee2a 100644 --- a/docs/api/plugins/xep_0012.rst +++ b/docs/api/plugins/xep_0012.rst @@ -9,6 +9,42 @@ XEP-0012: Last Activity :exclude-members: session_bind, plugin_init, plugin_end +Internal API methods +-------------------- + +This plugin uses an in-memory storage by default to keep track of the +received and sent last activities. + +.. glossary:: + + get_last_activity + - **jid**: :class:`~.JID` of whom to retrieve the last activity + - **node**: unused + - **ifrom**: who the request is from (None = local) + - **args**: ``None`` or an :class:`~.Iq` that is requesting the + - **returns** + information. + + Get the last activity of a JID from the storage. + + set_last_activity + - **jid**: :class:`~.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**: :class:`~.JID` to delete from the storage + - **node**: unused + - **ifrom**: unused + - **args**: unused + + Remove the last activity of a JID from the storage. + + Stanza elements --------------- -- cgit v1.2.3