Channel

Represents a Channel object. Channel is sections that the user can access to list the contents associated to then. Contents are associated for a channel using the Content Criteria in the MIB Tool.

Members

Field	Data Type	Description
ID	int	Unique identifier for the Channel
IsEnabled	bool	Define if a channel is available
Title	String	The title for the Channel that will be shown to end users
Description	String	The description associated with this Channel.
ParentChannelId	int	Used to define the hierarchic levels of channels. A number represent the parent channel, usually to organize the channel tree level to create the menu navigation.
Images	Array of Image object	Array of images attached to channel
HasChildren	bool	Value to define if a channel has other channel inside then.
HasMovies	bool	DEPRECATED. Since GVP 2.4, this object will not be returned anymore.
HasFeaturedMovies	bool	Not used by the UNIAPI, just send the value (true/false) to device. It means that the value represent the same value registered in Mib Tools.
RequiresPin	bool	Define if a channel need the Parental PIN to access.
ProductSelectionId	int	Represents the ID of the ContentCriteria registered in this channel (It should be deprecated in future versions).
SubscriptionId	int	Set the product which the click on channel should be redirect to then.
BundleId	int	Set the product which the click on channel should be redirect to then.
HasNew	bool	Not used by the UNIAPI, just send the value (true/false) to device. It means that the value represent the same value registered in Mib Tools.
HasPopular	bool	Not used by the UNIAPI, just send the value (true/false) to device. It means that the value represent the same value registered in Mib Tools.
DisableNavigation	bool	Set if the Channel could be clicked or not. In the menu navigation, it allow/disallow the click on the channel, forcing the sub-channel navigation.
Ordination	int	Represents the order that wants to show on the front end.
IsSpecialChannel	bool	Not used by the UNIAPI, just send the value (true/false) to device. It means that the value represent the same value registered in Mib Tools.
ContentType	int	NEW IN 3.2! Indicates the Content Type defined for this channel.
VodDefaultOrder	int	NEW IN 3.2! Indicates to applications the default sort for VOD contents defined for this channel
LiveDefaultOrder	String	NEW IN 3.2! Indicates to applications the default sort for Live contents defined for this channel
ResizableImages	Array of Image object	It provides the list of original images (non resized) associated with this Channel. The application should use the Thumbox Service to perform dynamic resizing of the images in order to adapt them to the User Interface.

Example

{

"ID":236

"IsEnabled": true,

"Title": "Root TDIG Go",

"Description": "Description",

"ParentChannelId": 0,

"Images": [

Array of Image object

],

"HasChildren": true,

"HasMovies": false,

"HasFeaturedMovies": true,

"RequiresPin": false,

"ProductSelectionId": 0,

"SubscriptionId": 0,

"BundleId": 0,

"HasNew": false,

"HasPopular": false,

"DisableNavigation": false,

"Ordination": 7,

"IsSpecialChannel": false,

"ContentType": 1,

"VodDefaultOrder": 1,

"LiveDefaultOrder": 2,

"ResizeblaImages": [

Array of Image object

]

}

Known issues

None

Version history

API Version Number	Change description	Changes author
1.0	Initial data type implementation	Harley Cabral
2.3	Add Members isSpecialChannel	Ricardo Calvo
2.4	Add Members Description ResizableImages	Ricardo Calvo
3.2	Add Members ContentType VodDefaultOrder LiveDefaultOrder	Ricardo Calvo