Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
seriestimerinfodto.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_SERIESTIMERINFODTO_H
31#define JELLYFIN_DTO_SERIESTIMERINFODTO_H
32
33#include <QDateTime>
34#include <QJsonObject>
35#include <QJsonValue>
36#include <QList>
37#include <QString>
38#include <QStringList>
39#include <optional>
40
45
46namespace Jellyfin {
47// Forward declaration
48class ApiClient;
49}
50namespace Jellyfin {
51namespace DTO {
52
53
55public:
57 QString channelId,
58 QDateTime startDate,
59 QDateTime endDate,
60 qint32 priority,
61 qint32 prePaddingSeconds,
62 qint32 postPaddingSeconds,
66 bool recordAnyTime,
68 bool recordAnyChannel,
69 qint32 keepUpTo,
70 bool recordNewOnly,
72 );
73
75
80
81 static SeriesTimerInfoDto fromJson(QJsonObject source);
82 void setFromJson(QJsonObject source);
83 QJsonObject toJson() const;
84
85 // Properties
89 QString jellyfinId() const;
93 void setJellyfinId(QString newJellyfinId);
94 bool jellyfinIdNull() const;
95 void setJellyfinIdNull();
96
97
98 QString type() const;
99
100 void setType(QString newType);
101 bool typeNull() const;
102 void setTypeNull();
103
107 QString serverId() const;
111 void setServerId(QString newServerId);
112 bool serverIdNull() const;
113 void setServerIdNull();
114
118 QString externalId() const;
122 void setExternalId(QString newExternalId);
123 bool externalIdNull() const;
124 void setExternalIdNull();
125
129 QString channelId() const;
133 void setChannelId(QString newChannelId);
134
138 QString externalChannelId() const;
142 void setExternalChannelId(QString newExternalChannelId);
143 bool externalChannelIdNull() const;
145
149 QString channelName() const;
153 void setChannelName(QString newChannelName);
154 bool channelNameNull() const;
155 void setChannelNameNull();
156
157
158 QString channelPrimaryImageTag() const;
159
160 void setChannelPrimaryImageTag(QString newChannelPrimaryImageTag);
161 bool channelPrimaryImageTagNull() const;
163
167 QString programId() const;
171 void setProgramId(QString newProgramId);
172 bool programIdNull() const;
173 void setProgramIdNull();
174
178 QString externalProgramId() const;
182 void setExternalProgramId(QString newExternalProgramId);
183 bool externalProgramIdNull() const;
185
189 QString name() const;
193 void setName(QString newName);
194 bool nameNull() const;
195 void setNameNull();
196
200 QString overview() const;
204 void setOverview(QString newOverview);
205 bool overviewNull() const;
206 void setOverviewNull();
207
211 QDateTime startDate() const;
215 void setStartDate(QDateTime newStartDate);
216
220 QDateTime endDate() const;
224 void setEndDate(QDateTime newEndDate);
225
229 QString serviceName() const;
233 void setServiceName(QString newServiceName);
234 bool serviceNameNull() const;
235 void setServiceNameNull();
236
240 qint32 priority() const;
244 void setPriority(qint32 newPriority);
245
249 qint32 prePaddingSeconds() const;
253 void setPrePaddingSeconds(qint32 newPrePaddingSeconds);
254
258 qint32 postPaddingSeconds() const;
262 void setPostPaddingSeconds(qint32 newPostPaddingSeconds);
263
267 bool isPrePaddingRequired() const;
271 void setIsPrePaddingRequired(bool newIsPrePaddingRequired);
272
276 QString parentBackdropItemId() const;
280 void setParentBackdropItemId(QString newParentBackdropItemId);
281 bool parentBackdropItemIdNull() const;
283
287 QStringList parentBackdropImageTags() const;
291 void setParentBackdropImageTags(QStringList newParentBackdropImageTags);
292 bool parentBackdropImageTagsNull() const;
294
298 bool isPostPaddingRequired() const;
302 void setIsPostPaddingRequired(bool newIsPostPaddingRequired);
303
304
305 KeepUntil keepUntil() const;
306
307 void setKeepUntil(KeepUntil newKeepUntil);
308
312 bool recordAnyTime() const;
316 void setRecordAnyTime(bool newRecordAnyTime);
317
318
319 bool skipEpisodesInLibrary() const;
320
321 void setSkipEpisodesInLibrary(bool newSkipEpisodesInLibrary);
322
326 bool recordAnyChannel() const;
330 void setRecordAnyChannel(bool newRecordAnyChannel);
331
332
333 qint32 keepUpTo() const;
334
335 void setKeepUpTo(qint32 newKeepUpTo);
336
340 bool recordNewOnly() const;
344 void setRecordNewOnly(bool newRecordNewOnly);
345
349 QList<DayOfWeek> days() const;
353 void setDays(QList<DayOfWeek> newDays);
354 bool daysNull() const;
355 void setDaysNull();
356
357
358 DayPattern dayPattern() const;
359
360 void setDayPattern(DayPattern newDayPattern);
361
365 QJsonObject imageTags() const;
369 void setImageTags(QJsonObject newImageTags);
370 bool imageTagsNull() const;
371 void setImageTagsNull();
372
376 QString parentThumbItemId() const;
380 void setParentThumbItemId(QString newParentThumbItemId);
381 bool parentThumbItemIdNull() const;
383
387 QString parentThumbImageTag() const;
391 void setParentThumbImageTag(QString newParentThumbImageTag);
392 bool parentThumbImageTagNull() const;
394
398 QString parentPrimaryImageItemId() const;
402 void setParentPrimaryImageItemId(QString newParentPrimaryImageItemId);
403 bool parentPrimaryImageItemIdNull() const;
405
409 QString parentPrimaryImageTag() const;
413 void setParentPrimaryImageTag(QString newParentPrimaryImageTag);
414 bool parentPrimaryImageTagNull() const;
416
417
418protected:
420 QString m_type;
421 QString m_serverId;
423 QString m_channelId;
427 QString m_programId;
429 QString m_name;
430 QString m_overview;
431 QDateTime m_startDate;
432 QDateTime m_endDate;
449 QJsonObject m_imageTags;
454
455private:
456 // Private constructor which generates an invalid object, for use withing SeriesTimerInfoDto::fromJson();
458};
459
460
461} // NS DTO
462
463namespace Support {
464
466
467template <>
469
470template<>
472
473} // NS DTO
474} // NS Jellyfin
475
476#endif // JELLYFIN_DTO_SERIESTIMERINFODTO_H
Value
Definition daypattern.h:49
Value
Definition keepuntil.h:49
Definition seriestimerinfodto.h:54
bool nameNull() const
Definition seriestimerinfodto.cpp:443
void setExternalId(QString newExternalId)
Gets or sets the external identifier.
Definition seriestimerinfodto.cpp:356
void setImageTagsNull()
Definition seriestimerinfodto.cpp:609
bool parentPrimaryImageItemIdNull() const
Definition seriestimerinfodto.cpp:644
QStringList m_parentBackdropImageTags
Definition seriestimerinfodto.h:439
bool recordNewOnly() const
Gets or sets a value indicating whether [record new only].
Definition seriestimerinfodto.cpp:575
QString m_programId
Definition seriestimerinfodto.h:427
QDateTime startDate() const
The start date of the recording, in UTC.
Definition seriestimerinfodto.cpp:464
void setNameNull()
Definition seriestimerinfodto.cpp:447
QStringList parentBackdropImageTags() const
Gets or sets the parent backdrop image tags.
Definition seriestimerinfodto.cpp:526
qint32 prePaddingSeconds() const
Gets or sets the pre padding seconds.
Definition seriestimerinfodto.cpp:495
void setPriority(qint32 newPriority)
Gets or sets the priority.
Definition seriestimerinfodto.cpp:491
void setParentBackdropItemId(QString newParentBackdropItemId)
If the item does not have any backdrops, this will hold the Id of the Parent that has one.
Definition seriestimerinfodto.cpp:515
void setJellyfinIdNull()
Definition seriestimerinfodto.cpp:324
void setExternalProgramId(QString newExternalProgramId)
Gets or sets the external program identifier.
Definition seriestimerinfodto.cpp:427
QString m_type
Definition seriestimerinfodto.h:420
DayPattern dayPattern() const
Definition seriestimerinfodto.cpp:594
void setDayPattern(DayPattern newDayPattern)
Definition seriestimerinfodto.cpp:596
void setIsPrePaddingRequired(bool newIsPrePaddingRequired)
Gets or sets a value indicating whether this instance is pre padding required.
Definition seriestimerinfodto.cpp:509
void setChannelPrimaryImageTagNull()
Definition seriestimerinfodto.cpp:408
bool serviceNameNull() const
Definition seriestimerinfodto.cpp:481
QString overview() const
Description of the recording.
Definition seriestimerinfodto.cpp:451
bool isPostPaddingRequired() const
Gets or sets a value indicating whether this instance is post padding required.
Definition seriestimerinfodto.cpp:539
bool overviewNull() const
Definition seriestimerinfodto.cpp:456
QString parentPrimaryImageItemId() const
Gets or sets the parent primary image item identifier.
Definition seriestimerinfodto.cpp:639
void setKeepUpTo(qint32 newKeepUpTo)
Definition seriestimerinfodto.cpp:571
qint32 m_priority
Definition seriestimerinfodto.h:434
static SeriesTimerInfoDto fromJson(QJsonObject source)
Definition seriestimerinfodto.cpp:148
bool parentPrimaryImageTagNull() const
Definition seriestimerinfodto.cpp:657
qint32 m_keepUpTo
Definition seriestimerinfodto.h:445
bool parentBackdropItemIdNull() const
Definition seriestimerinfodto.cpp:518
QDateTime endDate() const
The end date of the recording, in UTC.
Definition seriestimerinfodto.cpp:470
bool channelPrimaryImageTagNull() const
Definition seriestimerinfodto.cpp:404
void setParentThumbImageTagNull()
Definition seriestimerinfodto.cpp:635
bool imageTagsNull() const
Definition seriestimerinfodto.cpp:605
void setExternalChannelId(QString newExternalChannelId)
Gets or sets the external channel identifier.
Definition seriestimerinfodto.cpp:375
QJsonObject imageTags() const
Gets or sets the image tags.
Definition seriestimerinfodto.cpp:600
QString m_externalProgramId
Definition seriestimerinfodto.h:428
QString jellyfinId() const
Id of the recording.
Definition seriestimerinfodto.cpp:315
void setRecordAnyTime(bool newRecordAnyTime)
Gets or sets a value indicating whether [record any time].
Definition seriestimerinfodto.cpp:553
void setSkipEpisodesInLibrary(bool newSkipEpisodesInLibrary)
Definition seriestimerinfodto.cpp:559
qint32 priority() const
Gets or sets the priority.
Definition seriestimerinfodto.cpp:489
KeepUntil m_keepUntil
Definition seriestimerinfodto.h:441
QString channelName() const
ChannelName of the recording.
Definition seriestimerinfodto.cpp:386
QDateTime m_startDate
Definition seriestimerinfodto.h:431
QString m_channelPrimaryImageTag
Definition seriestimerinfodto.h:426
QString m_name
Definition seriestimerinfodto.h:429
QString channelId() const
ChannelId of the recording.
Definition seriestimerinfodto.cpp:367
void setIsPostPaddingRequired(bool newIsPostPaddingRequired)
Gets or sets a value indicating whether this instance is post padding required.
Definition seriestimerinfodto.cpp:541
void setParentPrimaryImageItemIdNull()
Definition seriestimerinfodto.cpp:648
QString m_jellyfinId
Definition seriestimerinfodto.h:419
QString m_channelName
Definition seriestimerinfodto.h:425
void setTypeNull()
Definition seriestimerinfodto.cpp:337
void setStartDate(QDateTime newStartDate)
The start date of the recording, in UTC.
Definition seriestimerinfodto.cpp:466
QString m_channelId
Definition seriestimerinfodto.h:423
void setChannelName(QString newChannelName)
ChannelName of the recording.
Definition seriestimerinfodto.cpp:388
QString m_parentBackdropItemId
Definition seriestimerinfodto.h:438
bool parentThumbImageTagNull() const
Definition seriestimerinfodto.cpp:631
bool skipEpisodesInLibrary() const
Definition seriestimerinfodto.cpp:557
QString m_parentThumbItemId
Definition seriestimerinfodto.h:450
QString externalId() const
Gets or sets the external identifier.
Definition seriestimerinfodto.cpp:354
QJsonObject toJson() const
Definition seriestimerinfodto.cpp:194
bool externalChannelIdNull() const
Definition seriestimerinfodto.cpp:378
void setType(QString newType)
Definition seriestimerinfodto.cpp:330
QString externalChannelId() const
Gets or sets the external channel identifier.
Definition seriestimerinfodto.cpp:373
DayPattern m_dayPattern
Definition seriestimerinfodto.h:448
void replaceData(SeriesTimerInfoDto &other)
Definition seriestimerinfodto.cpp:110
void setParentPrimaryImageTag(QString newParentPrimaryImageTag)
Gets or sets the parent primary image tag.
Definition seriestimerinfodto.cpp:654
bool parentThumbItemIdNull() const
Definition seriestimerinfodto.cpp:618
void setParentBackdropImageTags(QStringList newParentBackdropImageTags)
Gets or sets the parent backdrop image tags.
Definition seriestimerinfodto.cpp:528
bool serverIdNull() const
Definition seriestimerinfodto.cpp:346
QString serviceName() const
Gets or sets the name of the service.
Definition seriestimerinfodto.cpp:476
void setParentPrimaryImageItemId(QString newParentPrimaryImageItemId)
Gets or sets the parent primary image item identifier.
Definition seriestimerinfodto.cpp:641
void setParentThumbItemIdNull()
Definition seriestimerinfodto.cpp:622
QString m_externalChannelId
Definition seriestimerinfodto.h:424
void setServiceName(QString newServiceName)
Gets or sets the name of the service.
Definition seriestimerinfodto.cpp:478
QString name() const
Name of the recording.
Definition seriestimerinfodto.cpp:438
bool m_recordAnyTime
Definition seriestimerinfodto.h:442
bool externalProgramIdNull() const
Definition seriestimerinfodto.cpp:430
void setProgramId(QString newProgramId)
Gets or sets the program identifier.
Definition seriestimerinfodto.cpp:414
void setRecordAnyChannel(bool newRecordAnyChannel)
Gets or sets a value indicating whether [record any channel].
Definition seriestimerinfodto.cpp:565
bool channelNameNull() const
Definition seriestimerinfodto.cpp:391
qint32 m_postPaddingSeconds
Definition seriestimerinfodto.h:436
QString parentPrimaryImageTag() const
Gets or sets the parent primary image tag.
Definition seriestimerinfodto.cpp:652
void setName(QString newName)
Name of the recording.
Definition seriestimerinfodto.cpp:440
void setParentBackdropImageTagsNull()
Definition seriestimerinfodto.cpp:535
void setParentThumbItemId(QString newParentThumbItemId)
Gets or sets the parent thumb item id.
Definition seriestimerinfodto.cpp:615
QString parentThumbImageTag() const
Gets or sets the parent thumb image tag.
Definition seriestimerinfodto.cpp:626
void setChannelId(QString newChannelId)
ChannelId of the recording.
Definition seriestimerinfodto.cpp:369
QString m_parentPrimaryImageItemId
Definition seriestimerinfodto.h:452
QString parentBackdropItemId() const
If the item does not have any backdrops, this will hold the Id of the Parent that has one.
Definition seriestimerinfodto.cpp:513
QString type() const
Definition seriestimerinfodto.cpp:328
void setJellyfinId(QString newJellyfinId)
Id of the recording.
Definition seriestimerinfodto.cpp:317
QString m_parentPrimaryImageTag
Definition seriestimerinfodto.h:453
qint32 m_prePaddingSeconds
Definition seriestimerinfodto.h:435
void setKeepUntil(KeepUntil newKeepUntil)
Definition seriestimerinfodto.cpp:547
void setExternalProgramIdNull()
Definition seriestimerinfodto.cpp:434
void setEndDate(QDateTime newEndDate)
The end date of the recording, in UTC.
Definition seriestimerinfodto.cpp:472
QString m_externalId
Definition seriestimerinfodto.h:422
QString programId() const
Gets or sets the program identifier.
Definition seriestimerinfodto.cpp:412
bool typeNull() const
Definition seriestimerinfodto.cpp:333
bool m_recordAnyChannel
Definition seriestimerinfodto.h:444
void setDays(QList< DayOfWeek > newDays)
Gets or sets the days.
Definition seriestimerinfodto.cpp:583
qint32 keepUpTo() const
Definition seriestimerinfodto.cpp:569
void setImageTags(QJsonObject newImageTags)
Gets or sets the image tags.
Definition seriestimerinfodto.cpp:602
QString serverId() const
Gets or sets the server identifier.
Definition seriestimerinfodto.cpp:341
QString channelPrimaryImageTag() const
Definition seriestimerinfodto.cpp:399
KeepUntil keepUntil() const
Definition seriestimerinfodto.cpp:545
void setChannelNameNull()
Definition seriestimerinfodto.cpp:395
void setProgramIdNull()
Definition seriestimerinfodto.cpp:421
QJsonObject m_imageTags
Definition seriestimerinfodto.h:449
bool m_isPrePaddingRequired
Definition seriestimerinfodto.h:437
QDateTime m_endDate
Definition seriestimerinfodto.h:432
bool externalIdNull() const
Definition seriestimerinfodto.cpp:359
void setParentPrimaryImageTagNull()
Definition seriestimerinfodto.cpp:661
bool m_skipEpisodesInLibrary
Definition seriestimerinfodto.h:443
void setChannelPrimaryImageTag(QString newChannelPrimaryImageTag)
Definition seriestimerinfodto.cpp:401
void setPrePaddingSeconds(qint32 newPrePaddingSeconds)
Gets or sets the pre padding seconds.
Definition seriestimerinfodto.cpp:497
bool recordAnyTime() const
Gets or sets a value indicating whether [record any time].
Definition seriestimerinfodto.cpp:551
QList< DayOfWeek > m_days
Definition seriestimerinfodto.h:447
void setFromJson(QJsonObject source)
Definition seriestimerinfodto.cpp:155
bool daysNull() const
Definition seriestimerinfodto.cpp:586
QString m_serverId
Definition seriestimerinfodto.h:421
void setRecordNewOnly(bool newRecordNewOnly)
Gets or sets a value indicating whether [record new only].
Definition seriestimerinfodto.cpp:577
bool m_recordNewOnly
Definition seriestimerinfodto.h:446
QString parentThumbItemId() const
Gets or sets the parent thumb item id.
Definition seriestimerinfodto.cpp:613
bool parentBackdropImageTagsNull() const
Definition seriestimerinfodto.cpp:531
void setDaysNull()
Definition seriestimerinfodto.cpp:590
qint32 postPaddingSeconds() const
Gets or sets the post padding seconds.
Definition seriestimerinfodto.cpp:501
void setParentBackdropItemIdNull()
Definition seriestimerinfodto.cpp:522
bool isPrePaddingRequired() const
Gets or sets a value indicating whether this instance is pre padding required.
Definition seriestimerinfodto.cpp:507
void setParentThumbImageTag(QString newParentThumbImageTag)
Gets or sets the parent thumb image tag.
Definition seriestimerinfodto.cpp:628
void setPostPaddingSeconds(qint32 newPostPaddingSeconds)
Gets or sets the post padding seconds.
Definition seriestimerinfodto.cpp:503
QString externalProgramId() const
Gets or sets the external program identifier.
Definition seriestimerinfodto.cpp:425
void setExternalChannelIdNull()
Definition seriestimerinfodto.cpp:382
QString m_serviceName
Definition seriestimerinfodto.h:433
void setServiceNameNull()
Definition seriestimerinfodto.cpp:485
bool recordAnyChannel() const
Gets or sets a value indicating whether [record any channel].
Definition seriestimerinfodto.cpp:563
bool jellyfinIdNull() const
Definition seriestimerinfodto.cpp:320
QString m_overview
Definition seriestimerinfodto.h:430
void setOverviewNull()
Definition seriestimerinfodto.cpp:460
void setServerId(QString newServerId)
Gets or sets the server identifier.
Definition seriestimerinfodto.cpp:343
QList< DayOfWeek > days() const
Gets or sets the days.
Definition seriestimerinfodto.cpp:581
QString m_parentThumbImageTag
Definition seriestimerinfodto.h:451
bool m_isPostPaddingRequired
Definition seriestimerinfodto.h:440
bool programIdNull() const
Definition seriestimerinfodto.cpp:417
void setExternalIdNull()
Definition seriestimerinfodto.cpp:363
void setOverview(QString newOverview)
Description of the recording.
Definition seriestimerinfodto.cpp:453
void setServerIdNull()
Definition seriestimerinfodto.cpp:350
Definition mediaplayer2.h:20
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