Difference between revisions of "GetUserLiveChannelsPlayback"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the list of live channels playback (as array of LiveChannelsPlayback objects) ordered for the user, according to the adult filter. |P...") |
|||
| (4 intermediate revisions by one other user not shown) | |||
| Line 33: | Line 33: | ||
|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= deviceTypes | ||
| + | |ParamType=List of [[deviceType]] | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=List of deviceTypes separated by comma, to return the info of [[PlaybackInfo]]. | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName= filterChannelMap | ||
| + | |ParamType=bool | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=Use filter channel map | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName= imageHeigth | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=channel image heigth (default 0) | ||
| + | }} | ||
| + | {{Api_Parameter| | ||
| + | ParamName= imageWidth | ||
| + | |ParamType=int | ||
| + | |ParamRequired=optional | ||
| + | |ParamDescription=channel image width (default 0) | ||
}} | }} | ||
| Line 67: | Line 91: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.0 | ||
| + | {{!}} Added deviceTypes filter | ||
| + | {{!}} Alberto Los Santos | ||
{{!}}} | {{!}}} | ||
Latest revision as of 16:19, 10 February 2016
Description
Returns the list of live channels playback (as array of LiveChannelsPlayback objects) ordered for the user, according to the adult filter.
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
- playbackType (PlaybackType, optional)
- Playback type
- adultFilter (AdultFilterType, optional)
- Adult filter to apply to the list (default = all)
- deviceTypes (List of deviceType, optional)
- List of deviceTypes separated by comma, to return the info of PlaybackInfo.
- filterChannelMap (bool, optional)
- Use filter channel map
- imageHeigth (int, optional)
- channel image heigth (default 0)
- imageWidth (int, optional)
- channel image width (default 0)
Returns
Returns a JSON object with a list of LiveChannelsPlayback.
Example:
{
- "Offset": 0,
- "Limit": 10,
- "Count": 48,
- [ Array of LiveChannelsPlayback objects ]
}
Exceptions
- AuthenticationRequiredException: If user invoking the request is "anonymous".
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 |
| 3.0 | Added deviceTypes filter | Alberto Los Santos |
See also
- EpgLiveProgram object type
- LiveChannelsPlayback object type
- PlaybackType enumeration
- AdultFilterType enumeration
- Epg Service methods
