Bureaucrats, editor
349
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Set the resume information for the item playback of the user. This information is used to set on the GVP the exactly time watched by the user sh..."
{{Api_Method_Spec|
Description=Set the resume information for the item playback of the user. This information is used to set on the GVP the exactly time watched by the user should be storage on the platform. This feature allow the client application restart the reproduction from the moment that he stopped.
This method has two optional parameter that can be used to storage the currently subtitle and audio. This information is taken from the Movie object in his moment.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=ItemId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of the resume information
}}
{{Api_Parameter|
ParamName=ItemType
|ParamType=[[ItemTypeId]]
|ParamRequired=required
|ParamDescription=ItemType
}}
{{Api_Parameter|
ParamName=time
|ParamType=int
|ParamRequired=required
|ParamDescription=Current playback time in seconds (optional) (-1 when the movie is ended)
}}
{{Api_Parameter|
ParamName= subtitleCode
|ParamType=String
|ParamRequired=optional
|ParamDescription= Current Subtitle Language Code ISO-639-2
}}
{{Api_Parameter|
ParamName= audioCode
|ParamType=String
|ParamRequired=optional
|ParamDescription= Current Audio Language Code ISO-639-2
}}
|Returns=
Returns a JSON object containing true if change was made, false if no change was made.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>: true
}
|Exceptions=
* None
|Cache=
This method is not cached.
|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"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
Description=Set the resume information for the item playback of the user. This information is used to set on the GVP the exactly time watched by the user should be storage on the platform. This feature allow the client application restart the reproduction from the moment that he stopped.
This method has two optional parameter that can be used to storage the currently subtitle and audio. This information is taken from the Movie object in his moment.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=ItemId
|ParamType=int
|ParamRequired=required
|ParamDescription=Id of the resume information
}}
{{Api_Parameter|
ParamName=ItemType
|ParamType=[[ItemTypeId]]
|ParamRequired=required
|ParamDescription=ItemType
}}
{{Api_Parameter|
ParamName=time
|ParamType=int
|ParamRequired=required
|ParamDescription=Current playback time in seconds (optional) (-1 when the movie is ended)
}}
{{Api_Parameter|
ParamName= subtitleCode
|ParamType=String
|ParamRequired=optional
|ParamDescription= Current Subtitle Language Code ISO-639-2
}}
{{Api_Parameter|
ParamName= audioCode
|ParamType=String
|ParamRequired=optional
|ParamDescription= Current Audio Language Code ISO-639-2
}}
|Returns=
Returns a JSON object containing true if change was made, false if no change was made.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>: true
}
|Exceptions=
* None
|Cache=
This method is not cached.
|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"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
