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
46
47namespace Jellyfin {
48// Forward declaration
49class ApiClient;
50}
51namespace Jellyfin {
52namespace DTO {
53
54
56public:
58 std::optional<bool> enableTotalRecordCount
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 bool userIdNull() const;
93 void setUserIdNull();
94
98 QDateTime minStartDate() const;
102 void setMinStartDate(QDateTime newMinStartDate);
103 bool minStartDateNull() const;
104 void setMinStartDateNull();
105
109 std::optional<bool> hasAired() const;
113 void setHasAired(std::optional<bool> newHasAired);
114 bool hasAiredNull() const;
115 void setHasAiredNull();
116
120 std::optional<bool> isAiring() const;
124 void setIsAiring(std::optional<bool> newIsAiring);
125 bool isAiringNull() const;
126 void setIsAiringNull();
127
131 QDateTime maxStartDate() const;
135 void setMaxStartDate(QDateTime newMaxStartDate);
136 bool maxStartDateNull() const;
137 void setMaxStartDateNull();
138
142 QDateTime minEndDate() const;
146 void setMinEndDate(QDateTime newMinEndDate);
147 bool minEndDateNull() const;
148 void setMinEndDateNull();
149
153 QDateTime maxEndDate() const;
157 void setMaxEndDate(QDateTime newMaxEndDate);
158 bool maxEndDateNull() const;
159 void setMaxEndDateNull();
160
164 std::optional<bool> isMovie() const;
168 void setIsMovie(std::optional<bool> newIsMovie);
169 bool isMovieNull() const;
170 void setIsMovieNull();
171
175 std::optional<bool> isSeries() const;
179 void setIsSeries(std::optional<bool> newIsSeries);
180 bool isSeriesNull() const;
181 void setIsSeriesNull();
182
186 std::optional<bool> isNews() const;
190 void setIsNews(std::optional<bool> newIsNews);
191 bool isNewsNull() const;
192 void setIsNewsNull();
193
197 std::optional<bool> isKids() const;
201 void setIsKids(std::optional<bool> newIsKids);
202 bool isKidsNull() const;
203 void setIsKidsNull();
204
208 std::optional<bool> isSports() const;
212 void setIsSports(std::optional<bool> newIsSports);
213 bool isSportsNull() const;
214 void setIsSportsNull();
215
219 std::optional<qint32> startIndex() const;
223 void setStartIndex(std::optional<qint32> newStartIndex);
224 bool startIndexNull() const;
225 void setStartIndexNull();
226
230 std::optional<qint32> limit() const;
234 void setLimit(std::optional<qint32> newLimit);
235 bool limitNull() const;
236 void setLimitNull();
237
245 void setSortBy(QList<ItemSortBy> newSortBy);
246 bool sortByNull() const;
247 void setSortByNull();
248
256 void setSortOrder(QList<SortOrder> newSortOrder);
257 bool sortOrderNull() const;
258 void setSortOrderNull();
259
263 QStringList genres() const;
267 void setGenres(QStringList newGenres);
268 bool genresNull() const;
269 void setGenresNull();
270
274 QStringList genreIds() const;
278 void setGenreIds(QStringList newGenreIds);
279 bool genreIdsNull() const;
280 void setGenreIdsNull();
281
285 std::optional<bool> enableImages() const;
289 void setEnableImages(std::optional<bool> newEnableImages);
290 bool enableImagesNull() const;
291 void setEnableImagesNull();
292
296 std::optional<bool> enableTotalRecordCount() const;
300 void setEnableTotalRecordCount(std::optional<bool> newEnableTotalRecordCount);
301
305 std::optional<qint32> imageTypeLimit() const;
309 void setImageTypeLimit(std::optional<qint32> newImageTypeLimit);
310 bool imageTypeLimitNull() const;
312
320 void setEnableImageTypes(QList<ImageType> newEnableImageTypes);
321 bool enableImageTypesNull() const;
323
327 std::optional<bool> enableUserData() const;
331 void setEnableUserData(std::optional<bool> newEnableUserData);
332 bool enableUserDataNull() const;
334
338 QString seriesTimerId() const;
342 void setSeriesTimerId(QString newSeriesTimerId);
343 bool seriesTimerIdNull() const;
345
349 QString librarySeriesId() const;
353 void setLibrarySeriesId(QString newLibrarySeriesId);
354 bool librarySeriesIdNull() const;
356
364 void setFields(QList<ItemFields> newFields);
365 bool fieldsNull() const;
366 void setFieldsNull();
367
368
369protected:
370 QStringList m_channelIds;
371 QString m_userId;
372 QDateTime m_minStartDate;
373 std::optional<bool> m_hasAired = std::nullopt;
374 std::optional<bool> m_isAiring = std::nullopt;
375 QDateTime m_maxStartDate;
376 QDateTime m_minEndDate;
377 QDateTime m_maxEndDate;
378 std::optional<bool> m_isMovie = std::nullopt;
379 std::optional<bool> m_isSeries = std::nullopt;
380 std::optional<bool> m_isNews = std::nullopt;
381 std::optional<bool> m_isKids = std::nullopt;
382 std::optional<bool> m_isSports = std::nullopt;
383 std::optional<qint32> m_startIndex = std::nullopt;
384 std::optional<qint32> m_limit = std::nullopt;
387 QStringList m_genres;
388 QStringList m_genreIds;
389 std::optional<bool> m_enableImages = std::nullopt;
390 std::optional<bool> m_enableTotalRecordCount = std::nullopt;
391 std::optional<qint32> m_imageTypeLimit = std::nullopt;
393 std::optional<bool> m_enableUserData = std::nullopt;
397
398private:
399 // Private constructor which generates an invalid object, for use withing GetProgramsDto::fromJson();
401};
402
403
404} // NS DTO
405
406namespace Support {
407
409
410template <>
412
413template<>
415
416} // NS DTO
417} // NS Jellyfin
418
419#endif // JELLYFIN_DTO_GETPROGRAMSDTO_H
An Api client for Jellyfin. Handles requests and authentication.
Definition apiclient.h:90
Definition getprogramsdto.h:55
void setEnableImages(std::optional< bool > newEnableImages)
Gets or sets include image information in output.
Definition getprogramsdto.cpp:528
void setImageTypeLimitNull()
Definition getprogramsdto.cpp:554
void setFieldsNull()
Definition getprogramsdto.cpp:619
void setUserId(QString newUserId)
Gets or sets optional. Filter by user id.
Definition getprogramsdto.cpp:294
void replaceData(GetProgramsDto &other)
Definition getprogramsdto.cpp:74
std::optional< bool > m_isMovie
Definition getprogramsdto.h:378
QStringList genreIds() const
Gets or sets the genre ids to return guide information for.
Definition getprogramsdto.cpp:513
void setGenresNull()
Definition getprogramsdto.cpp:509
QStringList genres() const
Gets or sets the genres to return guide information for.
Definition getprogramsdto.cpp:500
std::optional< bool > isNews() const
Gets or sets filter for news.
Definition getprogramsdto.cpp:409
bool maxStartDateNull() const
Definition getprogramsdto.cpp:349
bool isAiringNull() const
Definition getprogramsdto.cpp:336
void setIsMovieNull()
Definition getprogramsdto.cpp:392
bool genresNull() const
Definition getprogramsdto.cpp:505
void setIsSeriesNull()
Definition getprogramsdto.cpp:405
std::optional< bool > m_isSports
Definition getprogramsdto.h:382
std::optional< qint32 > m_limit
Definition getprogramsdto.h:384
std::optional< bool > enableImages() const
Gets or sets include image information in output.
Definition getprogramsdto.cpp:526
void setIsNewsNull()
Definition getprogramsdto.cpp:418
std::optional< bool > m_enableTotalRecordCount
Definition getprogramsdto.h:390
QString userId() const
Gets or sets optional. Filter by user id.
Definition getprogramsdto.cpp:292
bool minEndDateNull() const
Definition getprogramsdto.cpp:362
QStringList m_channelIds
Definition getprogramsdto.h:370
bool sortByNull() const
Definition getprogramsdto.cpp:479
void setFromJson(QJsonObject source)
Definition getprogramsdto.cpp:111
void setEnableTotalRecordCount(std::optional< bool > newEnableTotalRecordCount)
Gets or sets a value indicating whether retrieve total record count.
Definition getprogramsdto.cpp:541
QDateTime m_maxEndDate
Definition getprogramsdto.h:377
bool channelIdsNull() const
Definition getprogramsdto.cpp:284
std::optional< bool > m_isSeries
Definition getprogramsdto.h:379
void setUserIdNull()
Definition getprogramsdto.cpp:301
void setEnableImageTypesNull()
Definition getprogramsdto.cpp:567
void setIsNews(std::optional< bool > newIsNews)
Gets or sets filter for news.
Definition getprogramsdto.cpp:411
void setIsKidsNull()
Definition getprogramsdto.cpp:431
void setChannelIds(QStringList newChannelIds)
Gets or sets the channels to return guide information for.
Definition getprogramsdto.cpp:281
bool enableImagesNull() const
Definition getprogramsdto.cpp:531
void setFields(QList< ItemFields > newFields)
Gets or sets specify additional fields of information to return in the output.
Definition getprogramsdto.cpp:612
void setGenreIds(QStringList newGenreIds)
Gets or sets the genre ids to return guide information for.
Definition getprogramsdto.cpp:515
bool limitNull() const
Definition getprogramsdto.cpp:466
void setLimitNull()
Definition getprogramsdto.cpp:470
void setHasAired(std::optional< bool > newHasAired)
Gets or sets filter by programs that have completed airing, or not.
Definition getprogramsdto.cpp:320
QString m_userId
Definition getprogramsdto.h:371
QList< ItemSortBy > m_sortBy
Definition getprogramsdto.h:385
QDateTime minStartDate() const
Gets or sets the minimum premiere start date.
Definition getprogramsdto.cpp:305
bool isNewsNull() const
Definition getprogramsdto.cpp:414
void setIsKids(std::optional< bool > newIsKids)
Gets or sets filter for kids.
Definition getprogramsdto.cpp:424
bool userIdNull() const
Definition getprogramsdto.cpp:297
static GetProgramsDto fromJson(QJsonObject source)
Definition getprogramsdto.cpp:104
bool startIndexNull() const
Definition getprogramsdto.cpp:453
QDateTime maxStartDate() const
Gets or sets the maximum premiere start date.
Definition getprogramsdto.cpp:344
QList< ItemFields > fields() const
Gets or sets specify additional fields of information to return in the output.
Definition getprogramsdto.cpp:610
bool genreIdsNull() const
Definition getprogramsdto.cpp:518
void setHasAiredNull()
Definition getprogramsdto.cpp:327
void setIsSportsNull()
Definition getprogramsdto.cpp:444
void setEnableImagesNull()
Definition getprogramsdto.cpp:535
std::optional< bool > m_hasAired
Definition getprogramsdto.h:373
QDateTime m_minEndDate
Definition getprogramsdto.h:376
QStringList m_genreIds
Definition getprogramsdto.h:388
QList< ImageType > m_enableImageTypes
Definition getprogramsdto.h:392
bool fieldsNull() const
Definition getprogramsdto.cpp:615
QList< ItemSortBy > sortBy() const
Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate.
Definition getprogramsdto.cpp:474
void setMinStartDate(QDateTime newMinStartDate)
Gets or sets the minimum premiere start date.
Definition getprogramsdto.cpp:307
bool isSportsNull() const
Definition getprogramsdto.cpp:440
bool sortOrderNull() const
Definition getprogramsdto.cpp:492
std::optional< qint32 > limit() const
Gets or sets the maximum number of records to return.
Definition getprogramsdto.cpp:461
void setSeriesTimerId(QString newSeriesTimerId)
Gets or sets filter by series timer id.
Definition getprogramsdto.cpp:586
void setMaxStartDateNull()
Definition getprogramsdto.cpp:353
void setMinStartDateNull()
Definition getprogramsdto.cpp:314
std::optional< bool > enableTotalRecordCount() const
Gets or sets a value indicating whether retrieve total record count.
Definition getprogramsdto.cpp:539
void setMinEndDate(QDateTime newMinEndDate)
Gets or sets the minimum premiere end date.
Definition getprogramsdto.cpp:359
std::optional< qint32 > m_imageTypeLimit
Definition getprogramsdto.h:391
void setIsMovie(std::optional< bool > newIsMovie)
Gets or sets filter for movies.
Definition getprogramsdto.cpp:385
std::optional< qint32 > startIndex() const
Gets or sets the record index to start at. All items with a lower index will be dropped from the resu...
Definition getprogramsdto.cpp:448
std::optional< bool > isMovie() const
Gets or sets filter for movies.
Definition getprogramsdto.cpp:383
std::optional< bool > isKids() const
Gets or sets filter for kids.
Definition getprogramsdto.cpp:422
void setIsAiring(std::optional< bool > newIsAiring)
Gets or sets filter by programs that are currently airing, or not.
Definition getprogramsdto.cpp:333
GetProgramsDto(std::optional< bool > enableTotalRecordCount)
Definition getprogramsdto.cpp:36
std::optional< bool > enableUserData() const
Gets or sets include user data.
Definition getprogramsdto.cpp:571
std::optional< bool > m_isKids
Definition getprogramsdto.h:381
bool imageTypeLimitNull() const
Definition getprogramsdto.cpp:550
QDateTime maxEndDate() const
Gets or sets the maximum premiere end date.
Definition getprogramsdto.cpp:370
std::optional< bool > hasAired() const
Gets or sets filter by programs that have completed airing, or not.
Definition getprogramsdto.cpp:318
QDateTime m_minStartDate
Definition getprogramsdto.h:372
void setImageTypeLimit(std::optional< qint32 > newImageTypeLimit)
Gets or sets the max number of images to return, per image type.
Definition getprogramsdto.cpp:547
void setGenreIdsNull()
Definition getprogramsdto.cpp:522
void setSortOrder(QList< SortOrder > newSortOrder)
Gets or sets sort order.
Definition getprogramsdto.cpp:489
void setEnableImageTypes(QList< ImageType > newEnableImageTypes)
Gets or sets the image types to include in the output.
Definition getprogramsdto.cpp:560
void setGenres(QStringList newGenres)
Gets or sets the genres to return guide information for.
Definition getprogramsdto.cpp:502
std::optional< bool > isAiring() const
Gets or sets filter by programs that are currently airing, or not.
Definition getprogramsdto.cpp:331
QList< SortOrder > m_sortOrder
Definition getprogramsdto.h:386
void setEnableUserDataNull()
Definition getprogramsdto.cpp:580
bool enableImageTypesNull() const
Definition getprogramsdto.cpp:563
void setMaxEndDate(QDateTime newMaxEndDate)
Gets or sets the maximum premiere end date.
Definition getprogramsdto.cpp:372
QJsonObject toJson() const
Definition getprogramsdto.cpp:142
bool hasAiredNull() const
Definition getprogramsdto.cpp:323
void setSortBy(QList< ItemSortBy > newSortBy)
Gets or sets specify one or more sort orders, comma delimited. Options: Name, StartDate.
Definition getprogramsdto.cpp:476
bool isKidsNull() const
Definition getprogramsdto.cpp:427
QString m_librarySeriesId
Definition getprogramsdto.h:395
void setEnableUserData(std::optional< bool > newEnableUserData)
Gets or sets include user data.
Definition getprogramsdto.cpp:573
void setMaxStartDate(QDateTime newMaxStartDate)
Gets or sets the maximum premiere start date.
Definition getprogramsdto.cpp:346
void setIsAiringNull()
Definition getprogramsdto.cpp:340
void setSortOrderNull()
Definition getprogramsdto.cpp:496
std::optional< bool > m_enableImages
Definition getprogramsdto.h:389
void setMaxEndDateNull()
Definition getprogramsdto.cpp:379
std::optional< bool > m_isAiring
Definition getprogramsdto.h:374
void setLimit(std::optional< qint32 > newLimit)
Gets or sets the maximum number of records to return.
Definition getprogramsdto.cpp:463
bool enableUserDataNull() const
Definition getprogramsdto.cpp:576
QString m_seriesTimerId
Definition getprogramsdto.h:394
bool isMovieNull() const
Definition getprogramsdto.cpp:388
void setSortByNull()
Definition getprogramsdto.cpp:483
void setStartIndexNull()
Definition getprogramsdto.cpp:457
void setStartIndex(std::optional< qint32 > newStartIndex)
Gets or sets the record index to start at. All items with a lower index will be dropped from the resu...
Definition getprogramsdto.cpp:450
void setLibrarySeriesIdNull()
Definition getprogramsdto.cpp:606
std::optional< bool > isSports() const
Gets or sets filter for sports.
Definition getprogramsdto.cpp:435
QStringList m_genres
Definition getprogramsdto.h:387
bool maxEndDateNull() const
Definition getprogramsdto.cpp:375
QStringList channelIds() const
Gets or sets the channels to return guide information for.
Definition getprogramsdto.cpp:279
QList< ItemFields > m_fields
Definition getprogramsdto.h:396
void setMinEndDateNull()
Definition getprogramsdto.cpp:366
QString seriesTimerId() const
Gets or sets filter by series timer id.
Definition getprogramsdto.cpp:584
QDateTime m_maxStartDate
Definition getprogramsdto.h:375
std::optional< bool > m_isNews
Definition getprogramsdto.h:380
void setIsSports(std::optional< bool > newIsSports)
Gets or sets filter for sports.
Definition getprogramsdto.cpp:437
std::optional< bool > m_enableUserData
Definition getprogramsdto.h:393
QList< ImageType > enableImageTypes() const
Gets or sets the image types to include in the output.
Definition getprogramsdto.cpp:558
std::optional< qint32 > m_startIndex
Definition getprogramsdto.h:383
bool librarySeriesIdNull() const
Definition getprogramsdto.cpp:602
bool minStartDateNull() const
Definition getprogramsdto.cpp:310
bool seriesTimerIdNull() const
Definition getprogramsdto.cpp:589
void setLibrarySeriesId(QString newLibrarySeriesId)
Gets or sets filter by library series id.
Definition getprogramsdto.cpp:599
void setIsSeries(std::optional< bool > newIsSeries)
Gets or sets filter for series.
Definition getprogramsdto.cpp:398
bool isSeriesNull() const
Definition getprogramsdto.cpp:401
std::optional< bool > isSeries() const
Gets or sets filter for series.
Definition getprogramsdto.cpp:396
std::optional< qint32 > imageTypeLimit() const
Gets or sets the max number of images to return, per image type.
Definition getprogramsdto.cpp:545
QString librarySeriesId() const
Gets or sets filter by library series id.
Definition getprogramsdto.cpp:597
QList< SortOrder > sortOrder() const
Gets or sets sort order.
Definition getprogramsdto.cpp:487
void setSeriesTimerIdNull()
Definition getprogramsdto.cpp:593
QDateTime minEndDate() const
Gets or sets the minimum premiere end date.
Definition getprogramsdto.cpp:357
void setChannelIdsNull()
Definition getprogramsdto.cpp:288
Definition mediaplayer2.h:20
Contains auto-generated Data Transfer Objects for the Jellyfin HTTP API.
Definition accessschedule.h:128
Jellyfin::DTO::GetProgramsDto GetProgramsDto
Definition getprogramsdto.h:408
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