Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
user.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_USER_H
31#define JELLYFIN_LOADER_HTTP_USER_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 GetUsersLoader : public Jellyfin::Support::HttpLoader<QList<UserDto>, GetUsersParams> {
64public:
65 explicit GetUsersLoader(ApiClient *apiClient = nullptr);
66
67protected:
68 QString path(const GetUsersParams& parameters) const override;
69 QUrlQuery query(const GetUsersParams& parameters) const override;
70 QByteArray body(const GetUsersParams& parameters) const override;
71 QNetworkAccessManager::Operation operation() const override;
72};
77class GetUserByIdLoader : public Jellyfin::Support::HttpLoader<UserDto, GetUserByIdParams> {
78public:
79 explicit GetUserByIdLoader(ApiClient *apiClient = nullptr);
80
81protected:
82 QString path(const GetUserByIdParams& parameters) const override;
83 QUrlQuery query(const GetUserByIdParams& parameters) const override;
84 QByteArray body(const GetUserByIdParams& parameters) const override;
85 QNetworkAccessManager::Operation operation() const override;
86};
91class DeleteUserLoader : public Jellyfin::Support::HttpLoader<void, DeleteUserParams> {
92public:
93 explicit DeleteUserLoader(ApiClient *apiClient = nullptr);
94
95protected:
96 QString path(const DeleteUserParams& parameters) const override;
97 QUrlQuery query(const DeleteUserParams& parameters) const override;
98 QByteArray body(const DeleteUserParams& parameters) const override;
99 QNetworkAccessManager::Operation operation() const override;
100};
105class UpdateUserLoader : public Jellyfin::Support::HttpLoader<void, UpdateUserParams> {
106public:
107 explicit UpdateUserLoader(ApiClient *apiClient = nullptr);
108
109protected:
110 QString path(const UpdateUserParams& parameters) const override;
111 QUrlQuery query(const UpdateUserParams& parameters) const override;
112 QByteArray body(const UpdateUserParams& parameters) const override;
113 QNetworkAccessManager::Operation operation() const override;
114};
119class AuthenticateUserLoader : public Jellyfin::Support::HttpLoader<AuthenticationResult, AuthenticateUserParams> {
120public:
121 explicit AuthenticateUserLoader(ApiClient *apiClient = nullptr);
122
123protected:
124 QString path(const AuthenticateUserParams& parameters) const override;
125 QUrlQuery query(const AuthenticateUserParams& parameters) const override;
126 QByteArray body(const AuthenticateUserParams& parameters) const override;
127 QNetworkAccessManager::Operation operation() const override;
128};
133class UpdateUserConfigurationLoader : public Jellyfin::Support::HttpLoader<void, UpdateUserConfigurationParams> {
134public:
136
137protected:
138 QString path(const UpdateUserConfigurationParams& parameters) const override;
139 QUrlQuery query(const UpdateUserConfigurationParams& parameters) const override;
140 QByteArray body(const UpdateUserConfigurationParams& parameters) const override;
141 QNetworkAccessManager::Operation operation() const override;
142};
147class UpdateUserEasyPasswordLoader : public Jellyfin::Support::HttpLoader<void, UpdateUserEasyPasswordParams> {
148public:
150
151protected:
152 QString path(const UpdateUserEasyPasswordParams& parameters) const override;
153 QUrlQuery query(const UpdateUserEasyPasswordParams& parameters) const override;
154 QByteArray body(const UpdateUserEasyPasswordParams& parameters) const override;
155 QNetworkAccessManager::Operation operation() const override;
156};
161class UpdateUserPasswordLoader : public Jellyfin::Support::HttpLoader<void, UpdateUserPasswordParams> {
162public:
163 explicit UpdateUserPasswordLoader(ApiClient *apiClient = nullptr);
164
165protected:
166 QString path(const UpdateUserPasswordParams& parameters) const override;
167 QUrlQuery query(const UpdateUserPasswordParams& parameters) const override;
168 QByteArray body(const UpdateUserPasswordParams& parameters) const override;
169 QNetworkAccessManager::Operation operation() const override;
170};
175class UpdateUserPolicyLoader : public Jellyfin::Support::HttpLoader<void, UpdateUserPolicyParams> {
176public:
177 explicit UpdateUserPolicyLoader(ApiClient *apiClient = nullptr);
178
179protected:
180 QString path(const UpdateUserPolicyParams& parameters) const override;
181 QUrlQuery query(const UpdateUserPolicyParams& parameters) const override;
182 QByteArray body(const UpdateUserPolicyParams& parameters) const override;
183 QNetworkAccessManager::Operation operation() const override;
184};
189class AuthenticateUserByNameLoader : public Jellyfin::Support::HttpLoader<AuthenticationResult, AuthenticateUserByNameParams> {
190public:
192
193protected:
194 QString path(const AuthenticateUserByNameParams& parameters) const override;
195 QUrlQuery query(const AuthenticateUserByNameParams& parameters) const override;
196 QByteArray body(const AuthenticateUserByNameParams& parameters) const override;
197 QNetworkAccessManager::Operation operation() const override;
198};
203class AuthenticateWithQuickConnectLoader : public Jellyfin::Support::HttpLoader<AuthenticationResult, AuthenticateWithQuickConnectParams> {
204public:
206
207protected:
208 QString path(const AuthenticateWithQuickConnectParams& parameters) const override;
209 QUrlQuery query(const AuthenticateWithQuickConnectParams& parameters) const override;
210 QByteArray body(const AuthenticateWithQuickConnectParams& parameters) const override;
211 QNetworkAccessManager::Operation operation() const override;
212};
217class ForgotPasswordLoader : public Jellyfin::Support::HttpLoader<ForgotPasswordResult, ForgotPasswordParams> {
218public:
219 explicit ForgotPasswordLoader(ApiClient *apiClient = nullptr);
220
221protected:
222 QString path(const ForgotPasswordParams& parameters) const override;
223 QUrlQuery query(const ForgotPasswordParams& parameters) const override;
224 QByteArray body(const ForgotPasswordParams& parameters) const override;
225 QNetworkAccessManager::Operation operation() const override;
226};
231class ForgotPasswordPinLoader : public Jellyfin::Support::HttpLoader<PinRedeemResult, ForgotPasswordPinParams> {
232public:
233 explicit ForgotPasswordPinLoader(ApiClient *apiClient = nullptr);
234
235protected:
236 QString path(const ForgotPasswordPinParams& parameters) const override;
237 QUrlQuery query(const ForgotPasswordPinParams& parameters) const override;
238 QByteArray body(const ForgotPasswordPinParams& parameters) const override;
239 QNetworkAccessManager::Operation operation() const override;
240};
245class GetCurrentUserLoader : public Jellyfin::Support::HttpLoader<UserDto, GetCurrentUserParams> {
246public:
247 explicit GetCurrentUserLoader(ApiClient *apiClient = nullptr);
248
249protected:
250 QString path(const GetCurrentUserParams& parameters) const override;
251 QUrlQuery query(const GetCurrentUserParams& parameters) const override;
252 QByteArray body(const GetCurrentUserParams& parameters) const override;
253 QNetworkAccessManager::Operation operation() const override;
254};
259class CreateUserByNameLoader : public Jellyfin::Support::HttpLoader<UserDto, CreateUserByNameParams> {
260public:
261 explicit CreateUserByNameLoader(ApiClient *apiClient = nullptr);
262
263protected:
264 QString path(const CreateUserByNameParams& parameters) const override;
265 QUrlQuery query(const CreateUserByNameParams& parameters) const override;
266 QByteArray body(const CreateUserByNameParams& parameters) const override;
267 QNetworkAccessManager::Operation operation() const override;
268};
273class GetPublicUsersLoader : public Jellyfin::Support::HttpLoader<QList<UserDto>, GetPublicUsersParams> {
274public:
275 explicit GetPublicUsersLoader(ApiClient *apiClient = nullptr);
276
277protected:
278 QString path(const GetPublicUsersParams& parameters) const override;
279 QUrlQuery query(const GetPublicUsersParams& parameters) const override;
280 QByteArray body(const GetPublicUsersParams& parameters) const override;
281 QNetworkAccessManager::Operation operation() const override;
282};
283
284} // NS HTTP
285} // NS Loader
286} // NS Jellyfin
287
288#endif // JELLYFIN_LOADER_HTTP_USER_H
An Api client for Jellyfin. Handles requests and authentication.
Definition apiclient.h:90
Definition requesttypes.h:458
Definition requesttypes.h:958
Definition requesttypes.h:1272
Definition requesttypes.h:1615
Definition requesttypes.h:1637
Definition requesttypes.h:4383
Definition requesttypes.h:14514
Definition requesttypes.h:18637
Definition requesttypes.h:19065
Authenticates a user by name.
Definition user.h:189
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:332
QByteArray body(const AuthenticateUserByNameParams &parameters) const override
Definition user.cpp:328
QString path(const AuthenticateUserByNameParams &parameters) const override
Definition user.cpp:312
QUrlQuery query(const AuthenticateUserByNameParams &parameters) const override
Definition user.cpp:318
AuthenticateUserByNameLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:309
Authenticates a user.
Definition user.h:119
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:187
QUrlQuery query(const AuthenticateUserParams &parameters) const override
Definition user.cpp:169
QByteArray body(const AuthenticateUserParams &parameters) const override
Definition user.cpp:183
AuthenticateUserLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:160
QString path(const AuthenticateUserParams &parameters) const override
Definition user.cpp:163
Authenticates a user with quick connect.
Definition user.h:203
QUrlQuery query(const AuthenticateWithQuickConnectParams &parameters) const override
Definition user.cpp:347
QString path(const AuthenticateWithQuickConnectParams &parameters) const override
Definition user.cpp:341
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:361
QByteArray body(const AuthenticateWithQuickConnectParams &parameters) const override
Definition user.cpp:357
AuthenticateWithQuickConnectLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:338
Creates a user.
Definition user.h:259
QByteArray body(const CreateUserByNameParams &parameters) const override
Definition user.cpp:473
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:477
QUrlQuery query(const CreateUserByNameParams &parameters) const override
Definition user.cpp:463
QString path(const CreateUserByNameParams &parameters) const override
Definition user.cpp:457
CreateUserByNameLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:454
Deletes a user.
Definition user.h:91
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:125
DeleteUserLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:102
QByteArray body(const DeleteUserParams &parameters) const override
Definition user.cpp:121
QUrlQuery query(const DeleteUserParams &parameters) const override
Definition user.cpp:111
QString path(const DeleteUserParams &parameters) const override
Definition user.cpp:105
Initiates the forgot password process for a local user.
Definition user.h:217
ForgotPasswordLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:367
QByteArray body(const ForgotPasswordParams &parameters) const override
Definition user.cpp:386
QUrlQuery query(const ForgotPasswordParams &parameters) const override
Definition user.cpp:376
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:390
QString path(const ForgotPasswordParams &parameters) const override
Definition user.cpp:370
Redeems a forgot password pin.
Definition user.h:231
QByteArray body(const ForgotPasswordPinParams &parameters) const override
Definition user.cpp:415
ForgotPasswordPinLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:396
QString path(const ForgotPasswordPinParams &parameters) const override
Definition user.cpp:399
QUrlQuery query(const ForgotPasswordPinParams &parameters) const override
Definition user.cpp:405
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:419
Gets the user based on auth token.
Definition user.h:245
GetCurrentUserLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:425
QUrlQuery query(const GetCurrentUserParams &parameters) const override
Definition user.cpp:434
QString path(const GetCurrentUserParams &parameters) const override
Definition user.cpp:428
QByteArray body(const GetCurrentUserParams &parameters) const override
Definition user.cpp:444
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:448
Gets a list of publicly visible users for display on a login screen.
Definition user.h:273
QUrlQuery query(const GetPublicUsersParams &parameters) const override
Definition user.cpp:492
QString path(const GetPublicUsersParams &parameters) const override
Definition user.cpp:486
QByteArray body(const GetPublicUsersParams &parameters) const override
Definition user.cpp:502
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:506
GetPublicUsersLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:483
Gets a user by Id.
Definition user.h:77
GetUserByIdLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:73
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:96
QByteArray body(const GetUserByIdParams &parameters) const override
Definition user.cpp:92
QString path(const GetUserByIdParams &parameters) const override
Definition user.cpp:76
QUrlQuery query(const GetUserByIdParams &parameters) const override
Definition user.cpp:82
Gets a list of users.
Definition user.h:63
QUrlQuery query(const GetUsersParams &parameters) const override
Definition user.cpp:47
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:67
QString path(const GetUsersParams &parameters) const override
Definition user.cpp:41
GetUsersLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:38
QByteArray body(const GetUsersParams &parameters) const override
Definition user.cpp:63
Updates a user configuration.
Definition user.h:133
QString path(const UpdateUserConfigurationParams &parameters) const override
Definition user.cpp:196
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:216
QUrlQuery query(const UpdateUserConfigurationParams &parameters) const override
Definition user.cpp:202
UpdateUserConfigurationLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:193
QByteArray body(const UpdateUserConfigurationParams &parameters) const override
Definition user.cpp:212
Updates a user's easy password.
Definition user.h:147
QString path(const UpdateUserEasyPasswordParams &parameters) const override
Definition user.cpp:225
QByteArray body(const UpdateUserEasyPasswordParams &parameters) const override
Definition user.cpp:241
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:245
QUrlQuery query(const UpdateUserEasyPasswordParams &parameters) const override
Definition user.cpp:231
UpdateUserEasyPasswordLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:222
Updates a user.
Definition user.h:105
QByteArray body(const UpdateUserParams &parameters) const override
Definition user.cpp:150
QString path(const UpdateUserParams &parameters) const override
Definition user.cpp:134
UpdateUserLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:131
QUrlQuery query(const UpdateUserParams &parameters) const override
Definition user.cpp:140
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:154
Updates a user's password.
Definition user.h:161
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:274
UpdateUserPasswordLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:251
QUrlQuery query(const UpdateUserPasswordParams &parameters) const override
Definition user.cpp:260
QByteArray body(const UpdateUserPasswordParams &parameters) const override
Definition user.cpp:270
QString path(const UpdateUserPasswordParams &parameters) const override
Definition user.cpp:254
Updates a user policy.
Definition user.h:175
QByteArray body(const UpdateUserPolicyParams &parameters) const override
Definition user.cpp:299
QNetworkAccessManager::Operation operation() const override
Definition user.cpp:303
QString path(const UpdateUserPolicyParams &parameters) const override
Definition user.cpp:283
UpdateUserPolicyLoader(ApiClient *apiClient=nullptr)
Definition user.cpp:280
QUrlQuery query(const UpdateUserPolicyParams &parameters) const override
Definition user.cpp:289
Definition requesttypes.h:30185
Definition requesttypes.h:30125
Definition requesttypes.h:30254
Definition requesttypes.h:30284
Definition loader.h:285
ApiClient * apiClient() const
Definition loader.h:95
Contains auto-generated Data Transfer Objects for the Jellyfin HTTP API.