diff options
author | Lorenz Diener <[email protected]> | 2017-12-13 21:16:02 +0100 |
---|---|---|
committer | Lorenz Diener <[email protected]> | 2017-12-13 21:16:02 +0100 |
commit | b840766ed77ea0cac84ada7cb27a9b23ffda0a09 (patch) | |
tree | b273102657ee5070a9101a1f943c2b9c3b54b807 /docs | |
parent | 7cf813b9744342d0be82330cf5fb81e85fea5642 (diff) | |
download | mastodon.py-b840766ed77ea0cac84ada7cb27a9b23ffda0a09.tar.gz |
Add more list endpoints
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 26 |
1 files changed, 20 insertions, 6 deletions
diff --git a/docs/index.rst b/docs/index.rst index 0c05321..9496da6 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -287,12 +287,12 @@ Notification dicts | |||
287 | mastodon.notifications()[0] | 287 | mastodon.notifications()[0] |
288 | # Returns the following dictionary: | 288 | # Returns the following dictionary: |
289 | { | 289 | { |
290 | 'id': # id of the notification. | 290 | 'id': # id of the notification |
291 | 'type': # "mention", "reblog", "favourite" or "follow". | 291 | 'type': # "mention", "reblog", "favourite" or "follow" |
292 | 'created_at': # The time the notification was created. | 292 | 'created_at': # The time the notification was created |
293 | 'account': # User dict of the user from whom the notification originates. | 293 | 'account': # User dict of the user from whom the notification originates |
294 | 'status': # In case of "mention", the mentioning status. | 294 | 'status': # In case of "mention", the mentioning status |
295 | # In case of reblog / favourite, the reblogged / favourited status. | 295 | # In case of reblog / favourite, the reblogged / favourited status |
296 | } | 296 | } |
297 | 297 | ||
298 | Context dicts | 298 | Context dicts |
@@ -308,6 +308,19 @@ Context dicts | |||
308 | 'descendants': # A list of toot dicts | 308 | 'descendants': # A list of toot dicts |
309 | } | 309 | } |
310 | 310 | ||
311 | List dicts | ||
312 | ~~~~~~~~~~ | ||
313 | .. _list dict: | ||
314 | |||
315 | .. code-block:: python | ||
316 | |||
317 | mastodon.list(<numerical id>) | ||
318 | # Returns the following dictionary: | ||
319 | { | ||
320 | 'id': # id of the list | ||
321 | 'title': # title of the list | ||
322 | } | ||
323 | |||
311 | Media dicts | 324 | Media dicts |
312 | ~~~~~~~~~~~ | 325 | ~~~~~~~~~~~ |
313 | .. _media dict: | 326 | .. _media dict: |
@@ -468,6 +481,7 @@ user could see, as well as hashtag timelines and the public timeline. | |||
468 | .. automethod:: Mastodon.timeline_public | 481 | .. automethod:: Mastodon.timeline_public |
469 | .. _timeline_hashtag(): | 482 | .. _timeline_hashtag(): |
470 | .. automethod:: Mastodon.timeline_hashtag | 483 | .. automethod:: Mastodon.timeline_hashtag |
484 | .. automethod:: Mastodon.timeline_list | ||
471 | 485 | ||
472 | Reading data: Statuses | 486 | Reading data: Statuses |
473 | ---------------------- | 487 | ---------------------- |