1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
|
# TT-RSS FeedReader plugin
This is a plugin for [Tiny-Tiny-RSS](http://tt-rss.org) web based news feed reader and aggregator.
It adds a new API calls to allow better interaction of Tiny-Tiny-RSS and clients (in this case FeedReader).
The plugin requires (at least) version 1.12 of Tiny-Tiny-RSS.
## API Reference
**addLabel**
Returns a JSON-encoded ID of the added label.
Parameters:
* caption (string) - the caption of the label
**removeLabel**
Parameters:
* label_id (int) - the id of the label
**renameLabel**
Parameters:
* label_id (int) - the id of the label
* caption (string) - new name of the label
**addCategory**
Returns a JSON-encoded ID of the added category.
Parameters:
* caption (string) - the caption of the category
* parent_id (int, optional) - id of the category the new one should be placed into
**removeCategory**
Parameters:
* cateogry_id (int) - the id of the category
**moveCategory**
Parameters:
* cateogry_id (int) - the id of the category
* parent_id (int) - cateogry id of the new parent
**renameCategory**
Parameters:
* cateogry_id (int) - the id of the category
* caption (string) - new name of the category
**renameFeed**
Parameters:
* feed_id (int) - the id of the feed
* caption (string) - new name of the feed
**moveFeed**
Parameters:
* feed_id (int) - the id of the feed
* category_id (int) - id of category the feed will be moved to
## Installation
To install this plugin download the [ZIP file for the latest release](https://github.com/jangernert/FeedReader/releases), then extract the `data/tt-rss-feedreader-plugin/api_feedreader` directory in your own `tt-rss/plugin/` directory. You should have a new `api_feedreader` directory under plugins.
Edit your config.php and add "api_feedreader" to the list of system plugins. It will be automatically enabled for every user.
## License
This code is licensed under GPLv3.
|