Implementing TTRSS: Get Feed List #80

Closed
opened 7 years ago by jking · 0 comments
jking commented 7 years ago
Owner

getFeeds

Returns JSON-encoded list of feeds. The list includes category id,
title, feed url, etc.

Parameters:

  • cat_id (integer) - return feeds under category cat_id
  • unread_only (bool) - only return feeds which have unread articles
  • limit (integer) - limit amount of feeds returned to this value
  • offset (integer) - skip this amount of feeds first
  • include_nested (bool) - include child categories (as Feed objects
    with is_cat set) requires version:1.6.0

Pagination:

Limit and offset are useful if you need feedlist pagination. If you use
them, you shouldn’t filter by unread, handle filtering in your app
instead.

Special category IDs are as follows:

  • 0 Uncategorized
  • -1 Special (e.g. Starred, Published, Archived, etc.)
  • -2 Labels

Added in version:1.5.0:

  • -3 All feeds, excluding virtual feeds (e.g. Labels and such)
  • -4 All feeds, including virtual feeds

Known bug: Prior to version:1.5.0 passing null or 0 cat_id to this
method returns full list of feeds instead of Uncategorized feeds only.

### getFeeds Returns JSON-encoded list of feeds. The list includes category id, title, feed url, etc. Parameters: - cat\_id (integer) - return feeds under category cat\_id - unread\_only (bool) - only return feeds which have unread articles - limit (integer) - limit amount of feeds returned to this value - offset (integer) - skip this amount of feeds first - include\_nested (bool) - include child categories (as Feed objects with is\_cat set) **requires version:1.6.0** Pagination: Limit and offset are useful if you need feedlist pagination. If you use them, you shouldn’t filter by unread, handle filtering in your app instead. Special category IDs are as follows: * 0 Uncategorized * -1 Special (e.g. Starred, Published, Archived, etc.) * -2 Labels Added in version:1.5.0: - -3 All feeds, excluding virtual feeds (e.g. Labels and such) - -4 All feeds, including virtual feeds Known bug: Prior to version:1.5.0 passing null or 0 cat\_id to this method returns full list of feeds instead of Uncategorized feeds only.
jking added the
api
feature
labels 7 years ago
jking added this to the 0.2.0 milestone 7 years ago
jking closed this issue 7 years ago
Sign in to join this conversation.
No Milestone
No Assignees
1 Participants
Notifications
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
There is no content yet.