Difference between revisions of "UserTags"

From Gvp-public
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Api_DataType_Spec
 
{{Api_DataType_Spec
−
|Description=UserTags are structured objects representing contents (movies, series...), along with their associated tags (watched, completed, favorite, etc.) and ''resume'' (playback) info. This struct is the main object for many of the MyTv features, showing lists of tagged user contents
+
|Description=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 and Access rights, so this object is a bit more fast then Movie object when return in method.
 +
 
 +
|Members=
 +
{{{!}}  border="2" style="width:800px"  cellspacing="0" cellpadding="10"
 +
 
 +
{{!}}- style="background:#88ccff;font-size:110%"
 +
! Field
 +
! Data Type
 +
! Description
 +
{{!}}- valign="top"
 +
 
 +
 
 +
! AgeRating
 +
{{!}} [[InstanceAgeRating]]
 +
{{!}} An object that contains all information about the ageRatings of the movie returned.
 +
{{!}}- valign="top"
 +
 
 +
! AvailableForThisDevice
 +
{{!}} bool
 +
{{!}} Set if the movie is available for the device from the currently request (device logged for the request).
 +
{{!}}- valign="top"
 +
 
 +
! AvailableForThisDeviceInHD
 +
{{!}} bool
 +
{{!}} Set if the movie is available for the device in HD mode in currently request (device logged for the request).
 +
{{!}}- valign="top"
 +
 
 +
! AvailableForThisDeviceInSD
 +
{{!}} bool
 +
{{!}} Set if the movie is available for the device in SD mode in currently request (device logged for the request).
 +
{{!}}- valign="top"
 +
 
 +
! ChildrenCount
 +
{{!}} int
 +
{{!}}
 +
{{!}}- valign="top"
 +
 
 +
! CommercializationType
 +
{{!}} [[CommercializationType]]
 +
{{!}} An enumeration represented by a number that represent a type as the product is commercialised.
 +
{{!}}- valign="top"
 +
 
 +
! Distributor
 +
{{!}} [[Distributor]]
 +
{{!}} An object that contains information about the distributor.
 +
{{!}}- valign="top"
 +
 
 +
! Duration
 +
{{!}} int
 +
{{!}} A number that represent the time duration of the movie expressed in seconds.
 +
{{!}}- valign="top"
 +
 
 +
! Genres
 +
{{!}} [[Genre]]
 +
{{!}} An object that contains an array of [[Genre]] object assigned to movie.
 +
{{!}}- valign="top"
 +
 
 +
! ID
 +
{{!}} int
 +
{{!}} A unique identifier for the movie
 +
{{!}}- valign="top"
 +
 
 +
! Images
 +
{{!}} Array of [[Image]]
 +
{{!}} Array of [[Image]] object registered in the platform.
 +
{{!}}- valign="top"
 +
 
 +
! IsDtp
 +
{{!}} bool
 +
{{!}} Set if the movie is available to be downloaded and play offline.
 +
{{!}}- valign="top"
 +
 
 +
! Medias
 +
{{!}} [[Media]]
 +
{{!}} Array of [[Media]] object that contains a series of information about the movie's media.
 +
{{!}}- valign="top"
 +
 
 +
! OrderEpisode
 +
{{!}} int
 +
{{!}} Set the episode order that wants to be returned the content.
 +
{{!}}- valign="top"
 +
 
 +
! PlaybackAccess
 +
{{!}} [[PlaybackRight]]
 +
{{!}} A number that indicate a kind of right the user has rights access.
 +
{{!}}- valign="top"
 +
 
 +
! Producer
 +
{{!}} [[Producer]]
 +
{{!}} An object that represent the producer of the movie.
 +
{{!}}- valign="top"
 +
 
 +
! RequiresPin
 +
{{!}} bool
 +
{{!}} Set if the PIN is necessary to access the movie and playback.
 +
{{!}}- valign="top"
 +
 
 +
! ResizableImages
 +
{{!}} Array of [[Image]]
 +
{{!}}
 +
{{!}}- valign="top"
 +
 
 +
! SeasonId
 +
{{!}} 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"
 +
 
 +
! SeasonNumber
 +
{{!}} int
 +
{{!}} bgcolor="#00FF00" {{!}} '''PROPOSED FOR 3.0'''. If a movie is a part of Season (an Episode), it contains the season number.
 +
{{!}}- valign="top"
 +
 
 +
! SeriesId
 +
{{!}} 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"
 +
 
 +
! SeriesName
 +
{{!}} String
 +
{{!}} bgcolor="#00FF00" {{!}} '''PROPOSED FOR 3.0'''. If a movie is a part of Series (an Season), it contains the series name
 +
{{!}}- valign="top"
 +
 
 +
! ShortDescription
 +
{{!}} String
 +
{{!}} A short description about the movie.
 +
{{!}}- valign="top"
 +
 
 +
! Stars
 +
{{!}} double
 +
{{!}} The average of rating stars all user classify a movie.
 +
{{!}}- valign="top"
 +
 
 +
! Subtitles
 +
{{!}} [[Subtitle]]
 +
{{!}} Array of [[Subtitle]] object.
 +
{{!}}- valign="top"
 +
 
 +
! Title
 +
{{!}} String
 +
{{!}} A string that represent a name of the movie.
 +
{{!}}- valign="top"
 +
 
 +
! Type
 +
{{!}} [[MovieType]]
 +
{{!}} Enumerate that represents a kind of movie is the content. It can be
 +
{{!}}- valign="top"
 +
 
 +
! Views
 +
{{!}} int
 +
{{!}} Number of view the content has been visualised.
 +
{{!}}- valign="top"
 +
 
 +
! Year
 +
{{!}} int
 +
{{!}} A year of the movie.
 +
{{!}}- valign="top"
 +
 
 +
{{!}}}
 +
 
 +
 
 +
|Example=
 +
 
 +
{
 +
:        "ID": 13939,
 +
:        "SeriesId": 0,
 +
:        "SeriesName": "",
 +
:        "SeasonId": 0,
 +
:        "SeasonNumber": 0,
 +
:        "Type": 1,
 +
:        "Title": "_Bem-vindo ao canal Adulto",
 +
:        "Duration": 60,
 +
:        "Year": 0,
 +
:        "AgeRating": {
 +
::          [[InstanceAgeRating]] 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": {
 +
::          [[Producer]]
 +
:        }
 +
}
  
  

Revision as of 16:20, 2 February 2015

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 and 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 enumeration represented by a number that represent a type as the product is commercialised.
Distributor Distributor An object that contains information about the distributor.
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.
SeasonNumber int PROPOSED FOR 3.0. If a movie is a part of Season (an Episode), it contains the season number.
SeriesId int If a movie is a part of Series (an Season), the series id gonna come here to indicate which season's parent.
SeriesName String PROPOSED FOR 3.0. If a movie is a part of Series (an Season), it contains the series name
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,
"SeriesName": "",
"SeasonId": 0,
"SeasonNumber": 0,
"Type": 1,
"Title": "_Bem-vindo ao canal Adulto",
"Duration": 60,
"Year": 0,
"AgeRating": {
InstanceAgeRating 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": {
Producer
}

}


Known issues

None


Version history

API Version Number Change description Changes author
1.0 Initial data type implementation Harley Cabral


See also

Retrieved from "https://wikis.tid.es/gvp-public/index.php?title=UserTags&oldid=982"