diff options
Diffstat (limited to 'docs/11_misc.rst')
| -rw-r--r-- | docs/11_misc.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/11_misc.rst b/docs/11_misc.rst new file mode 100644 index 0000000..a85d518 --- /dev/null +++ b/docs/11_misc.rst | |||
| @@ -0,0 +1,36 @@ | |||
| 1 | Misc: Markers, reports | ||
| 2 | ====================== | ||
| 3 | .. py:module:: mastodon | ||
| 4 | .. py:class: Mastodon | ||
| 5 | |||
| 6 | Markers | ||
| 7 | ------- | ||
| 8 | These functions allow you to interact with the timeline "last read" markers, | ||
| 9 | to allow for persisting where the user was reading a timeline between sessions | ||
| 10 | and clients / devices. | ||
| 11 | |||
| 12 | |||
| 13 | Reading | ||
| 14 | ~~~~~~~ | ||
| 15 | .. automethod:: Mastodon.markers_get | ||
| 16 | |||
| 17 | Writing | ||
| 18 | ~~~~~~~ | ||
| 19 | .. automethod:: Mastodon.markers_set | ||
| 20 | |||
| 21 | Reports | ||
| 22 | ------- | ||
| 23 | |||
| 24 | Reading | ||
| 25 | ~~~~~~~ | ||
| 26 | In Mastodon versions before 2.5.0 this function allowed for the retrieval | ||
| 27 | of reports filed by the logged in user. It has since been removed. | ||
| 28 | |||
| 29 | .. automethod:: Mastodon.reports | ||
| 30 | |||
| 31 | Writing | ||
| 32 | ~~~~~~~ | ||
| 33 | This function allows you to report a user to the instance moderators as well as to | ||
| 34 | the users home instance. | ||
| 35 | |||
| 36 | .. automethod:: Mastodon.report \ No newline at end of file | ||