Difference between revisions of "UserTags"

From Gvp-public
Jump to navigation Jump to search
(Created page with "{{Api_DataType_Spec |Description=UserTags are structured objects representing contents (movies, series...), along with their associated tags (watched, completed, favorite, etc...")
(No difference)

Revision as of 16:18, 2 February 2015

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

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

Members

{{{Members}}}


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