Difference between revisions of "UserTags"

From Gvp-public
Jump to navigation Jump to search
Line 18: Line 18:
  
 
! TagType
 
! TagType
−
{{!}} Array of [TagType]
+
{{!}} Array of [[TagType]]
 
{{!}} Array of tags "active" for the object (for example, a movie may have tags "''watched''" + "''completed''" + "''favorite''")
 
{{!}} Array of tags "active" for the object (for example, a movie may have tags "''watched''" + "''completed''" + "''favorite''")
 
{{!}}- valign="top"
 
{{!}}- valign="top"
Line 31: Line 31:
  
 
! TaggedContent
 
! TaggedContent
−
{{!}} [SimpleMovie]
+
{{!}} [[SimpleMovie]]
 
{{!}}  
 
{{!}}  
 
:* For individual movies, it will contain the SimpleMovie object for the requested tag/ID
 
:* For individual movies, it will contain the SimpleMovie object for the requested tag/ID
Line 48: Line 48:
  
 
{
 
{
−
:        "ID": 13939,
+
"Offset": 0,
−
:        "SeriesId": 0,
+
"Limit": 100,
−
:        "SeriesName": "",
+
"Count": 2,
−
:        "SeasonId": 0,
+
"List":
−
:       "SeasonNumber": 0,
+
:{
−
:       "Type": 1,
+
:TagValue: movieID001,
−
:       "Title": "_Bem-vindo ao canal Adulto",
+
:TagType: [3 ('"''watched''"), 6 ("''completed''")],
−
:       "Duration": 60,
+
:ResumeValue: -1 (''already "completed'"''),
−
:       "Year": 0,
+
:SimpleMovie:  
−
:       "AgeRating": {
+
::{
−
::           [[InstanceAgeRating]] object
+
::Title: XXX,
−
:       },
+
::SeriesName: (string)
−
:       "Subtitles": [
+
::SeasonName: (string),
−
::           Array of [[Subtitle]] object
+
::SeasonNumber: (int),
−
:       ],
+
::Duration: (int),
−
:       "Genres": [
+
::….
−
::          Array of [[Genre]] objects
+
::}
−
:       ],
+
:}
−
:       "Stars": 2.81818181818182,
+
:{
−
:       "Views": 235,
+
:TagValue: movieID008,
−
:       "ShortDescription": "Bem-vindo ao canal ...",
+
:TagType: [3 ("''watched''")],
−
:       "Images": [
+
:ResumeValue: 43154 (int) ''(represents the time already watched)'',
−
::          Array of [[Image]] object
+
:SimpleMovie:  
−
:       ],
+
::{
−
:       "ResizableImages": [
+
::Title: XXX,
−
::         Array of [[Image]] object
+
::SeriesName: (string)
−
:        ],
+
::SeasonName: (string),
−
:       "RequiresPin": true,
+
::SeasonNumber: (int),
−
:       "ChildrenCount": 0,
+
::Duration: (int),
−
:       "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:29, 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

{ "Offset": 0, "Limit": 100, "Count": 2, "List":

{
TagValue: movieID001,
TagType: [3 ('"watched"), 6 ("completed")],
ResumeValue: -1 (already "completed'"),
SimpleMovie:
{
Title: XXX,
SeriesName: (string)
SeasonName: (string),
SeasonNumber: (int),
Duration: (int),
….
}
}
{
TagValue: movieID008,
TagType: [3 ("watched")],
ResumeValue: 43154 (int) (represents the time already watched),
SimpleMovie:
{
Title: XXX,
SeriesName: (string)
SeasonName: (string),
SeasonNumber: (int),
Duration: (int),
….
}
}

}


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