| DVBLink Remote API Library documentation
    0.2.0-Master
    | 
Class for add schedule by electronic program guide (EPG) requests. More...
 
  
 | Public Member Functions | |
| AddScheduleByEpgRequest (const std::string &channelId, const std::string &programId, const bool repeat=false, const bool newOnly=false, const bool recordSeriesAnytime=false) | |
| Initializes a new instance of the dvblinkremote::AddScheduleByEpgRequest class. | |
| ~AddScheduleByEpgRequest () | |
| Destructor for cleaning up allocated memory. | |
|  Public Member Functions inherited from dvblinkremote::EpgSchedule | |
| EpgSchedule (const std::string &channelId, const std::string &programId, const bool repeat=false, const bool newOnly=false, const bool recordSeriesAnytime=false) | |
| Initializes a new instance of the dvblinkremote::EpgSchedule class. | |
| EpgSchedule (const std::string &id, const std::string &channelId, const std::string &programId, const bool repeat=false, const bool newOnly=false, const bool recordSeriesAnytime=false) | |
| Initializes a new instance of the dvblinkremote::EpgSchedule class. | |
| virtual | ~EpgSchedule ()=0 | 
| Pure virtual destructor for cleaning up allocated memory. | |
| std::string & | GetProgramID () | 
| Gets the program identifier for the schedule. | |
|  Public Member Functions inherited from dvblinkremote::Schedule | |
| Schedule (const DVBLinkScheduleType scheduleType, const std::string &channelId, const int recordingsToKeep=0) | |
| Initializes a new instance of the dvblinkremote::Schedule class. | |
| Schedule (const DVBLinkScheduleType scheduleType, const std::string &id, const std::string &channelId, const int recordingsToKeep=0) | |
| Initializes a new instance of the dvblinkremote::Schedule class. | |
| virtual | ~Schedule ()=0 | 
| Pure virtual destructor for cleaning up allocated memory. | |
| std::string & | GetID () | 
| Gets the identifier of the schedule. | |
| std::string & | GetChannelID () | 
| Gets the channel identifier for the schedule. | |
| DVBLinkScheduleType & | GetScheduleType () | 
| Gets the type for the schedule . | |
| Additional Inherited Members | |
|  Public Types inherited from dvblinkremote::Schedule | |
| enum | DVBLinkScheduleType { SCHEDULE_TYPE_MANUAL = 0, SCHEDULE_TYPE_BY_EPG = 1 } | 
| An enum for schedule types.  More... | |
|  Public Attributes inherited from dvblinkremote::EpgSchedule | |
| bool | Repeat | 
| The repeat flag for the schedule. | |
| bool | NewOnly | 
| Flag representing if only new programs have to be recorded. | |
| bool | RecordSeriesAnytime | 
| Flag representing whether to record only series starting around original program start time or any of them. | |
Class for add schedule by electronic program guide (EPG) requests.
This is used as input parameter for the IDVBLinkRemoteConnection::AddSchedule method.
| dvblinkremote::AddScheduleByEpgRequest::AddScheduleByEpgRequest | ( | const std::string & | channelId, | 
| const std::string & | programId, | ||
| const bool | repeat = false, | ||
| const bool | newOnly = false, | ||
| const bool | recordSeriesAnytime = false | ||
| ) | 
Initializes a new instance of the dvblinkremote::AddScheduleByEpgRequest class.
| channelId | a constant string reference representing the channel identifier. | 
| programId | a constant string reference representing the program identifier. | 
| repeat | an optional constant boolean representing if the schedule should be repeated or not. Default value is false. | 
| newOnly | an optional constant boolean representing if only new programs have to be recorded. Default value is false. | 
| recordSeriesAnytime | an optional constant boolean representing whether to record only series starting around original program start time or any of them. Default value is false. | 
| dvblinkremote::AddScheduleByEpgRequest::~AddScheduleByEpgRequest | ( | ) | 
Destructor for cleaning up allocated memory.