Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
getprogramsdto.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_GETPROGRAMSDTO_H
31#define JELLYFIN_DTO_GETPROGRAMSDTO_H
32
33#include <QDateTime>
34#include <QJsonObject>
35#include <QJsonValue>
36#include <QList>
37#include <QString>
38#include <QStringList>
39#include <optional>
40
44
45namespace Jellyfin {
46// Forward declaration
47class ApiClient;
48}
49namespace Jellyfin {
50namespace DTO {
51
52
54public:
56 QString userId,
58 QString librarySeriesId
59 );
60
61 GetProgramsDto(const GetProgramsDto &other);
62
66 void replaceData(GetProgramsDto &other);
67
68 static GetProgramsDto fromJson(QJsonObject source);
69 void setFromJson(QJsonObject source);
70 QJsonObject toJson() const;
71
72 // Properties
76 QStringList channelIds() const;
80 void setChannelIds(QStringList newChannelIds);
81 bool channelIdsNull() const;
82 void setChannelIdsNull();
83
87 QString userId() const;
91 void setUserId(QString newUserId);
92
97 QDateTime minStartDate() const;
102 void setMinStartDate(QDateTime newMinStartDate);
103 bool minStartDateNull() const;
104 void setMinStartDateNull();
105
110 std::optional<bool> hasAired() const;
115 void setHasAired(std::optional<bool> newHasAired);
116 bool hasAiredNull() const;
117 void setHasAiredNull();
118
123 std::optional<bool> isAiring() const;
128 void setIsAiring(std::optional<bool> newIsAiring);
129 bool isAiringNull() const;
130 void setIsAiringNull();
131
136 QDateTime maxStartDate() const;
141 void setMaxStartDate(QDateTime newMaxStartDate);
142 bool maxStartDateNull() const;
143 void setMaxStartDateNull();
144
149 QDateTime minEndDate() const;
154 void setMinEndDate(QDateTime newMinEndDate);
155 bool minEndDateNull() const;
156 void setMinEndDateNull();
157
162 QDateTime maxEndDate() const;
167 void setMaxEndDate(QDateTime newMaxEndDate);
168 bool maxEndDateNull() const;
169 void setMaxEndDateNull();
170
175 std::optional<bool> isMovie() const;
180 void setIsMovie(std::optional<bool> newIsMovie);
181 bool isMovieNull() const;
182 void setIsMovieNull();
183
188 std::optional<bool> isSeries() const;
193 void setIsSeries(std::optional<bool> newIsSeries);
194 bool isSeriesNull() const;
195 void setIsSeriesNull();
196
201 std::optional<bool> isNews() const;
206 void setIsNews(std::optional<bool> newIsNews);
207 bool isNewsNull() const;
208 void setIsNewsNull();
209
214 std::optional<bool> isKids() const;
219 void setIsKids(std::optional<bool> newIsKids);
220 bool isKidsNull() const;
221 void setIsKidsNull();
222
227 std::optional<bool> isSports() const;
232 void setIsSports(std::optional<bool> newIsSports);
233 bool isSportsNull() const;
234 void setIsSportsNull();
235
240 std::optional<qint32> startIndex() const;
245 void setStartIndex(std::optional<qint32> newStartIndex);
246 bool startIndexNull() const;
247 void setStartIndexNull();
248
253 std::optional<qint32> limit() const;
258 void setLimit(std::optional<qint32> newLimit);
259 bool limitNull() const;
260 void setLimitNull();
261
266 QString sortBy() const;
271 void setSortBy(QString newSortBy);
272 bool sortByNull() const;
273 void setSortByNull();
274
278 QString sortOrder() const;
282 void setSortOrder(QString newSortOrder);
283 bool sortOrderNull() const;
284 void setSortOrderNull();
285
289 QStringList genres() const;
293 void setGenres(QStringList newGenres);
294 bool genresNull() const;
295 void setGenresNull();
296
300 QStringList genreIds() const;
304 void setGenreIds(QStringList newGenreIds);
305 bool genreIdsNull() const;
306 void setGenreIdsNull();
307
312 std::optional<bool> enableImages() const;
317 void setEnableImages(std::optional<bool> newEnableImages);
318 bool enableImagesNull() const;
319 void setEnableImagesNull();
320
324 bool enableTotalRecordCount() const;
328 void setEnableTotalRecordCount(bool newEnableTotalRecordCount);
329
334 std::optional<qint32> imageTypeLimit() const;
339 void setImageTypeLimit(std::optional<qint32> newImageTypeLimit);
340 bool imageTypeLimitNull() const;
342
352 void setEnableImageTypes(QList<ImageType> newEnableImageTypes);
353 bool enableImageTypesNull() const;
355
360 std::optional<bool> enableUserData() const;
365 void setEnableUserData(std::optional<bool> newEnableUserData);
366 bool enableUserDataNull() const;
368
373 QString seriesTimerId() const;
378 void setSeriesTimerId(QString newSeriesTimerId);
379 bool seriesTimerIdNull() const;
381
386 QString librarySeriesId() const;
391 void setLibrarySeriesId(QString newLibrarySeriesId);
392
402 void setFields(QList<ItemFields> newFields);
403 bool fieldsNull() const;
404 void setFieldsNull();
405
406
407protected:
408 QStringList m_channelIds;
409 QString m_userId;
410 QDateTime m_minStartDate;
411 std::optional<bool> m_hasAired = std::nullopt;
412 std::optional<bool> m_isAiring = std::nullopt;
413 QDateTime m_maxStartDate;
414 QDateTime m_minEndDate;
415 QDateTime m_maxEndDate;
416 std::optional<bool> m_isMovie = std::nullopt;
417 std::optional<bool> m_isSeries = std::nullopt;
418 std::optional<bool> m_isNews = std::nullopt;
419 std::optional<bool> m_isKids = std::nullopt;
420 std::optional<bool> m_isSports = std::nullopt;
421 std::optional<qint32> m_startIndex = std::nullopt;
422 std::optional<qint32> m_limit = std::nullopt;
423 QString m_sortBy;
424 QString m_sortOrder;
425 QStringList m_genres;
426 QStringList m_genreIds;
427 std::optional<bool> m_enableImages = std::nullopt;
429 std::optional<qint32> m_imageTypeLimit = std::nullopt;
431 std::optional<bool> m_enableUserData = std::nullopt;
435
436private:
437 // Private constructor which generates an invalid object, for use withing GetProgramsDto::fromJson();
439};
440
441
442} // NS DTO
443
444namespace Support {
445
447
448template <>
450
451template<>
453
454} // NS DTO
455} // NS Jellyfin
456
457#endif // JELLYFIN_DTO_GETPROGRAMSDTO_H
Definition getprogramsdto.h:53
void setEnableImages(std::optional< bool > newEnableImages)
Definition getprogramsdto.cpp:517
void setImageTypeLimitNull()
Definition getprogramsdto.cpp:543
void setFieldsNull()
Definition getprogramsdto.cpp:601
void setUserId(QString newUserId)
Gets or sets optional. Filter by user id.
Definition getprogramsdto.cpp:290
void replaceData(GetProgramsDto &other)
Definition getprogramsdto.cpp:78
std::optional< bool > m_isMovie
Definition getprogramsdto.h:416
QStringList genreIds() const
Gets or sets the genre ids to return guide information for.
Definition getprogramsdto.cpp:502
void setGenresNull()
Definition getprogramsdto.cpp:498
QStringList genres() const
Gets or sets the genres to return guide information for.
Definition getprogramsdto.cpp:489
std::optional< bool > isNews() const
Definition getprogramsdto.cpp:398
bool maxStartDateNull() const
Definition getprogramsdto.cpp:338
bool isAiringNull() const
Definition getprogramsdto.cpp:325
void setIsMovieNull()
Definition getprogramsdto.cpp:381
bool genresNull() const
Definition getprogramsdto.cpp:494
void setIsSeriesNull()
Definition getprogramsdto.cpp:394
std::optional< bool > m_isSports
Definition getprogramsdto.h:420
std::optional< qint32 > m_limit
Definition getprogramsdto.h:422
std::optional< bool > enableImages() const
Definition getprogramsdto.cpp:515
void setIsNewsNull()
Definition getprogramsdto.cpp:407
QString sortOrder() const
Gets or sets sort Order - Ascending,Descending.
Definition getprogramsdto.cpp:476
QString userId() const
Gets or sets optional. Filter by user id.
Definition getprogramsdto.cpp:288
bool minEndDateNull() const
Definition getprogramsdto.cpp:351
QStringList m_channelIds
Definition getprogramsdto.h:408
bool sortByNull() const
Definition getprogramsdto.cpp:468
void setFromJson(QJsonObject source)
Definition getprogramsdto.cpp:115
QDateTime m_maxEndDate
Definition getprogramsdto.h:415
QString m_sortOrder
Definition getprogramsdto.h:424
bool channelIdsNull() const
Definition getprogramsdto.cpp:280
std::optional< bool > m_isSeries
Definition getprogramsdto.h:417
void setEnableImageTypesNull()
Definition getprogramsdto.cpp:556
void setIsNews(std::optional< bool > newIsNews)
Definition getprogramsdto.cpp:400
void setIsKidsNull()
Definition getprogramsdto.cpp:420
void setChannelIds(QStringList newChannelIds)
Gets or sets the channels to return guide information for.
Definition getprogramsdto.cpp:277
bool enableImagesNull() const
Definition getprogramsdto.cpp:520
void setFields(QList< ItemFields > newFields)
Definition getprogramsdto.cpp:594
void setGenreIds(QStringList newGenreIds)
Gets or sets the genre ids to return guide information for.
Definition getprogramsdto.cpp:504
bool limitNull() const
Definition getprogramsdto.cpp:455
void setLimitNull()
Definition getprogramsdto.cpp:459
void setHasAired(std::optional< bool > newHasAired)
Definition getprogramsdto.cpp:309
QString m_userId
Definition getprogramsdto.h:409
QDateTime minStartDate() const
Definition getprogramsdto.cpp:294
bool isNewsNull() const
Definition getprogramsdto.cpp:403
void setIsKids(std::optional< bool > newIsKids)
Definition getprogramsdto.cpp:413
QString sortBy() const
Definition getprogramsdto.cpp:463
static GetProgramsDto fromJson(QJsonObject source)
Definition getprogramsdto.cpp:108
bool startIndexNull() const
Definition getprogramsdto.cpp:442
QDateTime maxStartDate() const
Definition getprogramsdto.cpp:333
QList< ItemFields > fields() const
Definition getprogramsdto.cpp:592
bool genreIdsNull() const
Definition getprogramsdto.cpp:507
void setHasAiredNull()
Definition getprogramsdto.cpp:316
void setIsSportsNull()
Definition getprogramsdto.cpp:433
void setEnableImagesNull()
Definition getprogramsdto.cpp:524
std::optional< bool > m_hasAired
Definition getprogramsdto.h:411
QDateTime m_minEndDate
Definition getprogramsdto.h:414
QStringList m_genreIds
Definition getprogramsdto.h:426
QList< ImageType > m_enableImageTypes
Definition getprogramsdto.h:430
bool fieldsNull() const
Definition getprogramsdto.cpp:597
void setSortOrder(QString newSortOrder)
Gets or sets sort Order - Ascending,Descending.
Definition getprogramsdto.cpp:478
void setMinStartDate(QDateTime newMinStartDate)
Definition getprogramsdto.cpp:296
bool isSportsNull() const
Definition getprogramsdto.cpp:429
bool sortOrderNull() const
Definition getprogramsdto.cpp:481
std::optional< qint32 > limit() const
Definition getprogramsdto.cpp:450
void setSeriesTimerId(QString newSeriesTimerId)
Definition getprogramsdto.cpp:575
void setMaxStartDateNull()
Definition getprogramsdto.cpp:342
void setMinStartDateNull()
Definition getprogramsdto.cpp:303
void setMinEndDate(QDateTime newMinEndDate)
Definition getprogramsdto.cpp:348
std::optional< qint32 > m_imageTypeLimit
Definition getprogramsdto.h:429
void setIsMovie(std::optional< bool > newIsMovie)
Definition getprogramsdto.cpp:374
std::optional< qint32 > startIndex() const
Definition getprogramsdto.cpp:437
std::optional< bool > isMovie() const
Definition getprogramsdto.cpp:372
std::optional< bool > isKids() const
Definition getprogramsdto.cpp:411
void setIsAiring(std::optional< bool > newIsAiring)
Definition getprogramsdto.cpp:322
std::optional< bool > enableUserData() const
Definition getprogramsdto.cpp:560
std::optional< bool > m_isKids
Definition getprogramsdto.h:419
bool imageTypeLimitNull() const
Definition getprogramsdto.cpp:539
QDateTime maxEndDate() const
Definition getprogramsdto.cpp:359
std::optional< bool > hasAired() const
Definition getprogramsdto.cpp:307
QDateTime m_minStartDate
Definition getprogramsdto.h:410
void setImageTypeLimit(std::optional< qint32 > newImageTypeLimit)
Definition getprogramsdto.cpp:536
void setGenreIdsNull()
Definition getprogramsdto.cpp:511
void setEnableImageTypes(QList< ImageType > newEnableImageTypes)
Definition getprogramsdto.cpp:549
void setGenres(QStringList newGenres)
Gets or sets the genres to return guide information for.
Definition getprogramsdto.cpp:491
std::optional< bool > isAiring() const
Definition getprogramsdto.cpp:320
bool enableTotalRecordCount() const
Gets or sets a value indicating whether retrieve total record count.
Definition getprogramsdto.cpp:528
void setEnableUserDataNull()
Definition getprogramsdto.cpp:569
bool enableImageTypesNull() const
Definition getprogramsdto.cpp:552
void setMaxEndDate(QDateTime newMaxEndDate)
Definition getprogramsdto.cpp:361
QJsonObject toJson() const
Definition getprogramsdto.cpp:146
bool hasAiredNull() const
Definition getprogramsdto.cpp:312
bool isKidsNull() const
Definition getprogramsdto.cpp:416
QString m_librarySeriesId
Definition getprogramsdto.h:433
void setEnableUserData(std::optional< bool > newEnableUserData)
Definition getprogramsdto.cpp:562
void setMaxStartDate(QDateTime newMaxStartDate)
Definition getprogramsdto.cpp:335
void setIsAiringNull()
Definition getprogramsdto.cpp:329
void setSortOrderNull()
Definition getprogramsdto.cpp:485
std::optional< bool > m_enableImages
Definition getprogramsdto.h:427
void setMaxEndDateNull()
Definition getprogramsdto.cpp:368
std::optional< bool > m_isAiring
Definition getprogramsdto.h:412
void setLimit(std::optional< qint32 > newLimit)
Definition getprogramsdto.cpp:452
bool enableUserDataNull() const
Definition getprogramsdto.cpp:565
QString m_sortBy
Definition getprogramsdto.h:423
QString m_seriesTimerId
Definition getprogramsdto.h:432
bool isMovieNull() const
Definition getprogramsdto.cpp:377
void setSortByNull()
Definition getprogramsdto.cpp:472
void setEnableTotalRecordCount(bool newEnableTotalRecordCount)
Gets or sets a value indicating whether retrieve total record count.
Definition getprogramsdto.cpp:530
void setStartIndexNull()
Definition getprogramsdto.cpp:446
void setStartIndex(std::optional< qint32 > newStartIndex)
Definition getprogramsdto.cpp:439
bool m_enableTotalRecordCount
Definition getprogramsdto.h:428
std::optional< bool > isSports() const
Definition getprogramsdto.cpp:424
QStringList m_genres
Definition getprogramsdto.h:425
bool maxEndDateNull() const
Definition getprogramsdto.cpp:364
QStringList channelIds() const
Gets or sets the channels to return guide information for.
Definition getprogramsdto.cpp:275
QList< ItemFields > m_fields
Definition getprogramsdto.h:434
void setMinEndDateNull()
Definition getprogramsdto.cpp:355
QString seriesTimerId() const
Definition getprogramsdto.cpp:573
QDateTime m_maxStartDate
Definition getprogramsdto.h:413
std::optional< bool > m_isNews
Definition getprogramsdto.h:418
void setIsSports(std::optional< bool > newIsSports)
Definition getprogramsdto.cpp:426
std::optional< bool > m_enableUserData
Definition getprogramsdto.h:431
QList< ImageType > enableImageTypes() const
Definition getprogramsdto.cpp:547
std::optional< qint32 > m_startIndex
Definition getprogramsdto.h:421
bool minStartDateNull() const
Definition getprogramsdto.cpp:299
bool seriesTimerIdNull() const
Definition getprogramsdto.cpp:578
void setLibrarySeriesId(QString newLibrarySeriesId)
Definition getprogramsdto.cpp:588
void setIsSeries(std::optional< bool > newIsSeries)
Definition getprogramsdto.cpp:387
bool isSeriesNull() const
Definition getprogramsdto.cpp:390
std::optional< bool > isSeries() const
Definition getprogramsdto.cpp:385
std::optional< qint32 > imageTypeLimit() const
Definition getprogramsdto.cpp:534
QString librarySeriesId() const
Definition getprogramsdto.cpp:586
void setSeriesTimerIdNull()
Definition getprogramsdto.cpp:582
QDateTime minEndDate() const
Definition getprogramsdto.cpp:346
void setSortBy(QString newSortBy)
Definition getprogramsdto.cpp:465
void setChannelIdsNull()
Definition getprogramsdto.cpp:284
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