Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
session.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_SESSION_H
31#define JELLYFIN_LOADER_HTTP_SESSION_H
32
33#include <optional>
34
41
42namespace Jellyfin {
43// Forward declaration
44class ApiClient;
45}
46namespace Jellyfin {
47namespace Loader {
48namespace HTTP {
49
50using namespace Jellyfin::DTO;
51
56class GetPasswordResetProvidersLoader : public Jellyfin::Support::HttpLoader<QList<NameIdPair>, GetPasswordResetProvidersParams> {
57public:
59
60protected:
61 QString path(const GetPasswordResetProvidersParams& parameters) const override;
62 QUrlQuery query(const GetPasswordResetProvidersParams& parameters) const override;
63 QByteArray body(const GetPasswordResetProvidersParams& parameters) const override;
64 QNetworkAccessManager::Operation operation() const override;
65};
70class GetAuthProvidersLoader : public Jellyfin::Support::HttpLoader<QList<NameIdPair>, GetAuthProvidersParams> {
71public:
72 explicit GetAuthProvidersLoader(ApiClient *apiClient = nullptr);
73
74protected:
75 QString path(const GetAuthProvidersParams& parameters) const override;
76 QUrlQuery query(const GetAuthProvidersParams& parameters) const override;
77 QByteArray body(const GetAuthProvidersParams& parameters) const override;
78 QNetworkAccessManager::Operation operation() const override;
79};
84class GetSessionsLoader : public Jellyfin::Support::HttpLoader<QList<SessionInfo>, GetSessionsParams> {
85public:
86 explicit GetSessionsLoader(ApiClient *apiClient = nullptr);
87
88protected:
89 QString path(const GetSessionsParams& parameters) const override;
90 QUrlQuery query(const GetSessionsParams& parameters) const override;
91 QByteArray body(const GetSessionsParams& parameters) const override;
92 QNetworkAccessManager::Operation operation() const override;
93};
98class SendFullGeneralCommandLoader : public Jellyfin::Support::HttpLoader<void, SendFullGeneralCommandParams> {
99public:
101
102protected:
103 QString path(const SendFullGeneralCommandParams& parameters) const override;
104 QUrlQuery query(const SendFullGeneralCommandParams& parameters) const override;
105 QByteArray body(const SendFullGeneralCommandParams& parameters) const override;
106 QNetworkAccessManager::Operation operation() const override;
107};
112class SendGeneralCommandLoader : public Jellyfin::Support::HttpLoader<void, SendGeneralCommandParams> {
113public:
114 explicit SendGeneralCommandLoader(ApiClient *apiClient = nullptr);
115
116protected:
117 QString path(const SendGeneralCommandParams& parameters) const override;
118 QUrlQuery query(const SendGeneralCommandParams& parameters) const override;
119 QByteArray body(const SendGeneralCommandParams& parameters) const override;
120 QNetworkAccessManager::Operation operation() const override;
121};
126class SendMessageCommandLoader : public Jellyfin::Support::HttpLoader<void, SendMessageCommandParams> {
127public:
128 explicit SendMessageCommandLoader(ApiClient *apiClient = nullptr);
129
130protected:
131 QString path(const SendMessageCommandParams& parameters) const override;
132 QUrlQuery query(const SendMessageCommandParams& parameters) const override;
133 QByteArray body(const SendMessageCommandParams& parameters) const override;
134 QNetworkAccessManager::Operation operation() const override;
135};
140class PlayLoader : public Jellyfin::Support::HttpLoader<void, PlayParams> {
141public:
142 explicit PlayLoader(ApiClient *apiClient = nullptr);
143
144protected:
145 QString path(const PlayParams& parameters) const override;
146 QUrlQuery query(const PlayParams& parameters) const override;
147 QByteArray body(const PlayParams& parameters) const override;
148 QNetworkAccessManager::Operation operation() const override;
149};
154class SendPlaystateCommandLoader : public Jellyfin::Support::HttpLoader<void, SendPlaystateCommandParams> {
155public:
157
158protected:
159 QString path(const SendPlaystateCommandParams& parameters) const override;
160 QUrlQuery query(const SendPlaystateCommandParams& parameters) const override;
161 QByteArray body(const SendPlaystateCommandParams& parameters) const override;
162 QNetworkAccessManager::Operation operation() const override;
163};
168class SendSystemCommandLoader : public Jellyfin::Support::HttpLoader<void, SendSystemCommandParams> {
169public:
170 explicit SendSystemCommandLoader(ApiClient *apiClient = nullptr);
171
172protected:
173 QString path(const SendSystemCommandParams& parameters) const override;
174 QUrlQuery query(const SendSystemCommandParams& parameters) const override;
175 QByteArray body(const SendSystemCommandParams& parameters) const override;
176 QNetworkAccessManager::Operation operation() const override;
177};
182class AddUserToSessionLoader : public Jellyfin::Support::HttpLoader<void, AddUserToSessionParams> {
183public:
184 explicit AddUserToSessionLoader(ApiClient *apiClient = nullptr);
185
186protected:
187 QString path(const AddUserToSessionParams& parameters) const override;
188 QUrlQuery query(const AddUserToSessionParams& parameters) const override;
189 QByteArray body(const AddUserToSessionParams& parameters) const override;
190 QNetworkAccessManager::Operation operation() const override;
191};
196class RemoveUserFromSessionLoader : public Jellyfin::Support::HttpLoader<void, RemoveUserFromSessionParams> {
197public:
199
200protected:
201 QString path(const RemoveUserFromSessionParams& parameters) const override;
202 QUrlQuery query(const RemoveUserFromSessionParams& parameters) const override;
203 QByteArray body(const RemoveUserFromSessionParams& parameters) const override;
204 QNetworkAccessManager::Operation operation() const override;
205};
210class DisplayContentLoader : public Jellyfin::Support::HttpLoader<void, DisplayContentParams> {
211public:
212 explicit DisplayContentLoader(ApiClient *apiClient = nullptr);
213
214protected:
215 QString path(const DisplayContentParams& parameters) const override;
216 QUrlQuery query(const DisplayContentParams& parameters) const override;
217 QByteArray body(const DisplayContentParams& parameters) const override;
218 QNetworkAccessManager::Operation operation() const override;
219};
224class PostCapabilitiesLoader : public Jellyfin::Support::HttpLoader<void, PostCapabilitiesParams> {
225public:
226 explicit PostCapabilitiesLoader(ApiClient *apiClient = nullptr);
227
228protected:
229 QString path(const PostCapabilitiesParams& parameters) const override;
230 QUrlQuery query(const PostCapabilitiesParams& parameters) const override;
231 QByteArray body(const PostCapabilitiesParams& parameters) const override;
232 QNetworkAccessManager::Operation operation() const override;
233};
238class PostFullCapabilitiesLoader : public Jellyfin::Support::HttpLoader<void, PostFullCapabilitiesParams> {
239public:
241
242protected:
243 QString path(const PostFullCapabilitiesParams& parameters) const override;
244 QUrlQuery query(const PostFullCapabilitiesParams& parameters) const override;
245 QByteArray body(const PostFullCapabilitiesParams& parameters) const override;
246 QNetworkAccessManager::Operation operation() const override;
247};
252class ReportSessionEndedLoader : public Jellyfin::Support::HttpLoader<void, ReportSessionEndedParams> {
253public:
254 explicit ReportSessionEndedLoader(ApiClient *apiClient = nullptr);
255
256protected:
257 QString path(const ReportSessionEndedParams& parameters) const override;
258 QUrlQuery query(const ReportSessionEndedParams& parameters) const override;
259 QByteArray body(const ReportSessionEndedParams& parameters) const override;
260 QNetworkAccessManager::Operation operation() const override;
261};
266class ReportViewingLoader : public Jellyfin::Support::HttpLoader<void, ReportViewingParams> {
267public:
268 explicit ReportViewingLoader(ApiClient *apiClient = nullptr);
269
270protected:
271 QString path(const ReportViewingParams& parameters) const override;
272 QUrlQuery query(const ReportViewingParams& parameters) const override;
273 QByteArray body(const ReportViewingParams& parameters) const override;
274 QNetworkAccessManager::Operation operation() const override;
275};
276
277} // NS HTTP
278} // NS Loader
279} // NS Jellyfin
280
281#endif // JELLYFIN_LOADER_HTTP_SESSION_H
An Api client for Jellyfin. Handles requests and authentication.
Definition apiclient.h:90
Definition requesttypes.h:327
Definition requesttypes.h:1473
Definition requesttypes.h:3796
Definition requesttypes.h:15923
Adds an additional user to a session.
Definition session.h:182
AddUserToSessionLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:338
QByteArray body(const AddUserToSessionParams &parameters) const override
Definition session.cpp:357
QString path(const AddUserToSessionParams &parameters) const override
Definition session.cpp:341
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:361
QUrlQuery query(const AddUserToSessionParams &parameters) const override
Definition session.cpp:347
Instructs a session to browse to an item or view.
Definition session.h:210
QUrlQuery query(const DisplayContentParams &parameters) const override
Definition session.cpp:405
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:422
QString path(const DisplayContentParams &parameters) const override
Definition session.cpp:399
DisplayContentLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:396
QByteArray body(const DisplayContentParams &parameters) const override
Definition session.cpp:418
Get all auth providers.
Definition session.h:70
GetAuthProvidersLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:67
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:90
QString path(const GetAuthProvidersParams &parameters) const override
Definition session.cpp:70
QUrlQuery query(const GetAuthProvidersParams &parameters) const override
Definition session.cpp:76
QByteArray body(const GetAuthProvidersParams &parameters) const override
Definition session.cpp:86
Get all password reset providers.
Definition session.h:56
QString path(const GetPasswordResetProvidersParams &parameters) const override
Definition session.cpp:41
GetPasswordResetProvidersLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:38
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:61
QByteArray body(const GetPasswordResetProvidersParams &parameters) const override
Definition session.cpp:57
QUrlQuery query(const GetPasswordResetProvidersParams &parameters) const override
Definition session.cpp:47
Gets a list of sessions.
Definition session.h:84
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:128
GetSessionsLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:96
QString path(const GetSessionsParams &parameters) const override
Definition session.cpp:99
QByteArray body(const GetSessionsParams &parameters) const override
Definition session.cpp:124
QUrlQuery query(const GetSessionsParams &parameters) const override
Definition session.cpp:105
Instructs a session to play an item.
Definition session.h:140
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:268
QByteArray body(const PlayParams &parameters) const override
Definition session.cpp:264
PlayLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:228
QString path(const PlayParams &parameters) const override
Definition session.cpp:231
QUrlQuery query(const PlayParams &parameters) const override
Definition session.cpp:237
Updates capabilities for a device.
Definition session.h:224
QUrlQuery query(const PostCapabilitiesParams &parameters) const override
Definition session.cpp:437
PostCapabilitiesLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:428
QByteArray body(const PostCapabilitiesParams &parameters) const override
Definition session.cpp:465
QString path(const PostCapabilitiesParams &parameters) const override
Definition session.cpp:431
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:469
Updates capabilities for a device.
Definition session.h:238
QUrlQuery query(const PostFullCapabilitiesParams &parameters) const override
Definition session.cpp:484
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:501
QByteArray body(const PostFullCapabilitiesParams &parameters) const override
Definition session.cpp:497
PostFullCapabilitiesLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:475
QString path(const PostFullCapabilitiesParams &parameters) const override
Definition session.cpp:478
Removes an additional user from a session.
Definition session.h:196
QString path(const RemoveUserFromSessionParams &parameters) const override
Definition session.cpp:370
RemoveUserFromSessionLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:367
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:390
QByteArray body(const RemoveUserFromSessionParams &parameters) const override
Definition session.cpp:386
QUrlQuery query(const RemoveUserFromSessionParams &parameters) const override
Definition session.cpp:376
Reports that a session has ended.
Definition session.h:252
ReportSessionEndedLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:507
QUrlQuery query(const ReportSessionEndedParams &parameters) const override
Definition session.cpp:516
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:530
QByteArray body(const ReportSessionEndedParams &parameters) const override
Definition session.cpp:526
QString path(const ReportSessionEndedParams &parameters) const override
Definition session.cpp:510
Reports that a session is viewing an item.
Definition session.h:266
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:563
ReportViewingLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:536
QString path(const ReportViewingParams &parameters) const override
Definition session.cpp:539
QUrlQuery query(const ReportViewingParams &parameters) const override
Definition session.cpp:545
QByteArray body(const ReportViewingParams &parameters) const override
Definition session.cpp:559
Issues a full general command to a client.
Definition session.h:98
QUrlQuery query(const SendFullGeneralCommandParams &parameters) const override
Definition session.cpp:143
QString path(const SendFullGeneralCommandParams &parameters) const override
Definition session.cpp:137
SendFullGeneralCommandLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:134
QByteArray body(const SendFullGeneralCommandParams &parameters) const override
Definition session.cpp:153
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:157
Issues a general command to a client.
Definition session.h:112
QByteArray body(const SendGeneralCommandParams &parameters) const override
Definition session.cpp:182
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:186
SendGeneralCommandLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:163
QString path(const SendGeneralCommandParams &parameters) const override
Definition session.cpp:166
QUrlQuery query(const SendGeneralCommandParams &parameters) const override
Definition session.cpp:172
Issues a command to a client to display a message to the user.
Definition session.h:126
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:222
SendMessageCommandLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:192
QString path(const SendMessageCommandParams &parameters) const override
Definition session.cpp:195
QByteArray body(const SendMessageCommandParams &parameters) const override
Definition session.cpp:218
QUrlQuery query(const SendMessageCommandParams &parameters) const override
Definition session.cpp:201
Issues a playstate command to a client.
Definition session.h:154
QByteArray body(const SendPlaystateCommandParams &parameters) const override
Definition session.cpp:299
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:303
QString path(const SendPlaystateCommandParams &parameters) const override
Definition session.cpp:277
QUrlQuery query(const SendPlaystateCommandParams &parameters) const override
Definition session.cpp:283
SendPlaystateCommandLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:274
Issues a system command to a client.
Definition session.h:168
QUrlQuery query(const SendSystemCommandParams &parameters) const override
Definition session.cpp:318
SendSystemCommandLoader(ApiClient *apiClient=nullptr)
Definition session.cpp:309
QString path(const SendSystemCommandParams &parameters) const override
Definition session.cpp:312
QByteArray body(const SendSystemCommandParams &parameters) const override
Definition session.cpp:328
QNetworkAccessManager::Operation operation() const override
Definition session.cpp:332
Definition requesttypes.h:27707
Definition requesttypes.h:27911
Definition requesttypes.h:27984
Definition requesttypes.h:28362
Definition requesttypes.h:28533
Definition requesttypes.h:28546
Definition requesttypes.h:28671
Definition requesttypes.h:28701
Definition requesttypes.h:28730
Definition requesttypes.h:28779
Definition requesttypes.h:28828
Definition loader.h:285
ApiClient * apiClient() const
Definition loader.h:95
Contains auto-generated Data Transfer Objects for the Jellyfin HTTP API.