From caba9c5467fb66fb722d6ebc94190ed093fc9d6a Mon Sep 17 00:00:00 2001
From: Lorenz Diener <ldiener@uni-bremen.de>
Date: Tue, 5 Jun 2018 17:19:15 +0200
Subject: Add notif dict docs

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

(limited to 'docs')

diff --git a/docs/index.rst b/docs/index.rst
index 4d7073c..56e0756 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -546,6 +546,26 @@ Push subscription dicts
                   # if webpushes have been requested for those events.
     }
     
+Push notification dicts
+~~~~~~~~~~~~~~~~~~~~~~~
+.. _push notification dict:
+
+.. code-block:: python
+
+    mastodon.push_subscription_decrypt_push(...)
+    # Returns the following dictionary
+    {
+        'access_token': # Access token that can be used to access the API as the 
+                        # notified user
+        'body': # Text body of the notification
+        'icon': # URL to an icon for the notification
+        'notification_id': # ID that can be passed to notification() to get the full 
+                           # notification object,
+        'notification_type': # 'mention', 'reblog', 'follow' or 'favourite'
+        'preferred_locale': # The users preferred locale
+        'title': # Title for the notification
+    }
+    
 App registration and user authentication
 ----------------------------------------
 Before you can use the mastodon API, you have to register your 
-- 
cgit v1.2.3