diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/index.rst | 35 |
1 files changed, 33 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst index ef94b2a..1e64927 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
@@ -773,6 +773,20 @@ Featured tag dicts | |||
773 | # (can be None if there are none) | 773 | # (can be None if there are none) |
774 | } | 774 | } |
775 | 775 | ||
776 | Read marker dicts | ||
777 | ~~~~~~~~~~~~~~~~~ | ||
778 | .. _read marker dict: | ||
779 | |||
780 | .. code-block:: python | ||
781 | |||
782 | mastodon.markers_get()["home"] | ||
783 | # Returns the following dictionary: | ||
784 | { | ||
785 | 'last_read_id': # ID of the last read object in the timeline | ||
786 | 'version': # A counter that is incremented whenever the marker is set to a new status | ||
787 | 'updated_at': # The time the marker was last set, as a datetime object | ||
788 | } | ||
789 | |||
776 | Admin account dicts | 790 | Admin account dicts |
777 | ~~~~~~~~~~~~~~~~~~~ | 791 | ~~~~~~~~~~~~~~~~~~~ |
778 | .. _admin account dict: | 792 | .. _admin account dict: |
@@ -990,11 +1004,20 @@ muted or blocked by the logged in user. | |||
990 | .. automethod:: Mastodon.mutes | 1004 | .. automethod:: Mastodon.mutes |
991 | .. automethod:: Mastodon.blocks | 1005 | .. automethod:: Mastodon.blocks |
992 | 1006 | ||
993 | Reading data: Reports (REMOVED IN 2.5.0) | 1007 | Reading data: Reports |
994 | ---------------------------------------- | 1008 | --------------------- |
1009 | In Mastodon versions before 2.5.0 this function allowed for the retrieval | ||
1010 | of reports filed by the logged in user. It has since been removed. | ||
995 | 1011 | ||
996 | .. automethod:: Mastodon.reports | 1012 | .. automethod:: Mastodon.reports |
997 | 1013 | ||
1014 | |||
1015 | Writing data: Last-read markers | ||
1016 | -------------------------- | ||
1017 | This function allows you to set get last read position for timelines. | ||
1018 | |||
1019 | .. automethod:: Mastodon.markers_get | ||
1020 | |||
998 | Reading data: Domain blocks | 1021 | Reading data: Domain blocks |
999 | --------------------------- | 1022 | --------------------------- |
1000 | 1023 | ||
@@ -1142,6 +1165,14 @@ Writing data: Reports | |||
1142 | 1165 | ||
1143 | .. automethod:: Mastodon.report | 1166 | .. automethod:: Mastodon.report |
1144 | 1167 | ||
1168 | Writing data: Last-read markers | ||
1169 | -------------------------- | ||
1170 | This function allows you to set the last read position for timelines to | ||
1171 | allow for persisting where the user was reading a timeline between sessions | ||
1172 | and clients / devices. | ||
1173 | |||
1174 | .. automethod:: Mastodon.markers_set | ||
1175 | |||
1145 | Writing data: Domain blocks | 1176 | Writing data: Domain blocks |
1146 | --------------------------- | 1177 | --------------------------- |
1147 | These functions allow you to block and unblock all statuses from a domain | 1178 | These functions allow you to block and unblock all statuses from a domain |