diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst index 4efebc6..9bbd6f7 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -329,6 +329,23 @@ Mention dicts | |||
329 | 'id': # Mentioned users (local) account ID | 329 | 'id': # Mentioned users (local) account ID |
330 | } | 330 | } |
331 | 331 | ||
332 | Conversation dicts | ||
333 | ~~~~~~~~~~~~~~~~~~ | ||
334 | .. _conversation dict: | ||
335 | |||
336 | .. code-block:: python | ||
337 | |||
338 | mastodon.conversations()[0] | ||
339 | # Returns the following dictionary: | ||
340 | { | ||
341 | 'id': # The ID of this conversation object | ||
342 | 'unread': # Boolean indicating whether this conversation has yet to be | ||
343 | # read by the user | ||
344 | 'accounts': # List of accounts (other than the logged-in account) that | ||
345 | # are part of this conversation | ||
346 | 'last_status': # The newest status in this conversation | ||
347 | } | ||
348 | |||
332 | Hashtag dicts | 349 | Hashtag dicts |
333 | ~~~~~~~~~~~~~ | 350 | ~~~~~~~~~~~~~ |
334 | .. _hashtag dict: | 351 | .. _hashtag dict: |
@@ -718,6 +735,7 @@ and local timelines. | |||
718 | .. _timeline_hashtag(): | 735 | .. _timeline_hashtag(): |
719 | .. automethod:: Mastodon.timeline_hashtag | 736 | .. automethod:: Mastodon.timeline_hashtag |
720 | .. automethod:: Mastodon.timeline_list | 737 | .. automethod:: Mastodon.timeline_list |
738 | .. automethod:: Mastodon.conversations | ||
721 | 739 | ||
722 | Reading data: Statuses | 740 | Reading data: Statuses |
723 | ---------------------- | 741 | ---------------------- |