Bureaucrats, editor, Administrators
470
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_DataType_Spec |Description=Represents a Channel object. Channel is sections that the user can access to list the contents associated to then. Contents are associated for a ..."
{{Api_DataType_Spec
|Description=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=
{{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10"
{{!}}- style="background:#88ccff;font-size:110%"
! Field
! Data Type
! Description
{{!}}- valign="top"
! ID
{{!}} int
{{!}} Unique identifier for the Channel
{{!}}- valign="top"
! IsEnabled
{{!}} bool
{{!}} Define if a channel is available
{{!}}- valign="top"
! Title
{{!}} String
{{!}} The title for the Channel that will be shown to end users
{{!}}- valign="top"
! 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.
{{!}}- valign="top"
! Images
{{!}} Array of [[ImageType]] object
{{!}} Array of images attached to channel
{{!}}- valign="top"
! HasChildren
{{!}} bool
{{!}} Value to define if a channel has other channel inside then.
{{!}}- valign="top"
! HasMovies
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore.
{{!}}- valign="top"
! HasFeaturedMovies
{{!}} bool
{{!}}
{{!}}- valign="top"
! RequiresPin
{{!}} bool
{{!}} Define if a channel need the Parental PIN to access.
{{!}}- valign="top"
! ProductSelectionId
{{!}} int
{{!}}
{{!}}- valign="top"
! SubscriptionId
{{!}} int
{{!}}
{{!}}- valign="top"
! BundleId
{{!}} int
{{!}}
{{!}}- valign="top"
! HasNew
{{!}} bool
{{!}}
{{!}}- valign="top"
! HasPopular
{{!}} bool
{{!}}
{{!}}- valign="top"
! DisableNavigation
{{!}} bool
{{!}}
{{!}}- valign="top"
! Ordination
{{!}} int
{{!}} Represents the order that wants to show on the front end.
{{!}}- valign="top"
! IsSpecialChannel
{{!}} bool
{{!}}
{{!}}- valign="top"
{{!}}}
|Example=
<syntaxhighlight lang="javascript">
{
"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
}
</syntaxhighlight>
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial data type implementation
{{!}} Harley Cabral
{{!}}- valign="top"
{{!}}}
|SeeAlso=
}}
|Description=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=
{{{!}} border="2" style="width:800px" cellspacing="0" cellpadding="10"
{{!}}- style="background:#88ccff;font-size:110%"
! Field
! Data Type
! Description
{{!}}- valign="top"
! ID
{{!}} int
{{!}} Unique identifier for the Channel
{{!}}- valign="top"
! IsEnabled
{{!}} bool
{{!}} Define if a channel is available
{{!}}- valign="top"
! Title
{{!}} String
{{!}} The title for the Channel that will be shown to end users
{{!}}- valign="top"
! 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.
{{!}}- valign="top"
! Images
{{!}} Array of [[ImageType]] object
{{!}} Array of images attached to channel
{{!}}- valign="top"
! HasChildren
{{!}} bool
{{!}} Value to define if a channel has other channel inside then.
{{!}}- valign="top"
! HasMovies
{{!}} bool
{{!}} bgcolor="#FF2600" {{!}} '''DEPRECATED'''. Since GVP 2.4, this object will not be returned anymore.
{{!}}- valign="top"
! HasFeaturedMovies
{{!}} bool
{{!}}
{{!}}- valign="top"
! RequiresPin
{{!}} bool
{{!}} Define if a channel need the Parental PIN to access.
{{!}}- valign="top"
! ProductSelectionId
{{!}} int
{{!}}
{{!}}- valign="top"
! SubscriptionId
{{!}} int
{{!}}
{{!}}- valign="top"
! BundleId
{{!}} int
{{!}}
{{!}}- valign="top"
! HasNew
{{!}} bool
{{!}}
{{!}}- valign="top"
! HasPopular
{{!}} bool
{{!}}
{{!}}- valign="top"
! DisableNavigation
{{!}} bool
{{!}}
{{!}}- valign="top"
! Ordination
{{!}} int
{{!}} Represents the order that wants to show on the front end.
{{!}}- valign="top"
! IsSpecialChannel
{{!}} bool
{{!}}
{{!}}- valign="top"
{{!}}}
|Example=
<syntaxhighlight lang="javascript">
{
"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
}
</syntaxhighlight>
|KnownIssues=
None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial data type implementation
{{!}} Harley Cabral
{{!}}- valign="top"
{{!}}}
|SeeAlso=
}}
