diff options
author | Lorenz Diener <[email protected]> | 2019-06-22 21:56:08 +0200 |
---|---|---|
committer | Lorenz Diener <[email protected]> | 2019-06-22 21:56:08 +0200 |
commit | 75b7fc7779a3ae23e89129b3ae455c1479245e2f (patch) | |
tree | b01ea64bdf74e2c8ecb9a5e8f0948600517fcf62 /docs | |
parent | 9e6745ef8a7463675f914b0ab6cf89ef5f6eb0dd (diff) | |
download | mastodon.py-75b7fc7779a3ae23e89129b3ae455c1479245e2f.tar.gz |
Document new report dict fields
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/index.rst b/docs/index.rst index f4de1b8..4e98a3a 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -673,17 +673,23 @@ Report dicts | |||
673 | 673 | ||
674 | .. code-block:: python | 674 | .. code-block:: python |
675 | 675 | ||
676 | mastodon.reports()[0] | 676 | mastodon.admin_reports()[0] |
677 | # Returns the following dictionary | 677 | # Returns the following dictionary |
678 | { | 678 | { |
679 | 'id': # Numerical id of the report | 679 | 'id': # Numerical id of the report |
680 | 'action_taken': # True if a moderator or admin has processed the | 680 | 'action_taken': # True if a moderator or admin has processed the |
681 | # report, False otherwise. Note that no indication as to | 681 | # report, False otherwise. |
682 | # what action was taken is given and that an admin simply | 682 | |
683 | # marking the report as processed and not doing anything else | 683 | # The following fields are only present in the report dicts returned by moderation API: |
684 | # will set this field to True. Note also that now that there | 684 | 'comment': # Text comment submitted with the report |
685 | # is no way to get any updated report lists, this will | 685 | 'created_at': # Time at which this report was created, as a datetime object |
686 | # always be false. | 686 | 'updated_at': # Last time this report has been updated, as a datetime object |
687 | 'account': # Account dict of the user that filed this report | ||
688 | 'target_account': # Account that has been reported with this report | ||
689 | 'assigned_account': # If the report as been assigned to an account, | ||
690 | # account dict of that account (None if not) | ||
691 | 'action_taken_by_account': # Account dict of the account that processed this report | ||
692 | 'statuses': # List of statuses attached to the report, as toot dicts | ||
687 | } | 693 | } |
688 | 694 | ||
689 | Push subscription dicts | 695 | Push subscription dicts |