Difference between revisions of "API/Favorites Protocol"
From ickStream Wiki
m |
|||
| Line 12: | Line 12: | ||
= Generic methods = | = Generic methods = | ||
* [[API/Service Protocol/getServiceInformation|getServiceInformation]] - Get information about service | * [[API/Service Protocol/getServiceInformation|getServiceInformation]] - Get information about service | ||
| + | * [[API/Service Protocol/getProtocolVersions|getProtocolVersions]] - Get information about supported protocol versions | ||
= Service methods = | = Service methods = | ||
Latest revision as of 05:04, 5 July 2013
[edit] Principles
This page describes the protocol which is used to manage favorites and too get a list of available favorites. The meaning of a favorite is that the user want a shortcut to a certain area of the menu structure, typically it's a shortcut to a radio station, playlist or something similar.
To find the access point for the Favorites Protocol, see:
- For cloud version: The findServices method in the Cloud Core Protocol
- For local network versions: The getServiceInformation method in the Service Protocol
The recommendation is to use the cloud version if it exists in the user account and else use a local server if it exists and if none of them exists don't offer any favorites functionality to the user
[edit] Generic methods
- getServiceInformation - Get information about service
- getProtocolVersions - Get information about supported protocol versions
[edit] Service methods
- saveFavorite - Add or update a favorite for current user
- removeFavorite - Remove a favorite for current user
- findFavorites - Get favorites for current user
