Class for update schedule requests. More...

Inheritance diagram for dvblinkremote::UpdateScheduleRequest:

Public Member Functions
	UpdateScheduleRequest (const std::string &scheduleId, const bool newOnly, const bool recordSeriesAnytime, const int recordingsToKeep)
	Initializes a new instance of the dvblinkremote::UpdateScheduleRequest class.
	~UpdateScheduleRequest ()
	Destructor for cleaning up allocated memory.
std::string &	GetScheduleID ()
	Gets the identifier for the schedule to be updated.
bool	IsNewOnly ()
	Gets if only new programs are going to be recorded for the schedule to be updated or not.
bool	WillRecordSeriesAnytime ()
	Gets whether to record only series starting around original program start time or any of them for the schedule to be updated.
int	GetRecordingsToKeep ()
	Gets how many recordings to keep for a repeated recording.

Detailed Description

Class for update schedule requests.

This is used as input parameter for the IDVBLinkRemoteConnection::UpdateSchedule method.

Constructor & Destructor Documentation

dvblinkremote::UpdateScheduleRequest::UpdateScheduleRequest	(	const std::string &	scheduleId,
		const bool	newOnly,
		const bool	recordSeriesAnytime,
		const int	recordingsToKeep
	)

Initializes a new instance of the dvblinkremote::UpdateScheduleRequest class.

Parameters

scheduleId	a constant string reference representing the schedule identifier.
newOnly	a constant boolean representing if only new programs have to be recorded. Default value is `false`.
recordSeriesAnytime	a constant boolean representing whether to record only series starting around original program start time or any of them. Default value is `false`.
recordingsToKeep	a constant integer representing how many recordings to keep for a repeated recording. Default value is `0`, i.e. keep all recordings.

Remarks: recordingsToKeep accepted values (1, 2, 3, 4, 5, 6, 7, 10; 0 - keep all)

dvblinkremote::UpdateScheduleRequest::~UpdateScheduleRequest ( )

Destructor for cleaning up allocated memory.

int dvblinkremote::UpdateScheduleRequest::GetRecordingsToKeep ( )

Gets how many recordings to keep for a repeated recording.

std::string& dvblinkremote::UpdateScheduleRequest::GetScheduleID ( )

Gets the identifier for the schedule to be updated.

bool dvblinkremote::UpdateScheduleRequest::IsNewOnly ( )

Gets if only new programs are going to be recorded for the schedule to be updated or not.

bool dvblinkremote::UpdateScheduleRequest::WillRecordSeriesAnytime ( )

Gets whether to record only series starting around original program start time or any of them for the schedule to be updated.