Bureaucrats, editor, Administrators
282
edits
Changes
Jump to navigation
Jump to search
}}
{{Api_Parameter|
ParamName=includeChildMovies
|ParamType=boolean
|ParamRequired=optional
|ParamDescription=Define if the method should return all contents hierarchy instead inside any sub channels under this channel.
}}
{{Api_Parameter|
ParamName= movieType
|ParamType=[[movieType]]
|ParamRequired=optional
|ParamDescription=Filter the result by one type: Movies, Episodes, Series, Season.
no edit summary
{{Api_Method_Spec|
Description=Get all items assigned to a Channel. If the parameter includeChild were true, all movie contents assigned under all sub-channel will be included in the result.
The result will return a list of [[CatalogItem]] that could be one of these [[CatalogItemType]]. It can returns VoD, Live Contents and both.The result is default ordered by the Title Default ( 0 ) [[SortType]] or sorted by a field specified in the request using [[MovieSortTypeSortType]] enumeration. A parameter SortOrder has been implemented in a way to order ascending or descending results as well. In case the requested SortType is 0 (Default) gvp.api.neuromancer or it is not set, will order the results depending on the Channel LiveDefaultOrder and VoDDefaultOrder properties in the Channels Page. In case the Channel is configured with ContentType equals to Live, LiveDefaultOrder will be used; otherwise, VoDDefaultOrder will be taken into consideration. Default configuration in LiveDefaultOrder/VoDDefaultOrder orders the results by their IDs. The result could be filtered by [[MovieType]], [[SubscriptionType]] and [[ProductTypeCatalogItemType]].
The result also can be filtered by the adult content. Using the [[AdultFilterType]] options: All, AdultOnly and NonAdultOnly.
Similar to [[GetChannelSimpleMovies]] but it has better performance.
Deprecated Parameter:
-The parameter includeChildMovies was deprecated in the 3.2 GVP version.
|Parameters=
|ParamRequired=required
|ParamDescription=The channel id that want to return the content registered inside then.
}}
{{Api_Parameter|
}}
{{Api_Parameter|
ParamName= productTypeFiltercatalogItemTypeFilter|ParamType= [[productTypecatalogItemType]]
|ParamRequired=optional
|ParamDescription=List of ProductTypeId CatalogItemTypeId separated by comma to filter the result required.
}}
{{Api_Parameter|
{{Api_Parameter|
ParamName= sort
|ParamType= [[movieSortTypeSortType]]
|ParamRequired=optional
|ParamDescription=SortTypeId to order result by the chosen field
}}
{{Api_Parameter|ParamName= sortOrder|ParamType= [[SortOrder]]|ParamRequired=optional|ParamDescription=SortOrderId to order ascending/descending. Ascending default (if not provided)}}
|Returns=
|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 method design
{{!}} Harley Cabral
{{!}}- valign="top"
! 3.2
{{!}}
New:<br />
- catalogItemTypeFilter<br />
- sortType<br />
- sortOrder<br />
Deprecated:
- includeChildMovies<br />
- MovieType<br />
- ProductTypeFilter<br />
{{!}} Ricardo Calvo
{{!}}}
