Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
timerinfodto.h
Go to the documentation of this file.
1/*
2 * Sailfin: a Jellyfin client written using Qt
3 * Copyright (C) 2021 Chris Josten and the Sailfin Contributors.
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18 */
19/*
20 * WARNING: THIS IS AN AUTOMATICALLY GENERATED FILE! PLEASE DO NOT EDIT THIS, AS YOUR EDITS WILL GET
21 * OVERWRITTEN AT SOME POINT!
22 *
23 * If there is a bug in this file, please fix the code generator used to generate this file found in
24 * core/openapigenerator.d.
25 *
26 * This file is generated based on Jellyfin's OpenAPI description, "openapi.json". Please update that
27 * file with a newer file if needed instead of manually updating the files.
28 */
29
30#ifndef JELLYFIN_DTO_TIMERINFODTO_H
31#define JELLYFIN_DTO_TIMERINFODTO_H
32
33#include <QDateTime>
34#include <QJsonObject>
35#include <QJsonValue>
36#include <QList>
37#include <QSharedPointer>
38#include <QString>
39#include <QStringList>
40#include <optional>
41
46
47namespace Jellyfin {
48// Forward declaration
49class ApiClient;
50}
51namespace Jellyfin {
52namespace DTO {
53
54
56public:
58 QString channelId,
59 QDateTime startDate,
60 QDateTime endDate,
61 qint32 priority,
62 qint32 prePaddingSeconds,
63 qint32 postPaddingSeconds,
68 QSharedPointer<BaseItemDto> programInfo
69 );
70
71 TimerInfoDto(const TimerInfoDto &other);
72
76 void replaceData(TimerInfoDto &other);
77
78 static TimerInfoDto fromJson(QJsonObject source);
79 void setFromJson(QJsonObject source);
80 QJsonObject toJson() const;
81
82 // Properties
86 QString jellyfinId() const;
90 void setJellyfinId(QString newJellyfinId);
91 bool jellyfinIdNull() const;
92 void setJellyfinIdNull();
93
94
95 QString type() const;
96
97 void setType(QString newType);
98 bool typeNull() const;
99 void setTypeNull();
100
104 QString serverId() const;
108 void setServerId(QString newServerId);
109 bool serverIdNull() const;
110 void setServerIdNull();
111
115 QString externalId() const;
119 void setExternalId(QString newExternalId);
120 bool externalIdNull() const;
121 void setExternalIdNull();
122
126 QString channelId() const;
130 void setChannelId(QString newChannelId);
131
135 QString externalChannelId() const;
139 void setExternalChannelId(QString newExternalChannelId);
140 bool externalChannelIdNull() const;
142
146 QString channelName() const;
150 void setChannelName(QString newChannelName);
151 bool channelNameNull() const;
152 void setChannelNameNull();
153
154
155 QString channelPrimaryImageTag() const;
156
157 void setChannelPrimaryImageTag(QString newChannelPrimaryImageTag);
158 bool channelPrimaryImageTagNull() const;
160
164 QString programId() const;
168 void setProgramId(QString newProgramId);
169 bool programIdNull() const;
170 void setProgramIdNull();
171
175 QString externalProgramId() const;
179 void setExternalProgramId(QString newExternalProgramId);
180 bool externalProgramIdNull() const;
182
186 QString name() const;
190 void setName(QString newName);
191 bool nameNull() const;
192 void setNameNull();
193
197 QString overview() const;
201 void setOverview(QString newOverview);
202 bool overviewNull() const;
203 void setOverviewNull();
204
208 QDateTime startDate() const;
212 void setStartDate(QDateTime newStartDate);
213
217 QDateTime endDate() const;
221 void setEndDate(QDateTime newEndDate);
222
226 QString serviceName() const;
230 void setServiceName(QString newServiceName);
231 bool serviceNameNull() const;
232 void setServiceNameNull();
233
237 qint32 priority() const;
241 void setPriority(qint32 newPriority);
242
246 qint32 prePaddingSeconds() const;
250 void setPrePaddingSeconds(qint32 newPrePaddingSeconds);
251
255 qint32 postPaddingSeconds() const;
259 void setPostPaddingSeconds(qint32 newPostPaddingSeconds);
260
264 bool isPrePaddingRequired() const;
268 void setIsPrePaddingRequired(bool newIsPrePaddingRequired);
269
273 QString parentBackdropItemId() const;
277 void setParentBackdropItemId(QString newParentBackdropItemId);
278 bool parentBackdropItemIdNull() const;
280
284 QStringList parentBackdropImageTags() const;
288 void setParentBackdropImageTags(QStringList newParentBackdropImageTags);
289 bool parentBackdropImageTagsNull() const;
291
295 bool isPostPaddingRequired() const;
299 void setIsPostPaddingRequired(bool newIsPostPaddingRequired);
300
301
302 KeepUntil keepUntil() const;
303
304 void setKeepUntil(KeepUntil newKeepUntil);
305
306
307 RecordingStatus status() const;
308
309 void setStatus(RecordingStatus newStatus);
310
314 QString seriesTimerId() const;
318 void setSeriesTimerId(QString newSeriesTimerId);
319 bool seriesTimerIdNull() const;
321
325 QString externalSeriesTimerId() const;
329 void setExternalSeriesTimerId(QString newExternalSeriesTimerId);
330 bool externalSeriesTimerIdNull() const;
332
336 std::optional<qint64> runTimeTicks() const;
340 void setRunTimeTicks(std::optional<qint64> newRunTimeTicks);
341 bool runTimeTicksNull() const;
342 void setRunTimeTicksNull();
343
344
345 QSharedPointer<BaseItemDto> programInfo() const;
346
347 void setProgramInfo(QSharedPointer<BaseItemDto> newProgramInfo);
348
349
350protected:
352 QString m_type;
353 QString m_serverId;
355 QString m_channelId;
359 QString m_programId;
361 QString m_name;
362 QString m_overview;
363 QDateTime m_startDate;
364 QDateTime m_endDate;
377 std::optional<qint64> m_runTimeTicks = std::nullopt;
378 QSharedPointer<BaseItemDto> m_programInfo = QSharedPointer<BaseItemDto>();
379
380private:
381 // Private constructor which generates an invalid object, for use withing TimerInfoDto::fromJson();
382 TimerInfoDto();
383};
384
385
386} // NS DTO
387
388namespace Support {
389
391
392template <>
393TimerInfoDto fromJsonValue(const QJsonValue &source, convertType<TimerInfoDto>);
394
395template<>
396QJsonValue toJsonValue(const TimerInfoDto &source, convertType<TimerInfoDto>);
397
398} // NS DTO
399} // NS Jellyfin
400
401#endif // JELLYFIN_DTO_TIMERINFODTO_H
Value
Definition keepuntil.h:49
Value
Definition recordingstatus.h:49
Definition timerinfodto.h:55
bool nameNull() const
Definition timerinfodto.cpp:395
QStringList m_parentBackdropImageTags
Definition timerinfodto.h:371
QString m_parentBackdropItemId
Definition timerinfodto.h:370
bool channelNameNull() const
Definition timerinfodto.cpp:343
bool serviceNameNull() const
Definition timerinfodto.cpp:433
bool externalIdNull() const
Definition timerinfodto.cpp:311
qint32 m_postPaddingSeconds
Definition timerinfodto.h:368
void setChannelId(QString newChannelId)
ChannelId of the recording.
Definition timerinfodto.cpp:321
void setIsPostPaddingRequired(bool newIsPostPaddingRequired)
Gets or sets a value indicating whether this instance is post padding required.
Definition timerinfodto.cpp:493
bool parentBackdropItemIdNull() const
Definition timerinfodto.cpp:470
void setType(QString newType)
Definition timerinfodto.cpp:282
QString externalChannelId() const
Gets or sets the external channel identifier.
Definition timerinfodto.cpp:325
bool typeNull() const
Definition timerinfodto.cpp:285
void setServerId(QString newServerId)
Gets or sets the server identifier.
Definition timerinfodto.cpp:295
void setSeriesTimerId(QString newSeriesTimerId)
Gets or sets the series timer identifier.
Definition timerinfodto.cpp:511
QSharedPointer< BaseItemDto > m_programInfo
Definition timerinfodto.h:378
QString name() const
Name of the recording.
Definition timerinfodto.cpp:390
bool serverIdNull() const
Definition timerinfodto.cpp:298
void setProgramId(QString newProgramId)
Gets or sets the program identifier.
Definition timerinfodto.cpp:366
bool externalChannelIdNull() const
Definition timerinfodto.cpp:330
QString m_serverId
Definition timerinfodto.h:353
void setOverviewNull()
Definition timerinfodto.cpp:412
std::optional< qint64 > m_runTimeTicks
Definition timerinfodto.h:377
QString m_channelPrimaryImageTag
Definition timerinfodto.h:358
void setParentBackdropItemIdNull()
Definition timerinfodto.cpp:474
void setProgramInfo(QSharedPointer< BaseItemDto > newProgramInfo)
Definition timerinfodto.cpp:550
QString serviceName() const
Gets or sets the name of the service.
Definition timerinfodto.cpp:428
QDateTime m_startDate
Definition timerinfodto.h:363
QString m_externalId
Definition timerinfodto.h:354
bool parentBackdropImageTagsNull() const
Definition timerinfodto.cpp:483
void setPriority(qint32 newPriority)
Gets or sets the priority.
Definition timerinfodto.cpp:443
bool isPrePaddingRequired() const
Gets or sets a value indicating whether this instance is pre padding required.
Definition timerinfodto.cpp:459
void setChannelPrimaryImageTagNull()
Definition timerinfodto.cpp:360
QString m_externalProgramId
Definition timerinfodto.h:360
QString m_externalChannelId
Definition timerinfodto.h:356
QString externalProgramId() const
Gets or sets the external program identifier.
Definition timerinfodto.cpp:377
QString channelName() const
ChannelName of the recording.
Definition timerinfodto.cpp:338
bool programIdNull() const
Definition timerinfodto.cpp:369
void setSeriesTimerIdNull()
Definition timerinfodto.cpp:518
void setExternalSeriesTimerIdNull()
Definition timerinfodto.cpp:531
bool m_isPrePaddingRequired
Definition timerinfodto.h:369
QString m_channelName
Definition timerinfodto.h:357
void setFromJson(QJsonObject source)
Definition timerinfodto.cpp:133
void setExternalProgramId(QString newExternalProgramId)
Gets or sets the external program identifier.
Definition timerinfodto.cpp:379
void setRunTimeTicks(std::optional< qint64 > newRunTimeTicks)
Gets or sets the run time ticks.
Definition timerinfodto.cpp:537
bool m_isPostPaddingRequired
Definition timerinfodto.h:372
QString channelPrimaryImageTag() const
Definition timerinfodto.cpp:351
QString externalId() const
Gets or sets the external identifier.
Definition timerinfodto.cpp:306
void setServerIdNull()
Definition timerinfodto.cpp:302
void setExternalProgramIdNull()
Definition timerinfodto.cpp:386
void setTypeNull()
Definition timerinfodto.cpp:289
QString m_channelId
Definition timerinfodto.h:355
bool externalSeriesTimerIdNull() const
Definition timerinfodto.cpp:527
QString channelId() const
ChannelId of the recording.
Definition timerinfodto.cpp:319
void replaceData(TimerInfoDto &other)
Definition timerinfodto.cpp:95
void setChannelPrimaryImageTag(QString newChannelPrimaryImageTag)
Definition timerinfodto.cpp:353
RecordingStatus m_status
Definition timerinfodto.h:374
QString type() const
Definition timerinfodto.cpp:280
QStringList parentBackdropImageTags() const
Gets or sets the parent backdrop image tags.
Definition timerinfodto.cpp:478
void setChannelName(QString newChannelName)
ChannelName of the recording.
Definition timerinfodto.cpp:340
bool jellyfinIdNull() const
Definition timerinfodto.cpp:272
bool channelPrimaryImageTagNull() const
Definition timerinfodto.cpp:356
void setExternalIdNull()
Definition timerinfodto.cpp:315
qint32 postPaddingSeconds() const
Gets or sets the post padding seconds.
Definition timerinfodto.cpp:453
void setExternalSeriesTimerId(QString newExternalSeriesTimerId)
Gets or sets the external series timer identifier.
Definition timerinfodto.cpp:524
void setProgramIdNull()
Definition timerinfodto.cpp:373
bool overviewNull() const
Definition timerinfodto.cpp:408
QDateTime startDate() const
The start date of the recording, in UTC.
Definition timerinfodto.cpp:416
QString parentBackdropItemId() const
If the item does not have any backdrops, this will hold the Id of the Parent that has one.
Definition timerinfodto.cpp:465
qint32 m_prePaddingSeconds
Definition timerinfodto.h:367
qint32 priority() const
Gets or sets the priority.
Definition timerinfodto.cpp:441
void setServiceName(QString newServiceName)
Gets or sets the name of the service.
Definition timerinfodto.cpp:430
KeepUntil m_keepUntil
Definition timerinfodto.h:373
bool externalProgramIdNull() const
Definition timerinfodto.cpp:382
void setExternalChannelIdNull()
Definition timerinfodto.cpp:334
void setExternalId(QString newExternalId)
Gets or sets the external identifier.
Definition timerinfodto.cpp:308
QString seriesTimerId() const
Gets or sets the series timer identifier.
Definition timerinfodto.cpp:509
QString serverId() const
Gets or sets the server identifier.
Definition timerinfodto.cpp:293
QString m_type
Definition timerinfodto.h:352
QString m_seriesTimerId
Definition timerinfodto.h:375
void setParentBackdropItemId(QString newParentBackdropItemId)
If the item does not have any backdrops, this will hold the Id of the Parent that has one.
Definition timerinfodto.cpp:467
QString m_overview
Definition timerinfodto.h:362
QJsonObject toJson() const
Definition timerinfodto.cpp:165
qint32 m_priority
Definition timerinfodto.h:366
void setEndDate(QDateTime newEndDate)
The end date of the recording, in UTC.
Definition timerinfodto.cpp:424
void setJellyfinId(QString newJellyfinId)
Id of the recording.
Definition timerinfodto.cpp:269
QString programId() const
Gets or sets the program identifier.
Definition timerinfodto.cpp:364
void setName(QString newName)
Name of the recording.
Definition timerinfodto.cpp:392
void setStartDate(QDateTime newStartDate)
The start date of the recording, in UTC.
Definition timerinfodto.cpp:418
void setChannelNameNull()
Definition timerinfodto.cpp:347
bool isPostPaddingRequired() const
Gets or sets a value indicating whether this instance is post padding required.
Definition timerinfodto.cpp:491
bool runTimeTicksNull() const
Definition timerinfodto.cpp:540
QString m_name
Definition timerinfodto.h:361
void setStatus(RecordingStatus newStatus)
Definition timerinfodto.cpp:505
void setKeepUntil(KeepUntil newKeepUntil)
Definition timerinfodto.cpp:499
QString m_externalSeriesTimerId
Definition timerinfodto.h:376
QString overview() const
Description of the recording.
Definition timerinfodto.cpp:403
void setRunTimeTicksNull()
Definition timerinfodto.cpp:544
void setParentBackdropImageTags(QStringList newParentBackdropImageTags)
Gets or sets the parent backdrop image tags.
Definition timerinfodto.cpp:480
QString externalSeriesTimerId() const
Gets or sets the external series timer identifier.
Definition timerinfodto.cpp:522
QSharedPointer< BaseItemDto > programInfo() const
Definition timerinfodto.cpp:548
KeepUntil keepUntil() const
Definition timerinfodto.cpp:497
void setParentBackdropImageTagsNull()
Definition timerinfodto.cpp:487
QString m_programId
Definition timerinfodto.h:359
QString m_jellyfinId
Definition timerinfodto.h:351
qint32 prePaddingSeconds() const
Gets or sets the pre padding seconds.
Definition timerinfodto.cpp:447
QDateTime endDate() const
The end date of the recording, in UTC.
Definition timerinfodto.cpp:422
static TimerInfoDto fromJson(QJsonObject source)
Definition timerinfodto.cpp:126
void setPrePaddingSeconds(qint32 newPrePaddingSeconds)
Gets or sets the pre padding seconds.
Definition timerinfodto.cpp:449
void setOverview(QString newOverview)
Description of the recording.
Definition timerinfodto.cpp:405
void setIsPrePaddingRequired(bool newIsPrePaddingRequired)
Gets or sets a value indicating whether this instance is pre padding required.
Definition timerinfodto.cpp:461
void setPostPaddingSeconds(qint32 newPostPaddingSeconds)
Gets or sets the post padding seconds.
Definition timerinfodto.cpp:455
std::optional< qint64 > runTimeTicks() const
Gets or sets the run time ticks.
Definition timerinfodto.cpp:535
void setServiceNameNull()
Definition timerinfodto.cpp:437
void setNameNull()
Definition timerinfodto.cpp:399
void setJellyfinIdNull()
Definition timerinfodto.cpp:276
QDateTime m_endDate
Definition timerinfodto.h:364
QString m_serviceName
Definition timerinfodto.h:365
QString jellyfinId() const
Id of the recording.
Definition timerinfodto.cpp:267
bool seriesTimerIdNull() const
Definition timerinfodto.cpp:514
void setExternalChannelId(QString newExternalChannelId)
Gets or sets the external channel identifier.
Definition timerinfodto.cpp:327
RecordingStatus status() const
Definition timerinfodto.cpp:503
AccessSchedule fromJsonValue(const QJsonValue &source, convertType< AccessSchedule >)
Definition accessschedule.cpp:133
QJsonValue toJsonValue(const AccessSchedule &source, convertType< AccessSchedule >)
Definition accessschedule.cpp:139
Definition jsonconvimpl.h:45