Changes

Jump to navigation Jump to search
no edit summary
{{Api_Method_Spec|
Description= Deletes the provided Recording Schedule (ID). This method is mainly intended for deleting recordings ("child recordings") from the user's STB, although it is also allowed (depending on the backend) to delete RecordingDefinition ("parent recording" or "recording definition") from the platform.
Returns an array of [[RecordingSchedule|RecordingSchedule]] objects, filled with the results and status parameters.
<p>* '''Mediaroom comments''':</p>
* The Mediaroom API DeleteRecordingSchedules is intended for deleting individual (RemoveRecordingDefinition) method removes a recording definition (the equivalent concept to a [[RecordingSchedule|RecordingSchedule]]"child"), and all associated upcoming recordings, from an accountexisting in the user's schedule.​ The behavior of STB, but not cancelling or deleting the method depends on whether there are recordings already associated with this recording whole definition:(RecordingDefinition).<ul> <li>If there are no recordings associated with this definition Clients must invoke DeleteRecordingSchedule sending the id of the Recording (there are no matching programs not RecordingDefinition in the current EPG datacase of Mediaroom), to delete within the recording definition is deletedrecordingScheduleId.</li> <li>If several recordings must be deleted, client will have already been made, to request it through sequential requests (one by one)Since the existing recordings are kept, but the recording definition's state behavior of DeleteRecordingSchedule in Mediaroom is set "to "cancelled," preventing any future remove the completed recordings from being made. After all existing recordings have been deleted, on the recording definition is automatically deleted.</li> <li>If a recording is currently in progressSTB", it is halted. The recording definition's state is also set does not make sense to "cancelled," preventing future recordings from being made. Again, after all existing recordings have been deleted, request the recording definition is automatically deleted.</li></ul>* In the [[RecordingSchedule|RecordingSchedule]] object handled by GVP (returned to clients)deletion of a whole series, the status would be set to the state "Cancelled" ​(as this state includes both "cancelled" and "deleted" schedules that so method will be the states managed by return an error if it is invoked requesting an entireSeries deletion in Mediaroom when invoking RemoveRecordingDefinition).
|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. Deletion of series is not allowed in all backends.
}}
{{Api_Parameter|
|ParamType=string
|ParamRequired=optional (declared "optional" for backwards compatibility; but needed for correct operation)
|ParamDescription=ID (string) of the Recording Schedule to be deleted
}}
{{Api_Parameter|
editor
278

edits

Navigation menu