diff options
Diffstat (limited to 'mastodon/favourites.py')
| -rw-r--r-- | mastodon/favourites.py | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/mastodon/favourites.py b/mastodon/favourites.py new file mode 100644 index 0000000..9d86424 --- /dev/null +++ b/mastodon/favourites.py | |||
| @@ -0,0 +1,52 @@ | |||
| 1 | # favourites.py - favourites and also bookmarks | ||
| 2 | |||
| 3 | from .versions import _DICT_VERSION_STATUS | ||
| 4 | from .utility import api_version | ||
| 5 | |||
| 6 | from .internals import Mastodon as Internals | ||
| 7 | |||
| 8 | class Mastodon(Internals): | ||
| 9 | ### | ||
| 10 | # Reading data: Favourites | ||
| 11 | ### | ||
| 12 | @api_version("1.0.0", "2.6.0", _DICT_VERSION_STATUS) | ||
| 13 | def favourites(self, max_id=None, min_id=None, since_id=None, limit=None): | ||
| 14 | """ | ||
| 15 | Fetch the logged-in user's favourited statuses. | ||
| 16 | |||
| 17 | Returns a list of :ref:`status dicts <status dicts>`. | ||
| 18 | """ | ||
| 19 | if max_id is not None: | ||
| 20 | max_id = self.__unpack_id(max_id, dateconv=True) | ||
| 21 | |||
| 22 | if min_id is not None: | ||
| 23 | min_id = self.__unpack_id(min_id, dateconv=True) | ||
| 24 | |||
| 25 | if since_id is not None: | ||
| 26 | since_id = self.__unpack_id(since_id, dateconv=True) | ||
| 27 | |||
| 28 | params = self.__generate_params(locals()) | ||
| 29 | return self.__api_request('GET', '/api/v1/favourites', params) | ||
| 30 | |||
| 31 | ### | ||
| 32 | # Reading data: Bookmarks | ||
| 33 | ### | ||
| 34 | @api_version("3.1.0", "3.1.0", _DICT_VERSION_STATUS) | ||
| 35 | def bookmarks(self, max_id=None, min_id=None, since_id=None, limit=None): | ||
| 36 | """ | ||
| 37 | Get a list of statuses bookmarked by the logged-in user. | ||
| 38 | |||
| 39 | Returns a list of :ref:`status dicts <status dicts>`. | ||
| 40 | """ | ||
| 41 | if max_id is not None: | ||
| 42 | max_id = self.__unpack_id(max_id, dateconv=True) | ||
| 43 | |||
| 44 | if min_id is not None: | ||
| 45 | min_id = self.__unpack_id(min_id, dateconv=True) | ||
| 46 | |||
| 47 | if since_id is not None: | ||
| 48 | since_id = self.__unpack_id(since_id, dateconv=True) | ||
| 49 | |||
| 50 | params = self.__generate_params(locals()) | ||
| 51 | return self.__api_request('GET', '/api/v1/bookmarks', params) | ||
| 52 | \ No newline at end of file | ||