Difference between revisions of "UserTags"
Jump to navigation
Jump to search
Line 29: | Line 29: | ||
! ResumeValue | ! ResumeValue | ||
{{!}} int | {{!}} int | ||
− | {{!}} It will contain the resume time value (for objects with "watched" started but not totally "completed"), or "-1" if completed | + | {{!}} It will contain the resume time value (for objects with "watched" started but not totally "completed"), or "-1" if completed (all contents with "completed" tag will be set to resumeValue=-1) |
:* if the object is a movie, it will contain the resume value of the movie | :* if the object is a movie, it will contain the resume value of the movie | ||
:* if the object is a series (or season), it will contain the resume value for the "next episode" (the next episode will be returned in the SimpleMovie object) | :* if the object is a series (or season), it will contain the resume value for the "next episode" (the next episode will be returned in the SimpleMovie object) | ||
:* If the content (for example in the case of an episode within series) does not have "watched" tag, it will return "0" (playback not started) | :* If the content (for example in the case of an episode within series) does not have "watched" tag, it will return "0" (playback not started) | ||
− | |||
{{!}}- valign="top" | {{!}}- valign="top" | ||
Revision as of 15:43, 25 March 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 |
---|---|---|
UserId | int | User ID from the user logged. |
TaggedContentID | int | Movie ID (in the case of series -follow-up feature- it will be the ID of the "movie" object -of series type- referring the whole series, not the ID of the SimpleMovie returned "below" in the TaggedContent) |
Tags | Array of Tag | Array of tags for the object (for example, a movie may have tags "watched (3)" (true) + "completed (6)" (true)), including the creation date |
ResumeValue | int | It will contain the resume time value (for objects with "watched" started but not totally "completed"), or "-1" if completed (all contents with "completed" tag will be set to resumeValue=-1)
|
TaggedContent | SimpleMovie |
|
Example
{
- UserId: 1537,
- TaggedContentID: movieID001,
- Tags: [
- Array of Tag
- ],
- ResumeValue: -1 (already "completed'"),
- TaggedContent: SimpleMovie object
- },
- {
- UserId: 1537,
- TaggedContentID: movieID008,
- Tags: [
- Array of Tag
- ],
- ResumeValue: 43154 (int) (represents the time already watched),
- TaggedContent: SimpleMovie object
}
Known issues
None
Version history
API Version Number | Change description | Changes author |
---|---|---|
3.0 | Initial data type implementation | Jose A. Jiménez |