Difference between revisions of "UserTags"

From Gvp-public
Jump to navigation Jump to search
Line 12: Line 12:
  
  
−
! AgeRating
+
! TagValue
−
{{!}} [[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
 
{{!}} int
−
{{!}}  
+
{{!}} Movie ID (in the case of series it will be the ID of the "movie" object -of series type- referring the whole series)
−
{{!}}- valign="top"
 
−
 
 
−
! CommercializationType
 
−
{{!}} [[CommercializationType]]
 
−
{{!}} An enumeration represented by a number that represent a type as the product is commercialised.
 
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! Distributor
+
! TagType
−
{{!}} [[Distributor]]
+
{{!}} Array of [TagType]
−
{{!}} An object that contains information about the distributor.
+
{{!}} Array of tags "active" for the object (for example, a movie may have tags "''watched''" + "''completed''" + "''favorite''")
 
{{!}}- valign="top"
 
{{!}}- valign="top"
  
−
! Duration
+
! ResumeValue
 
{{!}} int
 
{{!}} int
−
{{!}} A number that represent the time duration of the movie expressed in seconds.
+
{{!}} It will contain the resume time value (for objects with "watched" started but not totally "completed"), or "-1" if completed.
−
{{!}}- valign="top"
+
:* if the object is a movie, it will contain the resume value of the movie
−
 
+
:* if the object is a series, it will contain the resume value for the "next episode" (the next episode will be returned in the SimpleMovie object)
−
! Genres
+
:* if the "resume value" for a "not completed" content is not available (since MongoDB only stores resume data for a limited set of contents), it will return "0" as the resume value (indicating not available)
−
{{!}} [[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"
 
{{!}}- valign="top"
  
−
! ResizableImages
+
! TaggedContent
−
{{!}} Array of [[Image]]
+
{{!}} [SimpleMovie]
 
{{!}}  
 
{{!}}  
−
{{!}}- valign="top"
+
:* For individual movies, it will contain the SimpleMovie object for the requested tag/ID
−
 
+
:* In the case of series, it will contain the SimpleMovie object for the "next episode", according to this logic: Check for all available episodes to find the highest Season and Episode already watched (completed or resume):
−
! SeasonId
+
::* if episode is in "resume" (watched), that episode is returned as "next"
−
{{!}} int
+
::* if episode is "completed", it returns the next available episode (next one within season or first one of next season)
−
{{!}} If a movie is a part of Season (an Episode), the season id gonna come here to indicate which season's parent.
+
::* if there is not available (new) episode, it does not return anything (Series Completed; meaning that series is completed so far)
−
{{!}}- valign="top"
+
::* if there is not any episode already watched, it returns the available episode with highest Season and Episode
−
 
+
::*etc
−
! 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"
 
{{!}}- valign="top"
  

Revision as of 16:28, 2 February 2015

UserTags are structured objects used to represent contents (movies, series...) along with their tags (watched, completed, favorite, etc.). This struct is a key object in the MyTv features, which shows lists of tagged user contents

Members

Field Data Type Description
TagValue int Movie ID (in the case of series it will be the ID of the "movie" object -of series type- referring the whole series)
TagType Array of [TagType] Array of tags "active" for the object (for example, a movie may have tags "watched" + "completed" + "favorite")
ResumeValue int It will contain the resume time value (for objects with "watched" started but not totally "completed"), or "-1" if completed.
  • if the object is a movie, it will contain the resume value of the movie
  • if the object is a series, it will contain the resume value for the "next episode" (the next episode will be returned in the SimpleMovie object)
  • if the "resume value" for a "not completed" content is not available (since MongoDB only stores resume data for a limited set of contents), it will return "0" as the resume value (indicating not available)
TaggedContent [SimpleMovie]
  • For individual movies, it will contain the SimpleMovie object for the requested tag/ID
  • In the case of series, it will contain the SimpleMovie object for the "next episode", according to this logic: Check for all available episodes to find the highest Season and Episode already watched (completed or resume):
  • if episode is in "resume" (watched), that episode is returned as "next"
  • if episode is "completed", it returns the next available episode (next one within season or first one of next season)
  • if there is not available (new) episode, it does not return anything (Series Completed; meaning that series is completed so far)
  • if there is not any episode already watched, it returns the available episode with highest Season and Episode
  • etc


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=986"