diff options
| -rw-r--r-- | API-Reference.md (renamed from Api-Reference.md) | 905 | ||||
| -rw-r--r-- | Android-Client.md | 9 | ||||
| -rw-r--r-- | Archived-Feed.md | 2 | ||||
| -rw-r--r-- | Content-Filters.md | 2 | ||||
| -rw-r--r-- | Email-Digests.md | 2 | ||||
| -rw-r--r-- | Encryption.md | 2 | ||||
| -rw-r--r-- | FAQ.md | 7 | ||||
| -rw-r--r-- | Feed-Handler-Plugins.md | 2 | ||||
| -rw-r--r-- | Generated-Feeds.md | 2 | ||||
| -rw-r--r-- | Global-Config.md | 2 | ||||
| -rw-r--r-- | Installation-Notes.md | 2 | ||||
| -rw-r--r-- | Making-Plugins.md | 2 | ||||
| -rw-r--r-- | Plugins.md | 7 | ||||
| -rw-r--r-- | Publish-Articles.md | 2 | ||||
| -rw-r--r-- | SSL-Certificate-Authentication.md | 2 | ||||
| -rw-r--r-- | Scoring.md | 2 | ||||
| -rw-r--r-- | Search-Syntax.md | 2 | ||||
| -rw-r--r-- | Securing-Cache-Directories.md | 2 | ||||
| -rw-r--r-- | Share-Anything.md | 2 | ||||
| -rw-r--r-- | Sorting.md | 2 | ||||
| -rw-r--r-- | Themes.md | 7 |
21 files changed, 450 insertions, 517 deletions
diff --git a/Api-Reference.md b/API-Reference.md index 2d1da5a..c02e2eb 100644 --- a/Api-Reference.md +++ b/API-Reference.md @@ -1,456 +1,449 @@ ----
-hide:
- - navigation
----
-
-# API
-
-API is pluggable, plugins can use host <code>add\_api\_method()</code> to add
-custom API calls (see <code>classes/pluginhost.php</code> for details).
-
-API is stateful. You need to login and maintain a session ID to perform further operations. Session ID should be specified using JSON parameter **sid**. I.e.
-
-```bash
-curl -d '{"sid":"your-session-id","op":"getVersion"}' http://example.com/tt-rss/api/
-```
-
-All API calls output JSON-encoded data. API can be enabled or disabled
-per-user in the preferences. Client parameters should be passed encoded
-using JSON in HTTP POST data (supported since version:1.5.3). Older
-versions allowed passing parameters using HTTP GET and POST, but this is
-no longer supported.
-
-### Numeric values
-
-Numbers can also be passed (and are sometimes returned) as quoted string literals, i.e. ``"0"``.
-
-Some tt-rss versions have issues recognizing ``0`` as a valid number
-(unimplemented strict type checking causes ``0`` to be equivalent to ``false``
-in ``getHeadlines``, etc) so it might be a good idea to pass numerics as quoted
-strings for better backwards compatibility.
-
-### Boolean values
-
-For boolean parameters the expected syntax is:
-
-- empty string, numeric zero, unquoted ``false`` literal (?), string literal ``"f"`` or ``"false"``: <b>FALSE</b>
-- anything else: <b>TRUE</b>
-
-## Testing API calls (using curl)
-
-```bash
-curl -d '{"op":"login","user":"you","password":"xxx"}' http://example.com/tt-rss/api/
-```
-
-```bash
-curl -d '{"sid":"...","op":"getHeadlines","feed_id":"0","is_cat":"1"}' http://example.com/tt-rss/api/
-```
-
-Most of the calls (except login, logout, isLoggedIn) require valid login session
-or will return this error object: <code>{"error":"NOT_LOGGED_IN"}</code>
-
-## Output format
-
-All API methods return JSON data like this:
-
-```json
-{"seq":0,"status":0,"content":{"version":"1.4.3.1"}}
-```
-
-- seq (integer) is the sequence number supplied by client (``"seq":131``)
-- status (integer) indicates whether request has been completed
- successfully, can be either 0 (API\_STATUS\_OK) or 1
- (API\_STATUS\_ERR)
-- content is the actual reply content, as documented below in method
- descriptions.
-
-##### 1.4.3 and below (obsolete)
-
-Methods return the “content” object below, sequence numbers and statuses
-are not supported.
-
-Methods
--------
-
-### getApiLevel (since version:1.5.8, api level 1)
-
-Return an abstracted integer API version level, increased with each API
-functionality change. This is the proper way to detect host API
-functionality, instead of using getVersion.
-
-```json
-{"level":1}
-```
-
-Whether tt-rss returns error for this method (e.g. version:1.5.7 and
-below) client should assume API level 0.
-
-### getVersion
-
-Returns tt-rss version. As of, version:1.5.8 it is not recommended to
-use this to detect API functionality, please use getApiLevel instead.
-
-```json
-{"version":"1.4.0"}
-```
-
-### login
-
-Parameters:
-
-- ``user`` (string)
-- ``password`` (string)
-
-Returns client session ID.
-
-```json
-{"session_id":"xxx"}
-```
-
-It can also return several error objects:
-
-- If API is disabled for this user:
- <code>error: "API_DISABLED"</code>
-- If specified username and password are incorrect:
- <code>error: "LOGIN_ERROR"</code>
-
-In case it isn’t immediately obvious, you have to login and get a
-session ID even if you are using single user mode. You can omit user and
-password parameters.
-
-- On version:1.6.0 and above login also returns current API level as an
- <code>api\_level</code> integer, you can use that instead of calling `getApiLevel` after login.
-- Since API 17, also returns configuration object (see `getConfig` below).
-
-### logout
-
-Closes your login session. Returns either status-message <code>{"status":"OK"}</code> or an error (e.g. <code>{"error":"NOT_LOGGED_IN"}</code>)
-
-### isLoggedIn
-
-Returns a status message with boolean value showing whether your client (e.g.
-specific session ID) is currently logged in.
-
-```json
-{"status":false}
-```
-
-### getUnread
-
-Returns an integer value of currently unread articles.
-
-```json
-{"unread":"992"}
-```
-
-### getCounters
-
-Returns JSON-encoded counter information. Requires version:1.5.0.
-
-* ``output_mode`` (string, default: flc) - what kind of information to return (f - feeds, l - labels, c - categories, t - tags)
-
-### 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.
-
-### getCategories
-
-Returns JSON-encoded list of categories with unread counts.
-
-- ``unread_only`` (bool) - only return categories which have unread
- articles
-- ``enable_nested`` (bool) - switch to nested mode, only returns topmost
- categories **requires version:1.6.0**
-- ``include_empty`` (bool) - include empty categories **requires
- version:1.7.6**
-
-Nested mode in this case means that a flat list of **only** topmost
-categories is returned and unread counters include counters for child
-categories.
-
-This should be used as a starting point, to display a root list of all
-(for backwards compatibility) or topmost categories, use getFeeds to
-traverse deeper.
-
-### getHeadlines
-
-Returns JSON-encoded list of headlines.
-
-Parameters:
-
-- ``feed_id`` (integer|string) - only output articles for this feed (supports string values to retrieve tag virtual feeds since API level 18, otherwise integer)
-- ``limit`` (integer) - limits the amount of returned articles (see below)
-- ``skip`` (integer) - skip this amount of feeds first
-- ``filter`` (string) - currently unused (?)
-- ``is_cat`` (bool) - requested feed\_id is a category
-- ``show_excerpt`` (bool) - include article excerpt in the output
-- ``show_content`` (bool) - include full article text in the output
-- ``view_mode`` (string = all\_articles, unread, adaptive, marked,
- updated)
-- ``include_attachments`` (bool) - include article attachments (e.g.
- enclosures) **requires version:1.5.3**
-- ``since_id`` (integer) - only return articles with id greater than
- ``since_id`` **requires version:1.5.6**
-- ``include_nested`` (boolean) - include articles from child categories
- **requires version:1.6.0**
-- ``order_by`` (string) - override default sort order **requires
- version:1.7.6**
-- ``sanitize`` (bool) - sanitize content or not **requires version:1.8**
- (default: true)
-- ``force_update`` (bool) - try to update feed before showing headlines
- **requires version:1.14 (api 9)** (default: false)
-- ``has_sandbox`` (bool) - indicate support for sandboxing of iframe
- elements **<span class="10 api"></span>** (default: false)
-- ``include_header`` (bool) - adds status information when returning
- headlines, instead of array(articles) return value changes to
- array(header, array(articles)) (api 12)
-
-Limit:
-
-Before **API level 6** maximum amount of returned headlines is capped at
-60, API 6 and above sets it to 200.
-
-This parameters might change in the future (supported since **API level
-2**):
-
-- ``search`` (string) - search query (e.g. a list of keywords)
-- ``search_mode`` (string) - all\_feeds, this\_feed (default), this\_cat
- (category containing requested feed)
-- ``match_on`` (string) - ignored
-
-Special feed IDs are as follows:
-
-- -1 starred
-- -2 published
-- -3 fresh
-- -4 all articles
-- 0 - archived
-- IDs \< -10 labels
-
-Sort order values:
-
-- ``date_reverse`` - oldest first
-- ``feed_dates`` - newest first, goes by feed date
-- ``(nothing)`` - default
-
-### updateArticle
-
-Update information on specified articles.
-
-Parameters:
-
-- ``article_ids`` (comma-separated list of integers) - article IDs to
- operate on
-- ``mode`` (integer) - type of operation to perform (0 - set to false, 1 -
- set to true, 2 - toggle)
-- ``field`` (integer) - field to operate on (0 - starred, 1 - published, 2 - unread, 3 - article note **since api level 1**)
-- ``data`` (string) - optional data parameter when setting note field
- (since **api level 1**)
-
-E.g. to set unread status of articles X and Y to false use the
-following:
-
-<code>?article\_ids=X,Y&mode=0&field=2</code>
-
-Since version:1.5.0 returns a status message:
-
-```json
-{"status":"OK","updated":1}
-```
-
-“Updated” is number of articles updated by the query.
-
-### getArticle
-
-Requests JSON-encoded article object with specific ID.
-
-- ``article_id`` (integer) - article ID to return **as of 15.10.2010
- git** or version:1.5.0 supports comma-separated list of IDs
-
-Since version:1.4.3 also returns article attachments.
-
-### getConfig
-
-Returns tt-rss configuration parameters:
-
-```json
-{"icons_dir":"icons","icons_url":"icons","daemon_is_running":true,"num_feeds":71}
-```
-
-- ``icons_dir`` - path to icons on the server filesystem
-- ``icons_url`` - path to icons when requesting them over http
-- ``daemon_is_running`` - whether update daemon is running
-- ``num_feeds`` - amount of subscribed feeds (this can be used to refresh
- feedlist when this amount changes)
-- ``custom_sort_types`` - map of plugin-provided article sort types (API 17+)
-
-### updateFeed
-
-Tries to update specified feed. This operation is not performed in the
-background, so it might take considerable time and, potentially, be
-aborted by the HTTP server.
-
-- ``feed_id`` (integer) - ID of feed to update
-
-Returns status-message if the operation has been completed.
-
-```json
-{"status":"OK"}
-```
-
-### getPref
-
-Returns preference value of specified key.
-
-- ``pref_name`` (string) - preference key to return value of
-
-```json
-{"value":true}
-```
-
-### catchupFeed
-
-Required version: version:1.4.3
-
-Tries to catchup (e.g. mark as read) specified feed.
-
-Parameters:
-
-- ``feed_id`` (integer) - ID of feed to update
-- ``is_cat`` (boolean) - true if the specified feed\_id is a category
-- ``mode`` (string) - optional: one of `all`, `1day`, `1week`, `2week`. defaults to `all`. **since api level 15**.
-
-Returns status-message if the operation has been completed.
-
-```json
-{"status":"OK"}
-```
-
-### getCounters
-
-Required version: version:1.5.0
-
-Returns a list of unread article counts for specified feed groups.
-
-Parameters:
-
-- ``output_mode`` (string) - Feed groups to return counters for
-
-Output mode is a character string, comprising several letters (defaults
-to “flc”):
-
-- f - actual feeds
-- l - labels
-- c - categories
-- t - tags
-
-Several global counters are returned as well, those can’t be disabled
-with output\_mode.
-
-### getLabels (since API level 1)
-
-Returns list of configured labels, as an array of label objects:
-
-```json
-{"id":2,"caption":"Debian","fg_color":"#e14a00","bg_color":"#ffffff","checked":false},
-```
-
-Before version:1.7.5
-
-Returned id is an internal database id of the label, you can convert it
-to the valid feed id like this:
-
-<code>feed\_id = \-11 - label\_id</code>
-
-After:
-
-No conversion is necessary.
-
-Parameters:
-
-* ``article_id`` (int) - set “checked” to true if specified article id has returned label.
-
-### setArticleLabel (since API level 1)
-
-Assigns article\_ids to specified label.
-
-Parameters:
-
-* ``article_ids`` - comma-separated list of article ids
-* ``label_id`` (int) - label id, as returned in getLabels
-* ``assign`` (boolean) - assign or remove label
-
-Note: Up until version:1.15 setArticleLabel() clears the label cache for
-the specified articles. Make sure to regenerate it (e.g. by calling API
-method getLabels() for the respecting articles) when you’re using
-methods which don’t do that by themselves (e.g. getHeadlines())
-otherwise getHeadlines() will not return labels for modified articles.
-
-### shareToPublished (since API level 4 - version:1.6.0)
-
-Creates an article with specified data in the Published feed.
-
-Parameters:
-
-* ``title`` - Article title (string)
-* ``url`` - Article URL (string)
-* ``content`` - Article content (string)
-* ``sanitize`` (bool) - allows inserting HTML if disabled **requires API level 20** (default: true)
-
-### subscribeToFeed (API level 5 - version:1.7.6)
-
-Subscribes to specified feed, returns a status code. See
-subscribe\_to\_feed() in functions.php for details.
-
-Parameters:
-
-* ``feed_url`` - Feed URL (string)
-* ``category_id`` - Category id to place feed into (defaults to 0, Uncategorized) (int)
-* ``login``, ``password`` - Self explanatory (string)
-
-### unsubscribeFeed (API level 5 - version:1.7.6)
-
-Unsubscribes specified feed.
-
-Parameters:
-
-* ``feed_id`` - Feed id to unsubscribe from
-
-### getFeedTree (API level 5 - version:1.7.6)
-
-* ``include_empty`` (bool) - include empty categories
-
-Returns full tree of categories and feeds.
-
-Note: counters for most feeds are not returned with this call for
-performance reasons.
+API is pluggable, plugins can use host <code>add\_api\_method()</code> to add +custom API calls (see <code>classes/pluginhost.php</code> for details). + +API is stateful. You need to login and maintain a session ID to perform further operations. Session ID should be specified using JSON parameter **sid**. I.e. + +```bash +curl -d '{"sid":"your-session-id","op":"getVersion"}' http://example.com/tt-rss/api/ +``` + +All API calls output JSON-encoded data. API can be enabled or disabled +per-user in the preferences. Client parameters should be passed encoded +using JSON in HTTP POST data (supported since version:1.5.3). Older +versions allowed passing parameters using HTTP GET and POST, but this is +no longer supported. + +### Numeric values + +Numbers can also be passed (and are sometimes returned) as quoted string literals, i.e. ``"0"``. + +Some tt-rss versions have issues recognizing ``0`` as a valid number +(unimplemented strict type checking causes ``0`` to be equivalent to ``false`` +in ``getHeadlines``, etc) so it might be a good idea to pass numerics as quoted +strings for better backwards compatibility. + +### Boolean values + +For boolean parameters the expected syntax is: + +- empty string, numeric zero, unquoted ``false`` literal (?), string literal ``"f"`` or ``"false"``: <b>FALSE</b> +- anything else: <b>TRUE</b> + +## Testing API calls (using curl) + +```bash +curl -d '{"op":"login","user":"you","password":"xxx"}' http://example.com/tt-rss/api/ +``` + +```bash +curl -d '{"sid":"...","op":"getHeadlines","feed_id":"0","is_cat":"1"}' http://example.com/tt-rss/api/ +``` + +Most of the calls (except login, logout, isLoggedIn) require valid login session +or will return this error object: <code>{"error":"NOT_LOGGED_IN"}</code> + +## Output format + +All API methods return JSON data like this: + +```json +{"seq":0,"status":0,"content":{"version":"1.4.3.1"}} +``` + +- seq (integer) is the sequence number supplied by client (``"seq":131``) +- status (integer) indicates whether request has been completed + successfully, can be either 0 (API\_STATUS\_OK) or 1 + (API\_STATUS\_ERR) +- content is the actual reply content, as documented below in method + descriptions. + +##### 1.4.3 and below (obsolete) + +Methods return the “content” object below, sequence numbers and statuses +are not supported. + +Methods +------- + +### getApiLevel (since version:1.5.8, api level 1) + +Return an abstracted integer API version level, increased with each API +functionality change. This is the proper way to detect host API +functionality, instead of using getVersion. + +```json +{"level":1} +``` + +Whether tt-rss returns error for this method (e.g. version:1.5.7 and +below) client should assume API level 0. + +### getVersion + +Returns tt-rss version. As of, version:1.5.8 it is not recommended to +use this to detect API functionality, please use getApiLevel instead. + +```json +{"version":"1.4.0"} +``` + +### login + +Parameters: + +- ``user`` (string) +- ``password`` (string) + +Returns client session ID. + +```json +{"session_id":"xxx"} +``` + +It can also return several error objects: + +- If API is disabled for this user: + <code>error: "API_DISABLED"</code> +- If specified username and password are incorrect: + <code>error: "LOGIN_ERROR"</code> + +In case it isn’t immediately obvious, you have to login and get a +session ID even if you are using single user mode. You can omit user and +password parameters. + +- On version:1.6.0 and above login also returns current API level as an + <code>api\_level</code> integer, you can use that instead of calling `getApiLevel` after login. +- Since API 17, also returns configuration object (see `getConfig` below). + +### logout + +Closes your login session. Returns either status-message <code>{"status":"OK"}</code> or an error (e.g. <code>{"error":"NOT_LOGGED_IN"}</code>) + +### isLoggedIn + +Returns a status message with boolean value showing whether your client (e.g. +specific session ID) is currently logged in. + +```json +{"status":false} +``` + +### getUnread + +Returns an integer value of currently unread articles. + +```json +{"unread":"992"} +``` + +### getCounters + +Returns JSON-encoded counter information. Requires version:1.5.0. + +* ``output_mode`` (string, default: flc) - what kind of information to return (f - feeds, l - labels, c - categories, t - tags) + +### 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. + +### getCategories + +Returns JSON-encoded list of categories with unread counts. + +- ``unread_only`` (bool) - only return categories which have unread + articles +- ``enable_nested`` (bool) - switch to nested mode, only returns topmost + categories **requires version:1.6.0** +- ``include_empty`` (bool) - include empty categories **requires + version:1.7.6** + +Nested mode in this case means that a flat list of **only** topmost +categories is returned and unread counters include counters for child +categories. + +This should be used as a starting point, to display a root list of all +(for backwards compatibility) or topmost categories, use getFeeds to +traverse deeper. + +### getHeadlines + +Returns JSON-encoded list of headlines. + +Parameters: + +- ``feed_id`` (integer|string) - only output articles for this feed (supports string values to retrieve tag virtual feeds since API level 18, otherwise integer) +- ``limit`` (integer) - limits the amount of returned articles (see below) +- ``skip`` (integer) - skip this amount of feeds first +- ``filter`` (string) - currently unused (?) +- ``is_cat`` (bool) - requested feed\_id is a category +- ``show_excerpt`` (bool) - include article excerpt in the output +- ``show_content`` (bool) - include full article text in the output +- ``view_mode`` (string = all\_articles, unread, adaptive, marked, + updated) +- ``include_attachments`` (bool) - include article attachments (e.g. + enclosures) **requires version:1.5.3** +- ``since_id`` (integer) - only return articles with id greater than + ``since_id`` **requires version:1.5.6** +- ``include_nested`` (boolean) - include articles from child categories + **requires version:1.6.0** +- ``order_by`` (string) - override default sort order **requires + version:1.7.6** +- ``sanitize`` (bool) - sanitize content or not **requires version:1.8** + (default: true) +- ``force_update`` (bool) - try to update feed before showing headlines + **requires version:1.14 (api 9)** (default: false) +- ``has_sandbox`` (bool) - indicate support for sandboxing of iframe + elements **<span class="10 api"></span>** (default: false) +- ``include_header`` (bool) - adds status information when returning + headlines, instead of array(articles) return value changes to + array(header, array(articles)) (api 12) + +Limit: + +Before **API level 6** maximum amount of returned headlines is capped at +60, API 6 and above sets it to 200. + +This parameters might change in the future (supported since **API level +2**): + +- ``search`` (string) - search query (e.g. a list of keywords) +- ``search_mode`` (string) - all\_feeds, this\_feed (default), this\_cat + (category containing requested feed) +- ``match_on`` (string) - ignored + +Special feed IDs are as follows: + +- -1 starred +- -2 published +- -3 fresh +- -4 all articles +- 0 - archived +- IDs \< -10 labels + +Sort order values: + +- ``date_reverse`` - oldest first +- ``feed_dates`` - newest first, goes by feed date +- ``(nothing)`` - default + +### updateArticle + +Update information on specified articles. + +Parameters: + +- ``article_ids`` (comma-separated list of integers) - article IDs to + operate on +- ``mode`` (integer) - type of operation to perform (0 - set to false, 1 - + set to true, 2 - toggle) +- ``field`` (integer) - field to operate on (0 - starred, 1 - published, 2 - unread, 3 - article note **since api level 1**) +- ``data`` (string) - optional data parameter when setting note field + (since **api level 1**) + +E.g. to set unread status of articles X and Y to false use the +following: + +<code>?article\_ids=X,Y&mode=0&field=2</code> + +Since version:1.5.0 returns a status message: + +```json +{"status":"OK","updated":1} +``` + +“Updated” is number of articles updated by the query. + +### getArticle + +Requests JSON-encoded article object with specific ID. + +- ``article_id`` (integer) - article ID to return **as of 15.10.2010 + git** or version:1.5.0 supports comma-separated list of IDs + +Since version:1.4.3 also returns article attachments. + +### getConfig + +Returns tt-rss configuration parameters: + +```json +{"icons_dir":"icons","icons_url":"icons","daemon_is_running":true,"num_feeds":71} +``` + +- ``icons_dir`` - path to icons on the server filesystem +- ``icons_url`` - path to icons when requesting them over http +- ``daemon_is_running`` - whether update daemon is running +- ``num_feeds`` - amount of subscribed feeds (this can be used to refresh + feedlist when this amount changes) +- ``custom_sort_types`` - map of plugin-provided article sort types (API 17+) + +### updateFeed + +Tries to update specified feed. This operation is not performed in the +background, so it might take considerable time and, potentially, be +aborted by the HTTP server. + +- ``feed_id`` (integer) - ID of feed to update + +Returns status-message if the operation has been completed. + +```json +{"status":"OK"} +``` + +### getPref + +Returns preference value of specified key. + +- ``pref_name`` (string) - preference key to return value of + +```json +{"value":true} +``` + +### catchupFeed + +Required version: version:1.4.3 + +Tries to catchup (e.g. mark as read) specified feed. + +Parameters: + +- ``feed_id`` (integer) - ID of feed to update +- ``is_cat`` (boolean) - true if the specified feed\_id is a category +- ``mode`` (string) - optional: one of `all`, `1day`, `1week`, `2week`. defaults to `all`. **since api level 15**. + +Returns status-message if the operation has been completed. + +```json +{"status":"OK"} +``` + +### getCounters + +Required version: version:1.5.0 + +Returns a list of unread article counts for specified feed groups. + +Parameters: + +- ``output_mode`` (string) - Feed groups to return counters for + +Output mode is a character string, comprising several letters (defaults +to “flc”): + +- f - actual feeds +- l - labels +- c - categories +- t - tags + +Several global counters are returned as well, those can’t be disabled +with output\_mode. + +### getLabels (since API level 1) + +Returns list of configured labels, as an array of label objects: + +```json +{"id":2,"caption":"Debian","fg_color":"#e14a00","bg_color":"#ffffff","checked":false}, +``` + +Before version:1.7.5 + +Returned id is an internal database id of the label, you can convert it +to the valid feed id like this: + +<code>feed\_id = \-11 - label\_id</code> + +After: + +No conversion is necessary. + +Parameters: + +* ``article_id`` (int) - set “checked” to true if specified article id has returned label. + +### setArticleLabel (since API level 1) + +Assigns article\_ids to specified label. + +Parameters: + +* ``article_ids`` - comma-separated list of article ids +* ``label_id`` (int) - label id, as returned in getLabels +* ``assign`` (boolean) - assign or remove label + +Note: Up until version:1.15 setArticleLabel() clears the label cache for +the specified articles. Make sure to regenerate it (e.g. by calling API +method getLabels() for the respecting articles) when you’re using +methods which don’t do that by themselves (e.g. getHeadlines()) +otherwise getHeadlines() will not return labels for modified articles. + +### shareToPublished (since API level 4 - version:1.6.0) + +Creates an article with specified data in the Published feed. + +Parameters: + +* ``title`` - Article title (string) +* ``url`` - Article URL (string) +* ``content`` - Article content (string) +* ``sanitize`` (bool) - allows inserting HTML if disabled **requires API level 20** (default: true) + +### subscribeToFeed (API level 5 - version:1.7.6) + +Subscribes to specified feed, returns a status code. See +subscribe\_to\_feed() in functions.php for details. + +Parameters: + +* ``feed_url`` - Feed URL (string) +* ``category_id`` - Category id to place feed into (defaults to 0, Uncategorized) (int) +* ``login``, ``password`` - Self explanatory (string) + +### unsubscribeFeed (API level 5 - version:1.7.6) + +Unsubscribes specified feed. + +Parameters: + +* ``feed_id`` - Feed id to unsubscribe from + +### getFeedTree (API level 5 - version:1.7.6) + +* ``include_empty`` (bool) - include empty categories + +Returns full tree of categories and feeds. + +Note: counters for most feeds are not returned with this call for +performance reasons. diff --git a/Android-Client.md b/Android-Client.md index ea130eb..2a322df 100644 --- a/Android-Client.md +++ b/Android-Client.md @@ -1,11 +1,4 @@ ---- -hide: - - navigation ---- - -# Android client - -## **IMPORTANT** +## **IMPORTANT** This content is no longer accurate, given the original tt-rss project has closed. diff --git a/Archived-Feed.md b/Archived-Feed.md index 6ec30bb..1b0b56d 100644 --- a/Archived-Feed.md +++ b/Archived-Feed.md @@ -1,5 +1,3 @@ -# Archived Feed - Archived is the place for articles for which originating feed no longer exists. It's either Starred articles from unsubscribed feeds or [externally shared data](Share-Anything). diff --git a/Content-Filters.md b/Content-Filters.md index 6694e8c..f4c4561 100644 --- a/Content-Filters.md +++ b/Content-Filters.md @@ -1,5 +1,3 @@ -# Filters - Filters are a very powerful and flexible tool which may significantly ease the task of extracting useful information from the sea of data that is RSS feeds. Filters are applied to articles based on [regular diff --git a/Email-Digests.md b/Email-Digests.md index 42bc564..c3122d5 100644 --- a/Email-Digests.md +++ b/Email-Digests.md @@ -1,5 +1,3 @@ -# Email Digests - Users may opt into receiving daily (sent once every 24 hours) digests of unread headlines via email. Digests are sent out by the update daemon or if running <code>update.php —feeds</code> diff --git a/Encryption.md b/Encryption.md index 98c56ea..733f6c1 100644 --- a/Encryption.md +++ b/Encryption.md @@ -1,5 +1,3 @@ -# At rest encryption - Transparent at rest encryption is optionally supported for sensitive data stored in the database, currently limited to stored session data and passwords for feeds with authentication enabled. To enable, [global configuration](Global-Config) option `TTRSS_ENCRYPTION_KEY` should be set to a 32-byte hex string of random bytes, which may be generated using CLI like this: @@ -1,10 +1,3 @@ ---- -hide: - - navigation ---- - -# FAQ - > [!NOTE] > [Docker-related stuff has a separate FAQ page](Installation-Notes#faq) diff --git a/Feed-Handler-Plugins.md b/Feed-Handler-Plugins.md index a12a95b..1122619 100644 --- a/Feed-Handler-Plugins.md +++ b/Feed-Handler-Plugins.md @@ -1,5 +1,3 @@ -# Feed handler plugins - > [!WARNING] > Unless you have a strong need for these plugins, using them is not recommended. If > you do use them, at least don't enable them for all feeds. diff --git a/Generated-Feeds.md b/Generated-Feeds.md index 5a302cc..663705f 100644 --- a/Generated-Feeds.md +++ b/Generated-Feeds.md @@ -1,5 +1,3 @@ -# Generated Feeds - You can generate a feed (in Atom or JSON format) for almost anything displayed in headlines buffer (e.g. actual feeds, Labels, Categories, etc.) by clicking this icon: diff --git a/Global-Config.md b/Global-Config.md index ff9a31c..de52ab0 100644 --- a/Global-Config.md +++ b/Global-Config.md @@ -1,5 +1,3 @@ -# Global configuration - All settings (see `_DEFAULTS[]` for default values) are listed here: - https://github.com/supahgreg/tt-rss/blob/main/classes/Config.php (source code, including default values) diff --git a/Installation-Notes.md b/Installation-Notes.md index fd79c4f..81c96fe 100644 --- a/Installation-Notes.md +++ b/Installation-Notes.md @@ -1,5 +1,3 @@ -# Installation Guide - The recommended way to run tt-rss is under Docker. The Docker images related to https://github.com/supahgreg/tt-rss are: diff --git a/Making-Plugins.md b/Making-Plugins.md index ad42e71..be5a148 100644 --- a/Making-Plugins.md +++ b/Making-Plugins.md @@ -1,5 +1,3 @@ -# Making Plugins - Plugins may render new preference panes or embed themselves into several existing one, store data using simple key -\> value data or directly in the database, modify how articles are rendered, alter feed data, and @@ -1,10 +1,3 @@ ---- -hide: - - navigation ---- - -# Plugins - Tiny Tiny RSS supports many kinds of plugins: social plugins which share articles to various sites, article filter plugins which mangle feed-provided data on import (for example, inlining images or extracting full article text diff --git a/Publish-Articles.md b/Publish-Articles.md index f083e71..6b6840d 100644 --- a/Publish-Articles.md +++ b/Publish-Articles.md @@ -1,5 +1,3 @@ -# Published Articles - You can publish selected articles to a special RSS feed, accessible to anyone who knows the special randomly-generated URL. This works independently of [[Generated Feeds]] which allows you to share entire feeds, diff --git a/SSL-Certificate-Authentication.md b/SSL-Certificate-Authentication.md index fb44b4a..720b56b 100644 --- a/SSL-Certificate-Authentication.md +++ b/SSL-Certificate-Authentication.md @@ -1,5 +1,3 @@ -# SSL Certificate Authentication - > [!WARNING] > This guide is considered legacy and is no longer supported as it is not compatible with the > [stock Docker Compose](Installation-Notes) setup. Please don't report any issues when @@ -1,5 +1,3 @@ -# Scoring
-
Scoring is supported in a way similar to some newsreaders. Score is calculated
on article import using special filters with a "Modify score" action.
diff --git a/Search-Syntax.md b/Search-Syntax.md index 8c172b1..5ac4c4e 100644 --- a/Search-Syntax.md +++ b/Search-Syntax.md @@ -1,5 +1,3 @@ -# Search Syntax - > [!NOTE] > This only applies to built-in search, other search plugins like may override this syntax. diff --git a/Securing-Cache-Directories.md b/Securing-Cache-Directories.md index 360c8f6..f0d1bc2 100644 --- a/Securing-Cache-Directories.md +++ b/Securing-Cache-Directories.md @@ -1,5 +1,3 @@ -# Securing Cache Directories - > [!NOTE] > Official container images restrict `/cache` access by default. This page applies only to > legacy host installations. diff --git a/Share-Anything.md b/Share-Anything.md index f546e96..112f06c 100644 --- a/Share-Anything.md +++ b/Share-Anything.md @@ -1,5 +1,3 @@ -# Share Anything
-
You can share arbitrary webpages to appear as articles in your ``Published``
feed. Combined with Readability this makes tt-rss function like a read-it-later
kind of website.
@@ -1,5 +1,3 @@ -# Sorting - Tiny Tiny RSS provides four options for how articles appear within a selected feed: `Default`, `Newest`, `Oldest`, `Title`. @@ -1,10 +1,3 @@ ---- -hide: - - navigation ---- - -# Themes - Install by copying theme CSS (and any other content, if needed) into ``themes.local`` directory under tt-rss root, then you'll be able to activate it in preferences. **Please note that we’re not responsible for third party themes. Use at your own risk.** |