Difference between revisions of "SimpleMovie"
Jump to navigation
Jump to search
| Line 14: | Line 14: | ||
! AgeRating | ! AgeRating | ||
{{!}} [[InstanceAgeRating]] | {{!}} [[InstanceAgeRating]] | ||
| − | {{!}} | + | {{!}} An object that contains all information about the ageRatings of the movie returned. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! AvailableForThisDevice | ! AvailableForThisDevice | ||
{{!}} bool | {{!}} bool | ||
| − | {{!}} | + | {{!}} Set if the movie is available for the device from the currently request (device logged for the request). |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! AvailableForThisDeviceInHD | ! AvailableForThisDeviceInHD | ||
{{!}} bool | {{!}} bool | ||
| − | {{!}} | + | {{!}} Set if the movie is available for the device in HD mode in currently request (device logged for the request). |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! AvailableForThisDeviceInSD | ! AvailableForThisDeviceInSD | ||
{{!}} bool | {{!}} bool | ||
| − | {{!}} | + | {{!}} Set if the movie is available for the device in SD mode in currently request (device logged for the request). |
{{!}}- valign="top" | {{!}}- valign="top" | ||
| Line 39: | Line 39: | ||
! CommercializationType | ! CommercializationType | ||
{{!}} [[CommercializationType]] | {{!}} [[CommercializationType]] | ||
| − | {{!}} | + | {{!}} An object represented by a number type (enumeration) that represent a type as the product is commercialised. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Distributor | ! Distributor | ||
{{!}} [[Distributor]] | {{!}} [[Distributor]] | ||
| − | {{!}} | + | {{!}} An object represented by a number type (enumeration) that represent a type as the product is distributed. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Duration | ! Duration | ||
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} A number that represent the time duration of the movie expressed in seconds. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Genres | ! Genres | ||
| − | {{!}} Genre | + | {{!}} [[Genre]] |
| − | {{!}} | + | {{!}} An object that contains an array of [[Genre]] object assigned to movie. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! ID | ! ID | ||
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} A unique identifier for the movie |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Images | ! Images | ||
{{!}} Array of [[Image]] | {{!}} Array of [[Image]] | ||
| − | {{!}} | + | {{!}} Array of [[Image]] object registered in the platform. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! IsDtp | ! IsDtp | ||
{{!}} bool | {{!}} bool | ||
| − | {{!}} | + | {{!}} Set if the movie is available to be downloaded and play offline. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Medias | ! Medias | ||
{{!}} [[Media]] | {{!}} [[Media]] | ||
| − | {{!}} | + | {{!}} Array of [[Media]] object that contains a series of information about the movie's media. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! OrderEpisode | ! OrderEpisode | ||
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} Set the episode order that wants to be returned the content. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! PlaybackAccess | ! PlaybackAccess | ||
{{!}} [[PlaybackRight]] | {{!}} [[PlaybackRight]] | ||
| − | {{!}} | + | {{!}} A number that indicate a kind of right the user has rights access. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Producer | ! Producer | ||
{{!}} [[Producer]] | {{!}} [[Producer]] | ||
| − | {{!}} | + | {{!}} An object that represent the producer of the movie. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! RequiresPin | ! RequiresPin | ||
{{!}} bool | {{!}} bool | ||
| − | {{!}} | + | {{!}} Set if the PIN is necessary to access the movie and playback. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
| Line 104: | Line 104: | ||
! SeasonId | ! SeasonId | ||
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} If a movie is a part of Season (an Episode), the season id gonna come here to indicate which season's parent. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! SeriesId | ! SeriesId | ||
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} If a movie is a part of Series (an Season), the series id gonna come here to indicate which season's parent. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! ShortDescription | ! ShortDescription | ||
{{!}} String | {{!}} String | ||
| − | {{!}} | + | {{!}} A short description about the movie. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Stars | ! Stars | ||
{{!}} double | {{!}} double | ||
| − | {{!}} | + | {{!}} The average of rating stars all user classify a movie. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Subtitles | ! Subtitles | ||
{{!}} [[Subtitle]] | {{!}} [[Subtitle]] | ||
| − | {{!}} | + | {{!}} Array of [[Subtitle]] object. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Title | ! Title | ||
{{!}} String | {{!}} String | ||
| − | {{!}} | + | {{!}} A string that represent a name of the movie. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Type | ! Type | ||
| − | {{!}} MovieType | + | {{!}} [[MovieType]] |
| − | {{!}} | + | {{!}} Enumerate that represents a kind of movie is the content. It can be |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Views | ! Views | ||
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} Number of view the content has been visualised. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
! Year | ! Year | ||
{{!}} int | {{!}} int | ||
| − | {{!}} | + | {{!}} A year of the movie. |
{{!}}- valign="top" | {{!}}- valign="top" | ||
Revision as of 20:34, 3 September 2014
SimpleMovie is an object that represent a Movie registered in the platform to get all data information about a movie. Similar to Movie object, this method doesn't has user data information as CanWatch o Access rights, so this object is a bit more fast then Movie object when return in method.
Members
| Field | Data Type | Description |
|---|---|---|
| AgeRating | InstanceAgeRating | An object that contains all information about the ageRatings of the movie returned. |
| AvailableForThisDevice | bool | Set if the movie is available for the device from the currently request (device logged for the request). |
| AvailableForThisDeviceInHD | bool | Set if the movie is available for the device in HD mode in currently request (device logged for the request). |
| AvailableForThisDeviceInSD | bool | Set if the movie is available for the device in SD mode in currently request (device logged for the request). |
| ChildrenCount | int | |
| CommercializationType | CommercializationType | An object represented by a number type (enumeration) that represent a type as the product is commercialised. |
| Distributor | Distributor | An object represented by a number type (enumeration) that represent a type as the product is distributed. |
| Duration | int | A number that represent the time duration of the movie expressed in seconds. |
| Genres | Genre | An object that contains an array of Genre object assigned to movie. |
| ID | int | A unique identifier for the movie |
| Images | Array of Image | Array of Image object registered in the platform. |
| IsDtp | bool | Set if the movie is available to be downloaded and play offline. |
| Medias | Media | Array of Media object that contains a series of information about the movie's media. |
| OrderEpisode | int | Set the episode order that wants to be returned the content. |
| PlaybackAccess | PlaybackRight | A number that indicate a kind of right the user has rights access. |
| Producer | Producer | An object that represent the producer of the movie. |
| RequiresPin | bool | Set if the PIN is necessary to access the movie and playback. |
| ResizableImages | Array of Image | |
| SeasonId | int | If a movie is a part of Season (an Episode), the season id gonna come here to indicate which season's parent. |
| SeriesId | int | If a movie is a part of Series (an Season), the series id gonna come here to indicate which season's parent. |
| ShortDescription | String | A short description about the movie. |
| Stars | double | The average of rating stars all user classify a movie. |
| Subtitles | Subtitle | Array of Subtitle object. |
| Title | String | A string that represent a name of the movie. |
| Type | MovieType | Enumerate that represents a kind of movie is the content. It can be |
| Views | int | Number of view the content has been visualised. |
| Year | int | A year of the movie. |
Example
{
- "ID": 13939,
- "SeriesId": 0,
- "SeasonId": 0,
- "Type": 1,
- "Title": "_Bem-vindo ao canal Adulto",
- "Duration": 60,
- "Year": 0,
- "AgeRating": {
- AgeRating object
- },
- "Subtitles": [
- Array of Subtitle object
- ],
- "Genres": [
- Array of Genre objects
- ],
- "Stars": 2.81818181818182,
- "Views": 235,
- "ShortDescription": "Bem-vindo ao canal ...",
- "Images": [
- Array of Image object
- ],
- "ResizableImages": [
- Array of Image object
- ],
- "RequiresPin": true,
- "ChildrenCount": 0,
- "Medias": [
- Array of Media
- ],
- "AvailableForThisDevice": true,
- "AvailableForThisDeviceInHD": true,
- "AvailableForThisDeviceInSD": true,
- "OrderEpisode": 0,
- "PlaybackAccess": 2,
- "IsDtp": false,
- "Distributor": {
- Distributor object
- },
- "CommercializationType": 4,
- "Producer": {
- }
}
Known issues
None
Version history
| API Version Number | Change description | Changes author |
|---|---|---|
| 1.0 | Initial data type implementation | Harley Cabral |
