Members
String
# inner constant ITEM_TYPE_PORTRAIT_SIZE
Item's size. It's used to get the image's template Url with the correct size
String
# inner constant ITEM_TYPE_PORTRAIT_SIZE
Item's size. It's used to get the image's template Url with the correct size
String
# inner constant ITEM_TYPE_PORTRAIT_SIZE
Item's size. It's used to get the image's template Url with the correct size
Methods
# async inner Episode(rawEpisode, segmentationValueopt) → {Episode}
Episode Model
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
rawEpisode |
Object
|
Episode |
|
segmentationValue |
string
|
<optional> |
segment to ask content from |
Episode
Episode
# inner Item(rawItem) → {Item}
Item Model
Parameters:
| Name | Type | Description |
|---|---|---|
rawItem |
Object
|
ITem |
Item
Item
# inner Movie(rawMovie) → {Movie}
Movie Model
Parameters:
| Name | Type | Description |
|---|---|---|
rawMovie |
Object
|
Movie |
Movie
Movie
# inner Season(rawSeason) → {Season}
Season Model
Parameters:
| Name | Type | Description |
|---|---|---|
rawSeason |
Object
|
Season |
Season
Season
# inner Show(rawShow) → {Show}
Show Model
Parameters:
| Name | Type | Description |
|---|---|---|
rawShow |
Object
|
Show |
show - The Show representation
Show
Type Definitions
Object
# Credit
Properties:
| Name | Type | Description |
|---|---|---|
role |
String
|
Credit Role |
names |
Array.<String>
|
Credit Names |
Object
# Episode
Properties:
| Name | Type | Description |
|---|---|---|
id |
String
|
Episode ID |
episodeNumber |
Number
|
Episode number |
showId |
String
|
Episode Show ID |
showTitle |
String
|
Episode Show Title |
category |
String
|
Episode Show Category |
seasonId |
String
|
Episode Season ID |
seasonNumber |
Number
|
Episode Season Number |
coverUrl |
String
|
Episode Cover Image URL |
backgroundUrl |
String
|
Episode Background Image URL |
metadata |
String
|
Episode Metadata |
title |
String
|
Episode Full Tile |
episodeTitle |
String
|
Episode Simple Tile |
description |
String
|
Episode Description |
credits |
Array.<Credit>
|
Episode Credits |
videoUrl |
String
|
Episode Video URL |
type |
String
|
Episode Type |
tvShowDescription |
String
|
Description of the associated TVShow |
publishedDate |
String
|
Publication date |
categories |
String
|
List of categories separated by comma |
duration |
String
|
duration of the episode as string in minutes |
Object
# Image
Properties:
| Name | Type | Description |
|---|---|---|
type |
String
|
Type of image ("backdrop"|"poster"|"logo"|"thumbnail"|"cover"|"banner") |
url |
String
|
image url |
height |
String
|
image height |
width |
String
|
image width |
Object
# Item
Properties:
| Name | Type | Description |
|---|---|---|
id |
String
|
Item ID |
categoryId |
String
|
Item Category ID |
coverUrl |
String
|
Item Cover Image URL |
metadata |
String
|
Item Metadata |
title |
String
|
Item Title |
description |
String
|
Item Description |
credits |
Array.<Credit>
|
Item Credits |
duration |
String
|
Item Duration |
videoUrl |
String
|
Item Video URL |
images |
Array.<Image>
|
Array of the images of the content |
displayText |
String
|
Text to display for the Item |
category |
String
|
The primary vategory |
link |
String
|
Route to use in the application to navigate to its detail |
type |
String
|
Type of the content from "movie, "episode" |
seasonCount |
Number
|
the season number for the episode |
episodeCount |
String
|
the episode number in the season for the episode |
template |
String
|
Item template to present the Item on the carousel |
publishedDate |
String
|
Publication date |
categories |
String
|
List of categories separated by comma |
Object
# Movie
Properties:
| Name | Type | Description |
|---|---|---|
id |
String
|
Movie ID |
categoryId |
String
|
Movie Category ID |
coverUrl |
String
|
Movie Cover Image URL |
metadata |
String
|
Movie Metadata |
title |
String
|
Movie Tile |
description |
String
|
Movie Description |
credits |
Array.<Credit>
|
Movie Credits |
duration |
String
|
Movie Duration |
videoUrl |
String
|
Movie Video URL |
link |
String
|
Movie route to use in the application to navigate to its detail |
category |
String
|
Movie Category Title |
type |
String
|
type of the content, in case is needed for a global check. Value hardcoded to 'movie' |
categories |
String
|
Categories array |
publishedDate |
String
|
Publication date |
images |
Array.<Image>
|
Array of the images of the movie |
Object
# Show
This model represents the Show Object
Properties:
| Name | Type | Description |
|---|---|---|
id |
String
|
Id of the Show |
category |
String
|
Show Category |
credits |
Array.<Credit>
|
Show Credits |
description |
String
|
Show description |
title |
String
|
Show Title |
link |
String
|
Route to use in the application to navigate to its detail |
images |
Array.<Image>
|
Array of the images of the Show |
coverUrl |
String
|
Show Cover Image URL |
fullWithCoverUrl |
String
|
Image url for the cover image of the Show |
type |
String
|
Type of content: show |
seasonCount |
Number
|
Number of seasons |
metadata |
String
|
Metadata to show on the detail page |