summaryrefslogtreecommitdiff
path: root/slixmpp/plugins/xep_0108/user_activity.py
diff options
context:
space:
mode:
authorLink Mauve <linkmauve@linkmauve.fr>2020-12-10 19:45:30 +0100
committerLink Mauve <linkmauve@linkmauve.fr>2020-12-10 19:45:30 +0100
commit1e2d15b8f58249b31dd5882772d58add1369fc37 (patch)
tree6d39e5fc8241884acf30b209a07ef4cabd80c323 /slixmpp/plugins/xep_0108/user_activity.py
parentd37182804102682a715df43c48a6d874835cd71a (diff)
parent155fc58a22d631746436a81119a94c80d6ea2d2b (diff)
downloadslixmpp-1e2d15b8f58249b31dd5882772d58add1369fc37.tar.gz
slixmpp-1e2d15b8f58249b31dd5882772d58add1369fc37.tar.bz2
slixmpp-1e2d15b8f58249b31dd5882772d58add1369fc37.tar.xz
slixmpp-1e2d15b8f58249b31dd5882772d58add1369fc37.zip
Merge branch 'docs-event-sphinx-plugins' into 'master'
Docs: add more events, add plugins to the doc See merge request poezio/slixmpp!84
Diffstat (limited to 'slixmpp/plugins/xep_0108/user_activity.py')
-rw-r--r--slixmpp/plugins/xep_0108/user_activity.py27
1 files changed, 6 insertions, 21 deletions
diff --git a/slixmpp/plugins/xep_0108/user_activity.py b/slixmpp/plugins/xep_0108/user_activity.py
index d66ed9c4..089269bd 100644
--- a/slixmpp/plugins/xep_0108/user_activity.py
+++ b/slixmpp/plugins/xep_0108/user_activity.py
@@ -39,19 +39,12 @@ class XEP_0108(BasePlugin):
"""
Publish the user's current activity.
- Arguments:
- general -- The required general category of the activity.
- specific -- Optional specific activity being done as part
- of the general category.
- text -- Optional natural-language description or reason
- for the activity.
- options -- Optional form of publish options.
- ifrom -- Specify the sender's JID.
- timeout -- The length of time (in seconds) to wait for a response
- before exiting the send call if blocking is used.
- Defaults to slixmpp.xmlstream.RESPONSE_TIMEOUT
- callback -- Optional reference to a stream handler function. Will
- be executed when a reply stanza is received.
+ :param general: The required general category of the activity.
+ :param specific: Optional specific activity being done as part
+ of the general category.
+ :param text: Optional natural-language description or reason
+ for the activity.
+ :param options: Optional form of publish options.
"""
activity = UserActivity()
activity['value'] = (general, specific)
@@ -66,14 +59,6 @@ class XEP_0108(BasePlugin):
timeout_callback=None):
"""
Clear existing user activity information to stop notifications.
-
- Arguments:
- ifrom -- Specify the sender's JID.
- timeout -- The length of time (in seconds) to wait for a response
- before exiting the send call if blocking is used.
- Defaults to slixmpp.xmlstream.RESPONSE_TIMEOUT
- callback -- Optional reference to a stream handler function. Will
- be executed when a reply stanza is received.
"""
activity = UserActivity()
self.xmpp['xep_0163'].publish(activity, node=UserActivity.namespace,