Channel
Jump to navigation
Jump to search
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 |
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 ImageType 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 | |
RequiresPin | bool | Define if a channel need the Parental PIN to access. |
ProductSelectionId | int | |
SubscriptionId | int | |
BundleId | int | |
HasNew | bool | |
HasPopular | bool | |
DisableNavigation | bool | |
Ordination | int | Represents the order that wants to show on the front end. |
IsSpecialChannel | bool |
Example
{
"ID":236
"IsEnabled": true,
"Title": "Root TDIG Go",
"ParentChannelId": 0,
"Images": [],
"HasChildren": true,
"HasMovies": false,
"HasFeaturedMovies": true,
"RequiresPin": false,
"ProductSelectionId": 0,
"SubscriptionId": 0,
"BundleId": 0,
"HasNew": false,
"HasPopular": false,
"DisableNavigation": false,
"Ordination": 7,
"IsSpecialChannel": false
}
Known issues
None
Version history
API Version Number | Change description | Changes author |
---|---|---|
1.0 | Initial data type implementation | Harley Cabral |