GetUserFavoriteLiveChannels
Revision as of 15:22, 2 June 2014 by Id02256 (talk | contribs) (Created page with "{{Api_Method_Spec| Description=Returns the list of the "favorite user live channels" objects (LiveChannel). Note: All methods returning channel lists are ordered by ChannelN...")
Description
Returns the list of the "favorite user live channels" objects (LiveChannel).
Note: All methods returning channel lists are ordered by ChannelNumber and ID. That way it makes it easier for clients implementing channel up and down functionality based on channel lists
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- offset (int, optional)
- Index of the initial result of the list, begins with 0
- limit (int, optional)
- Quantity of results showed, with the maximum of 100
- imageWidth (int, optional)
- Channel Image width (default=0)
- imageHeight (int, optional)
- Channel Image width (default=0)
- adultFilter (AdultFilterType, optional)
- Adult filter to apply to the list (default = all)
Returns
Returns a JSON object with a list of LiveChannel.
Example:
{
- "Offset": 0,
- "Limit": 10,
- "Count": 48,
- [ Array of LiveChannel objects ]
}
Exceptions
- None.
Caching
This method is not cached.
Known issues
None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial method design | Harley Cabral |
See also
- LiveChannel object type
- AdultFilterType object type
- Epg Service methods