diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst index 5fc47ac..c74f8f6 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -329,6 +329,20 @@ Instance dicts | |||
329 | 'urls': # Additional URLs dict, presently only 'streaming_api' with the stream websocket address. | 329 | 'urls': # Additional URLs dict, presently only 'streaming_api' with the stream websocket address. |
330 | } | 330 | } |
331 | 331 | ||
332 | Report dicts | ||
333 | ~~~~~~~~~~~~ | ||
334 | .. code-block:: python | ||
335 | |||
336 | mastodon.reports()[0] | ||
337 | # Returns the folowing dictionary | ||
338 | { | ||
339 | 'id': # Numerical id of the report | ||
340 | 'action_taken': # True if a moderator or admin has processed the | ||
341 | # report, False otherwise. Note that no indication as to what action was taken is given | ||
342 | # and that an admin simply marking the report as processed and not doing anything else | ||
343 | # will set this field to True. | ||
344 | } | ||
345 | |||
332 | App registration and user authentication | 346 | App registration and user authentication |
333 | ---------------------------------------- | 347 | ---------------------------------------- |
334 | Before you can use the mastodon API, you have to register your | 348 | Before you can use the mastodon API, you have to register your |