Difference between revisions of "Blender Specification"

From Gvp-public
Jump to navigation Jump to search
 
(8 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
=== GetUserTimestamp ===
 
=== GetUserTimestamp ===
 
=== GetUserServices ===
 
=== GetUserServices ===
=== GetItemsTags (25.3) ===
+
=== [[GetItemsTags_(Blender)]] (25.3) ====
 
 
{{Api_Method_Spec|
 
Description=Get a list of [[ItemTags]] objects,
 
 
 
The user should be logged to use this method.
 
 
 
|Parameters=
 
{{Api_Parameter|
 
ParamName=token
 
|ParamType=String
 
|ParamRequired=required
 
|ParamDescription=A valid token for identifying the API session context. Anonymous access is not allowed.
 
}}
 
{{Api_Parameter|
 
ParamName=offset
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=Index of the initial result of the list, begins with 0
 
}}
 
{{Api_Parameter|
 
ParamName=limit
 
|ParamType=int
 
|ParamRequired=optional
 
|ParamDescription=Quantity of results showed, with the maximum of 100
 
}}
 
{{Api_Parameter|
 
ParamName=ItemTypeFilter
 
|ParamType=[[ItemType]] (int)
 
|ParamRequired=optional
 
|ParamDescription=Defines a [[ItemType]] filter, to filter the results depending on the movie type value.
 
}}
 
{{Api_Parameter|
 
ParamName=adultFilter
 
|ParamType=[[AdultFilterType]] (int)
 
|ParamRequired=optional
 
|ParamDescription=[[AdultFilterType]] enum to filter the result required. The default value is NonAdultOnly.
 
}}
 
{{Api_Parameter|
 
ParamName=tagType
 
|ParamType=Array of [[TagType]]
 
|ParamRequired=optional
 
|ParamDescription=Allows to filter the tag results depending on the TagType. The operator is able to introduce a comma separated list of TagTypes. Contents having ANY (OR operator) of the tags will be included in results.
 
}}
 
{{Api_Parameter|
 
ParamName=ItemIds
 
|ParamType=List of comma separated values of ItemIds
 
|ParamRequired=optional
 
|ParamDescription=Allows to filter the results depending on the Movie IDs (Comma separated list). It can only be used if one specific ItemType is selected (to avoid collisions)
 
}}
 
 
 
 
|Returns=
 
Returns a JSON object containing an array of [[ItemTags]]
 
 
 
'''Objects are sorted by the most recent date of (any) tag creation'''. This is: the first item to be returned will be the movie with the most recent tag "event".
 
 
 
'''Example:'''
 
 
 
{
 
:    <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
 
:    <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
 
:    <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
 
:    <span style="color: #a11;">"List"</span>:
 
::    [ <span style="color: #219;">Array of [[ItemTags]] objects</span> ]
 
}
 
 
 
 
 
|Exceptions=
 
* [[AuthenticationRequiredException]]
 
 
 
 
 
|Cache=
 
This method is cached based on the Tag timestamp of the user
 
 
 
|KnownIssues=
 
* None
 
 
 
|VersionHistory=
 
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
 
{{!}}-  style="background:#88ccff;font-size:110%"
 
! API Version Number
 
! Change description
 
! Changes author
 
{{!}}- valign="top"
 
! 3.0
 
{{!}} Initial method design
 
{{!}} Jose Manuel Escartín
 
{{!}}}
 
 
 
|SeeAlso=
 
}}
 
  
 
=== TagItem (25.3) ===
 
=== TagItem (25.3) ===
Line 120: Line 29:
 
=== PlaybackHeartbeatRecording ===
 
=== PlaybackHeartbeatRecording ===
 
=== SetItemResumeData ===
 
=== SetItemResumeData ===
=== GetMediaUrlStb (25.4) ===
+
=== [[GetMediaUrlStb_(Blender)]] (25.4) ===
=== GetMediaUrlsStb (25.4) ===
+
=== [[GetMediaUrlsStb_(Blender)]] (25.4) ===
 +
=== [[HbVod_(Blender)]] (25.4) ===
 +
=== [[HbLive_(Blender)]] (25.4) ===
 +
=== [[HbRecording_(Blender)]] (25.4) ===
  
 
== EventService ==
 
== EventService ==

Latest revision as of 13:43, 12 May 2025

UserService

GetUserTimestamps

GetUserTimestamp

GetUserServices

GetItemsTags_(Blender) (25.3) =

TagItem (25.3)

UntagItem (25.3)

TimeService

GetTime

EpgService

GetPersonalLiveChannelContents

GetPersonalLiveChannels

InstanceParameterService

GetKeyValues

GetFutSettings

PlaybackService

PlaybackHeartBeatLive

PlaybackHeartBeatVod

GetUserItemsResumeData

SetMovieResumeData

GetMovieResumeData

PlaybackHeartbeatRecording

SetItemResumeData

GetMediaUrlStb_(Blender) (25.4)

GetMediaUrlsStb_(Blender) (25.4)

HbVod_(Blender) (25.4)

HbLive_(Blender) (25.4)

HbRecording_(Blender) (25.4)

EventService

AddEventBatch

RegistrationService

SetMinimumAgeRating

AuthenticationService

LoginAnonymous (25.3)