View source for API/Favorites Protocol

= 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 [[API/Cloud Core Protocol/findServices|findServices]] method in the [[API/Cloud Core Protocol|Cloud Core Protocol]]
* For local network versions: The [[API/Service Protocol/getServiceInformation|getServiceInformation]] method in the [[API/Service Protocol|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

= Generic methods = 
* [[API/Service Protocol/getServiceInformation|getServiceInformation]] - Get information about service
* [[API/Service Protocol/getProtocolVersions|getProtocolVersions]] - Get information about supported protocol versions

= Service methods =

* [[API/Favorites Protocol/saveFavorite|saveFavorite]] - Add or update a favorite for current user
* [[API/Favorites Protocol/removeFavorite|removeFavorite]] - Remove a favorite for current user
* [[API/Favorites Protocol/findFavorites|findFavorites]] - Get favorites for current user

[[Category:API]]