From 06df1c281eb0825ec9f646960f4d9426eba7e081 Mon Sep 17 00:00:00 2001
From: Lorenz Diener <lorenzd@gmail.com>
Date: Sun, 28 Apr 2019 13:47:43 +0200
Subject: Add conversation fetching

---
 docs/index.rst | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'docs')

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
         'id': # Mentioned users (local) account ID
     }
     
+Conversation dicts
+~~~~~~~~~~~~~~~~~~
+.. _conversation dict:
+
+.. code-block:: python
+    
+    mastodon.conversations()[0]
+    # Returns the following dictionary:
+    {
+        'id': # The ID of this conversation object
+        'unread': # Boolean indicating whether this conversation has yet to be 
+                  # read by the user
+        'accounts': # List of accounts (other than the logged-in account) that 
+                    # are part of this conversation
+        'last_status': # The newest status in this conversation 
+    }
+    
 Hashtag dicts
 ~~~~~~~~~~~~~
 .. _hashtag dict:
@@ -718,6 +735,7 @@ and local timelines.
 .. _timeline_hashtag():
 .. automethod:: Mastodon.timeline_hashtag
 .. automethod:: Mastodon.timeline_list
+.. automethod:: Mastodon.conversations
 
 Reading data: Statuses
 ----------------------
-- 
cgit v1.2.3