Difference between revisions of "GetUserLockedChannels"
Jump to navigation
Jump to search
(Created page with "{{Api_Method_Spec| Description=Returns the list of user live channels objects (LiveChannel) with locked status. Note: All methods returning channel lists are ordered by Chan...") |
|||
| Line 1: | Line 1: | ||
| + | {{Deprecated|Message=This method has been deprecated in GVP 3.2}} | ||
| + | |||
{{Api_Method_Spec| | {{Api_Method_Spec| | ||
Description=Returns the list of user live channels objects ([[LiveChannel]]) with locked status. | Description=Returns the list of user live channels objects ([[LiveChannel]]) with locked status. | ||
| Line 64: | Line 66: | ||
{{!}} Initial method design | {{!}} Initial method design | ||
{{!}} Harley Cabral | {{!}} Harley Cabral | ||
| + | {{!}}- valign="top" | ||
| + | ! 3.2 | ||
| + | {{!}} Deprecated method | ||
| + | {{!}} Francisco Milagro | ||
{{!}}} | {{!}}} | ||
Latest revision as of 07:12, 21 August 2015
This method has been deprecated in GVP 3.2
Description
Returns the list of user live channels objects (LiveChannel) with locked status.
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
- 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 |
| 3.2 | Deprecated method | Francisco Milagro |
See also
- LiveChannel object type
- AdultFilterType object type
- Epg Service methods
