From e220e7cc60839ee1e3b27781b3b1cb609e593f85 Mon Sep 17 00:00:00 2001 From: Lorenz Diener Date: Fri, 24 Nov 2017 15:08:34 +0100 Subject: Many fixes for streaming stuff --- docs/index.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/index.rst b/docs/index.rst index 162d06c..63a8594 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,7 +37,7 @@ Mastodon.py ) mastodon.toot('Tooting from python using #mastodonpy !') -`Mastodon`_ is an ostatus based twitter-like federated social +`Mastodon`_ is an ActivityPub and OStatus based twitter-like federated social network node. It has an API that allows you to interact with its every aspect. This is a simple python wrapper for that api, provided as a single python module. By default, it talks to the @@ -531,11 +531,18 @@ Streaming --------- These functions allow access to the streaming API. +If async is False, these methods block forever (or until an +exception is raised). + +If async is True, the listener will listen on another thread and these methods +will return a handle corresponding to the open connection. The +connection may be closed at any time by calling its close() method. + .. automethod:: Mastodon.user_stream .. automethod:: Mastodon.public_stream +.. automethod:: Mastodon.local_stream .. automethod:: Mastodon.hashtag_stream - .. _Mastodon: https://github.com/tootsuite/mastodon .. _Mastodon flagship instance: http://mastodon.social/ .. _Mastodon api docs: https://github.com/tootsuite/documentation/ -- cgit v1.2.3