Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
userlibrary.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_LOADER_HTTP_USERLIBRARY_H
31#define JELLYFIN_LOADER_HTTP_USERLIBRARY_H
32
33#include <optional>
34
48
49namespace Jellyfin {
50// Forward declaration
51class ApiClient;
52}
53namespace Jellyfin {
54namespace Loader {
55namespace HTTP {
56
57using namespace Jellyfin::DTO;
58
63class MarkFavoriteItemLoader : public Jellyfin::Support::HttpLoader<UserItemDataDto, MarkFavoriteItemParams> {
64public:
65 explicit MarkFavoriteItemLoader(ApiClient *apiClient = nullptr);
66
67protected:
68 QString path(const MarkFavoriteItemParams& parameters) const override;
69 QUrlQuery query(const MarkFavoriteItemParams& parameters) const override;
70 QByteArray body(const MarkFavoriteItemParams& parameters) const override;
71 QNetworkAccessManager::Operation operation() const override;
72};
77class UnmarkFavoriteItemLoader : public Jellyfin::Support::HttpLoader<UserItemDataDto, UnmarkFavoriteItemParams> {
78public:
79 explicit UnmarkFavoriteItemLoader(ApiClient *apiClient = nullptr);
80
81protected:
82 QString path(const UnmarkFavoriteItemParams& parameters) const override;
83 QUrlQuery query(const UnmarkFavoriteItemParams& parameters) const override;
84 QByteArray body(const UnmarkFavoriteItemParams& parameters) const override;
85 QNetworkAccessManager::Operation operation() const override;
86};
91class GetItemLoader : public Jellyfin::Support::HttpLoader<BaseItemDto, GetItemParams> {
92public:
93 explicit GetItemLoader(ApiClient *apiClient = nullptr);
94
95protected:
96 QString path(const GetItemParams& parameters) const override;
97 QUrlQuery query(const GetItemParams& parameters) const override;
98 QByteArray body(const GetItemParams& parameters) const override;
99 QNetworkAccessManager::Operation operation() const override;
100};
105class GetIntrosLoader : public Jellyfin::Support::HttpLoader<BaseItemDtoQueryResult, GetIntrosParams> {
106public:
107 explicit GetIntrosLoader(ApiClient *apiClient = nullptr);
108
109protected:
110 QString path(const GetIntrosParams& parameters) const override;
111 QUrlQuery query(const GetIntrosParams& parameters) const override;
112 QByteArray body(const GetIntrosParams& parameters) const override;
113 QNetworkAccessManager::Operation operation() const override;
114};
119class GetLocalTrailersLoader : public Jellyfin::Support::HttpLoader<QList<BaseItemDto>, GetLocalTrailersParams> {
120public:
121 explicit GetLocalTrailersLoader(ApiClient *apiClient = nullptr);
122
123protected:
124 QString path(const GetLocalTrailersParams& parameters) const override;
125 QUrlQuery query(const GetLocalTrailersParams& parameters) const override;
126 QByteArray body(const GetLocalTrailersParams& parameters) const override;
127 QNetworkAccessManager::Operation operation() const override;
128};
133class DeleteUserItemRatingLoader : public Jellyfin::Support::HttpLoader<UserItemDataDto, DeleteUserItemRatingParams> {
134public:
136
137protected:
138 QString path(const DeleteUserItemRatingParams& parameters) const override;
139 QUrlQuery query(const DeleteUserItemRatingParams& parameters) const override;
140 QByteArray body(const DeleteUserItemRatingParams& parameters) const override;
141 QNetworkAccessManager::Operation operation() const override;
142};
147class UpdateUserItemRatingLoader : public Jellyfin::Support::HttpLoader<UserItemDataDto, UpdateUserItemRatingParams> {
148public:
150
151protected:
152 QString path(const UpdateUserItemRatingParams& parameters) const override;
153 QUrlQuery query(const UpdateUserItemRatingParams& parameters) const override;
154 QByteArray body(const UpdateUserItemRatingParams& parameters) const override;
155 QNetworkAccessManager::Operation operation() const override;
156};
161class GetSpecialFeaturesLoader : public Jellyfin::Support::HttpLoader<QList<BaseItemDto>, GetSpecialFeaturesParams> {
162public:
163 explicit GetSpecialFeaturesLoader(ApiClient *apiClient = nullptr);
164
165protected:
166 QString path(const GetSpecialFeaturesParams& parameters) const override;
167 QUrlQuery query(const GetSpecialFeaturesParams& parameters) const override;
168 QByteArray body(const GetSpecialFeaturesParams& parameters) const override;
169 QNetworkAccessManager::Operation operation() const override;
170};
175class GetLatestMediaLoader : public Jellyfin::Support::HttpLoader<QList<BaseItemDto>, GetLatestMediaParams> {
176public:
177 explicit GetLatestMediaLoader(ApiClient *apiClient = nullptr);
178
179protected:
180 QString path(const GetLatestMediaParams& parameters) const override;
181 QUrlQuery query(const GetLatestMediaParams& parameters) const override;
182 QByteArray body(const GetLatestMediaParams& parameters) const override;
183 QNetworkAccessManager::Operation operation() const override;
184};
189class GetRootFolderLoader : public Jellyfin::Support::HttpLoader<BaseItemDto, GetRootFolderParams> {
190public:
191 explicit GetRootFolderLoader(ApiClient *apiClient = nullptr);
192
193protected:
194 QString path(const GetRootFolderParams& parameters) const override;
195 QUrlQuery query(const GetRootFolderParams& parameters) const override;
196 QByteArray body(const GetRootFolderParams& parameters) const override;
197 QNetworkAccessManager::Operation operation() const override;
198};
199
200} // NS HTTP
201} // NS Loader
202} // NS Jellyfin
203
204#endif // JELLYFIN_LOADER_HTTP_USERLIBRARY_H
An Api client for Jellyfin. Handles requests and authentication.
Definition apiclient.h:90
Definition requesttypes.h:1369
Definition requesttypes.h:7494
Definition requesttypes.h:7523
Definition requesttypes.h:9837
Definition requesttypes.h:11144
Definition requesttypes.h:15689
Definition requesttypes.h:16332
Deletes a user's saved personal rating for an item.
Definition userlibrary.h:133
QNetworkAccessManager::Operation operation() const override
Definition userlibrary.cpp:206
QByteArray body(const DeleteUserItemRatingParams &parameters) const override
Definition userlibrary.cpp:202
QString path(const DeleteUserItemRatingParams &parameters) const override
Definition userlibrary.cpp:186
QUrlQuery query(const DeleteUserItemRatingParams &parameters) const override
Definition userlibrary.cpp:192
DeleteUserItemRatingLoader(ApiClient *apiClient=nullptr)
Definition userlibrary.cpp:183
Gets intros to play before the main media item plays.
Definition userlibrary.h:105
QUrlQuery query(const GetIntrosParams &parameters) const override
Definition userlibrary.cpp:134
QNetworkAccessManager::Operation operation() const override
Definition userlibrary.cpp:148
QString path(const GetIntrosParams &parameters) const override
Definition userlibrary.cpp:128
GetIntrosLoader(ApiClient *apiClient=nullptr)
Definition userlibrary.cpp:125
QByteArray body(const GetIntrosParams &parameters) const override
Definition userlibrary.cpp:144
Gets an item from a user's library.
Definition userlibrary.h:91
GetItemLoader(ApiClient *apiClient=nullptr)
Definition userlibrary.cpp:96
QUrlQuery query(const GetItemParams &parameters) const override
Definition userlibrary.cpp:105
QNetworkAccessManager::Operation operation() const override
Definition userlibrary.cpp:119
QByteArray body(const GetItemParams &parameters) const override
Definition userlibrary.cpp:115
QString path(const GetItemParams &parameters) const override
Definition userlibrary.cpp:99
Gets latest media.
Definition userlibrary.h:175
QByteArray body(const GetLatestMediaParams &parameters) const override
Definition userlibrary.cpp:322
QNetworkAccessManager::Operation operation() const override
Definition userlibrary.cpp:326
QUrlQuery query(const GetLatestMediaParams &parameters) const override
Definition userlibrary.cpp:282
QString path(const GetLatestMediaParams &parameters) const override
Definition userlibrary.cpp:276
GetLatestMediaLoader(ApiClient *apiClient=nullptr)
Definition userlibrary.cpp:273
Gets local trailers for an item.
Definition userlibrary.h:119
QString path(const GetLocalTrailersParams &parameters) const override
Definition userlibrary.cpp:157
QByteArray body(const GetLocalTrailersParams &parameters) const override
Definition userlibrary.cpp:173
QNetworkAccessManager::Operation operation() const override
Definition userlibrary.cpp:177
QUrlQuery query(const GetLocalTrailersParams &parameters) const override
Definition userlibrary.cpp:163
GetLocalTrailersLoader(ApiClient *apiClient=nullptr)
Definition userlibrary.cpp:154
Gets the root folder from a user's library.
Definition userlibrary.h:189
GetRootFolderLoader(ApiClient *apiClient=nullptr)
Definition userlibrary.cpp:332
QString path(const GetRootFolderParams &parameters) const override
Definition userlibrary.cpp:335
QNetworkAccessManager::Operation operation() const override
Definition userlibrary.cpp:355
QUrlQuery query(const GetRootFolderParams &parameters) const override
Definition userlibrary.cpp:341
QByteArray body(const GetRootFolderParams &parameters) const override
Definition userlibrary.cpp:351
Gets special features for an item.
Definition userlibrary.h:161
QString path(const GetSpecialFeaturesParams &parameters) const override
Definition userlibrary.cpp:247
QUrlQuery query(const GetSpecialFeaturesParams &parameters) const override
Definition userlibrary.cpp:253
QNetworkAccessManager::Operation operation() const override
Definition userlibrary.cpp:267
GetSpecialFeaturesLoader(ApiClient *apiClient=nullptr)
Definition userlibrary.cpp:244
QByteArray body(const GetSpecialFeaturesParams &parameters) const override
Definition userlibrary.cpp:263
Marks an item as a favorite.
Definition userlibrary.h:63
QByteArray body(const MarkFavoriteItemParams &parameters) const override
Definition userlibrary.cpp:57
QString path(const MarkFavoriteItemParams &parameters) const override
Definition userlibrary.cpp:41
QUrlQuery query(const MarkFavoriteItemParams &parameters) const override
Definition userlibrary.cpp:47
MarkFavoriteItemLoader(ApiClient *apiClient=nullptr)
Definition userlibrary.cpp:38
QNetworkAccessManager::Operation operation() const override
Definition userlibrary.cpp:61
Unmarks item as a favorite.
Definition userlibrary.h:77
QByteArray body(const UnmarkFavoriteItemParams &parameters) const override
Definition userlibrary.cpp:86
QUrlQuery query(const UnmarkFavoriteItemParams &parameters) const override
Definition userlibrary.cpp:76
UnmarkFavoriteItemLoader(ApiClient *apiClient=nullptr)
Definition userlibrary.cpp:67
QNetworkAccessManager::Operation operation() const override
Definition userlibrary.cpp:90
QString path(const UnmarkFavoriteItemParams &parameters) const override
Definition userlibrary.cpp:70
Updates a user's rating for an item.
Definition userlibrary.h:147
QNetworkAccessManager::Operation operation() const override
Definition userlibrary.cpp:238
UpdateUserItemRatingLoader(ApiClient *apiClient=nullptr)
Definition userlibrary.cpp:212
QString path(const UpdateUserItemRatingParams &parameters) const override
Definition userlibrary.cpp:215
QByteArray body(const UpdateUserItemRatingParams &parameters) const override
Definition userlibrary.cpp:234
QUrlQuery query(const UpdateUserItemRatingParams &parameters) const override
Definition userlibrary.cpp:221
Definition requesttypes.h:27080
Definition requesttypes.h:29586
Definition requesttypes.h:30215
Definition loader.h:285
ApiClient * apiClient() const
Definition loader.h:95
Contains auto-generated Data Transfer Objects for the Jellyfin HTTP API.