editor
278
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description= Delete each of the given Schedule Recording from the platform. If the external platform provides a Network PVR service, this method will remove co..."
{{Api_Method_Spec|
Description= Delete each of the given Schedule Recording from the platform. If the external platform provides a Network PVR service, this method will remove contents accessible by the network. In the case of Remote PVR service availability, this method will physically delete contents from the connected STB hard disk.
Returns an array of [[RecordingSchedule|RecordingSchedule]] objects, filled with the recording related parameters:
*If the recording was successfully deleted by the platform, its state will be "Deleted"
*If a given recording could not be deleted, its state will remain "Recorded".
*If a given recording was not found, its state will be "Not Found".
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
{{Api_Parameter|
ParamName=recordingScheduleId
|ParamType=int
|ParamRequired=required
|ParamDescription=ID of the Recording Schedule to be canceled
}}
{{Api_Parameter|
ParamName=programId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Program ID
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Channel ID
}}
{{Api_Parameter|
ParamName=serieId
|ParamType=int
|ParamRequired=optional
|ParamDescription=ID of the series associated to the schedule. Value will be set to 0 if the program is not a series episode.
}}
{{Api_Parameter|
ParamName=entireSeries
|ParamType=bool
|ParamRequired=optional (default=false)
|ParamDescription=If the Schedule Id is a series episode, all the next episodes should also be scheduled for recording when set to true. If set to false, only the single episode will be scheduled.
}}
|Returns=
Returns a JSON object with a list of [[RecordingSchedule|RecordingSchedule]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
}
|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"
! 2.4
{{!}} Initial method design
{{!}}
{{!}}}
|SeeAlso=
* [[RecordingSchedule|RecordingSchedule]] object type
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] methods
}}
Description= Delete each of the given Schedule Recording from the platform. If the external platform provides a Network PVR service, this method will remove contents accessible by the network. In the case of Remote PVR service availability, this method will physically delete contents from the connected STB hard disk.
Returns an array of [[RecordingSchedule|RecordingSchedule]] objects, filled with the recording related parameters:
*If the recording was successfully deleted by the platform, its state will be "Deleted"
*If a given recording could not be deleted, its state will remain "Recorded".
*If a given recording was not found, its state will be "Not Found".
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context and logged user.
}}
{{Api_Parameter|
ParamName=recordingScheduleId
|ParamType=int
|ParamRequired=required
|ParamDescription=ID of the Recording Schedule to be canceled
}}
{{Api_Parameter|
ParamName=programId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Program ID
}}
{{Api_Parameter|
ParamName=channelId
|ParamType=int
|ParamRequired=required
|ParamDescription=Live Channel ID
}}
{{Api_Parameter|
ParamName=serieId
|ParamType=int
|ParamRequired=optional
|ParamDescription=ID of the series associated to the schedule. Value will be set to 0 if the program is not a series episode.
}}
{{Api_Parameter|
ParamName=entireSeries
|ParamType=bool
|ParamRequired=optional (default=false)
|ParamDescription=If the Schedule Id is a series episode, all the next episodes should also be scheduled for recording when set to true. If set to false, only the single episode will be scheduled.
}}
|Returns=
Returns a JSON object with a list of [[RecordingSchedule|RecordingSchedule]].
'''Example:'''
{
: "Offset": 0,
: "Limit": 10,
: "Count": 48,
: [ Array of [[RecordingSchedule|RecordingSchedule]] objects ]
}
|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"
! 2.4
{{!}} Initial method design
{{!}}
{{!}}}
|SeeAlso=
* [[RecordingSchedule|RecordingSchedule]] object type
* [[UNIAPI_Specification#Network_Pvr_Service|Network_Pvr_Service]] methods
}}
