Difference between revisions of "GetPersonalLiveChannels"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the "personal" live channels, including the "user channels", "favorite channels" and last viewed channel |Parameters= {{Api_Parameter| Par...") |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description=Returns the "personal" live channels, including the "user channels", "favorite channels" and last viewed channel | Description=Returns the "personal" live channels, including the "user channels", "favorite channels" and last viewed channel | ||
| + | |||
| + | This method is only available for logged users. | ||
|Parameters= | |Parameters= | ||
| Line 14: | Line 16: | ||
|ParamRequired=optional | |ParamRequired=optional | ||
|ParamDescription=Adult filter to apply to the list (default = all) | |ParamDescription=Adult filter to apply to the list (default = all) | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName=filterChannelMap | ||
| + | |ParamType=bool | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=(default = false) | ||
}} | }} | ||
| + | |||
| Line 30: | Line 39: | ||
|Exceptions= | |Exceptions= | ||
| − | * | + | * AuthenticationRequiredException |
|Cache= | |Cache= | ||
| Line 48: | Line 57: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 2.4 | ||
| + | {{!}} Add filterChannelMap | ||
| + | {{!}} Ricardo Calvo | ||
{{!}}} | {{!}}} | ||
Latest revision as of 17:22, 21 October 2014
Description
Returns the "personal" live channels, including the "user channels", "favorite channels" and last viewed channel
This method is only available for logged users.
Parameters
- token (String, required)
- A valid token for identifying the API session context and logged user.
- adultFilter (AdultFilterType, optional)
- Adult filter to apply to the list (default = all)
- filterChannelMap (bool, optional)
- (default = false)
Returns
Returns the PersonalLiveChannel object.
Example:
{
- "UserLiveChannels": Array of int (user channels IDs),
- "FavoriteLiveChannels": Array of int (favorite channels IDs),
- "LastViewedLiveChannel": int (channel ID)
}
Exceptions
- AuthenticationRequiredException
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 |
| 2.4 | Add filterChannelMap | Ricardo Calvo |
See also
- LiveChannel object type
- AdultFilterType object type
- Epg Service methods
