diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 38 |
1 files changed, 37 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index 3871972..6279d48 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -99,6 +99,7 @@ User dicts | |||
99 | 'header': URL for their header image | 99 | 'header': URL for their header image |
100 | 'id': Same as <numerical id> | 100 | 'id': Same as <numerical id> |
101 | 'username': The username (what you @ them with) | 101 | 'username': The username (what you @ them with) |
102 | 'locked': Denotes whether the account can be followed without a follow request | ||
102 | } | 103 | } |
103 | 104 | ||
104 | Toot dicts | 105 | Toot dicts |
@@ -108,7 +109,7 @@ Toot dicts | |||
108 | mastodon.toot("Hello from Python") | 109 | mastodon.toot("Hello from Python") |
109 | # Returns the following dictionary: | 110 | # Returns the following dictionary: |
110 | { | 111 | { |
111 | 'sensitive': Denotes whether the toot is marked sensitive | 112 | 'sensitive': Denotes whether media attachments to the toot are marked sensitive |
112 | 'created_at': Creation time | 113 | 'created_at': Creation time |
113 | 'mentions': A list of account dicts mentioned in the toot | 114 | 'mentions': A list of account dicts mentioned in the toot |
114 | 'uri': Descriptor for the toot | 115 | 'uri': Descriptor for the toot |
@@ -123,6 +124,7 @@ Toot dicts | |||
123 | 'reblog': Denotes whether the toot is a reblog | 124 | 'reblog': Denotes whether the toot is a reblog |
124 | 'url': URL of the toot | 125 | 'url': URL of the toot |
125 | 'content': Content of the toot, as HTML: '<p>Hello from Python</p>' | 126 | 'content': Content of the toot, as HTML: '<p>Hello from Python</p>' |
127 | 'spoiler_text': Warning text that should be displayed before the toot content | ||
126 | 'favourited': Denotes whether the logged in user has favourited this toot | 128 | 'favourited': Denotes whether the logged in user has favourited this toot |
127 | 'account': Account dict for the logged in account | 129 | 'account': Account dict for the logged in account |
128 | } | 130 | } |
@@ -138,6 +140,8 @@ Relationship dicts | |||
138 | 'following': Boolean denoting whether you follow them | 140 | 'following': Boolean denoting whether you follow them |
139 | 'id': Numerical id (same one as <numerical id>) | 141 | 'id': Numerical id (same one as <numerical id>) |
140 | 'blocking': Boolean denoting whether you are blocking them | 142 | 'blocking': Boolean denoting whether you are blocking them |
143 | 'muting': Boolean denoting whether you are muting them | ||
144 | 'requested': Boolean denoting whether you have sent them a follow request | ||
141 | } | 145 | } |
142 | 146 | ||
143 | Notification dicts | 147 | Notification dicts |
@@ -205,6 +209,7 @@ user could see, as well as hashtag timelines and the public timeline. | |||
205 | .. automethod:: Mastodon.timeline | 209 | .. automethod:: Mastodon.timeline |
206 | .. automethod:: Mastodon.timeline_home | 210 | .. automethod:: Mastodon.timeline_home |
207 | .. automethod:: Mastodon.timeline_mentions | 211 | .. automethod:: Mastodon.timeline_mentions |
212 | .. automethod:: Mastodon.timeline_local | ||
208 | .. automethod:: Mastodon.timeline_public | 213 | .. automethod:: Mastodon.timeline_public |
209 | .. automethod:: Mastodon.timeline_hashtag | 214 | .. automethod:: Mastodon.timeline_hashtag |
210 | 215 | ||
@@ -236,6 +241,28 @@ their relationships. | |||
236 | .. automethod:: Mastodon.account_relationships | 241 | .. automethod:: Mastodon.account_relationships |
237 | .. automethod:: Mastodon.account_search | 242 | .. automethod:: Mastodon.account_search |
238 | 243 | ||
244 | Reading data: Mutes and blocks | ||
245 | ------------------------------ | ||
246 | These functions allow you to get information about accounts that are | ||
247 | muted or blocked by the logged in user. | ||
248 | |||
249 | .. automethod:: Mastodon.mutes | ||
250 | .. automethod:: Mastodon.blocks | ||
251 | |||
252 | Reading data: Favourites | ||
253 | ------------------------ | ||
254 | This function allows you to get information about statuses favourited | ||
255 | by the authenticated user. | ||
256 | |||
257 | .. authomethod:: Mastodon.favourites | ||
258 | |||
259 | Reading data: Follow requests | ||
260 | ----------------------------- | ||
261 | This function allows you to get a list of pending incoming follow | ||
262 | requests for the authenticated user. | ||
263 | |||
264 | .. automethod:: Mastodon.follow_requests | ||
265 | |||
239 | Writing data: Statuses | 266 | Writing data: Statuses |
240 | ---------------------- | 267 | ---------------------- |
241 | These functions allow you to post statuses to Mastodon and to | 268 | These functions allow you to post statuses to Mastodon and to |
@@ -258,6 +285,15 @@ These functions allow you to interact with other accounts: To (un)follow and | |||
258 | .. automethod:: Mastodon.account_unfollow | 285 | .. automethod:: Mastodon.account_unfollow |
259 | .. automethod:: Mastodon.account_block | 286 | .. automethod:: Mastodon.account_block |
260 | .. automethod:: Mastodon.account_unblock | 287 | .. automethod:: Mastodon.account_unblock |
288 | .. automethod:: Mastodon.account_mute | ||
289 | .. automethod:: Mastodon.account_unmute | ||
290 | |||
291 | Writing data: Follow requests | ||
292 | ----------------------------- | ||
293 | These functions allow you to accept or reject incoming follow requests. | ||
294 | |||
295 | .. automethod:: Mastodon.follow_request_authorize | ||
296 | .. automethod:: Mastodon.follow_request_reject | ||
261 | 297 | ||
262 | Writing data: Media | 298 | Writing data: Media |
263 | ------------------- | 299 | ------------------- |