Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
systeminfo.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_SYSTEMINFO_H
31#define JELLYFIN_DTO_SYSTEMINFO_H
32
33#include <QJsonObject>
34#include <QJsonValue>
35#include <QList>
36#include <QString>
37#include <QStringList>
38#include <optional>
39
43
44namespace Jellyfin {
45// Forward declaration
46class ApiClient;
47}
48namespace Jellyfin {
49namespace DTO {
50
51
53public:
56 bool isShuttingDown,
58 qint32 webSocketPortNumber,
59 std::optional<bool> canSelfRestart,
60 std::optional<bool> canLaunchWebBrowser,
61 std::optional<bool> hasUpdateAvailable
62 );
63
64 SystemInfo(const SystemInfo &other);
65
69 void replaceData(SystemInfo &other);
70
71 static SystemInfo fromJson(QJsonObject source);
72 void setFromJson(QJsonObject source);
73 QJsonObject toJson() const;
74
75 // Properties
79 QString localAddress() const;
83 void setLocalAddress(QString newLocalAddress);
84 bool localAddressNull() const;
86
90 QString serverName() const;
94 void setServerName(QString newServerName);
95 bool serverNameNull() const;
96 void setServerNameNull();
97
101 QString version() const;
105 void setVersion(QString newVersion);
106 bool versionNull() const;
107 void setVersionNull();
108
112 QString productName() const;
116 void setProductName(QString newProductName);
117 bool productNameNull() const;
118 void setProductNameNull();
119
123 QString operatingSystem() const;
127 void setOperatingSystem(QString newOperatingSystem);
128 bool operatingSystemNull() const;
130
134 QString jellyfinId() const;
138 void setJellyfinId(QString newJellyfinId);
139 bool jellyfinIdNull() const;
140 void setJellyfinIdNull();
141
145 std::optional<bool> startupWizardCompleted() const;
149 void setStartupWizardCompleted(std::optional<bool> newStartupWizardCompleted);
150 bool startupWizardCompletedNull() const;
152
156 QString operatingSystemDisplayName() const;
160 void setOperatingSystemDisplayName(QString newOperatingSystemDisplayName);
163
167 QString packageName() const;
171 void setPackageName(QString newPackageName);
172 bool packageNameNull() const;
173 void setPackageNameNull();
174
178 bool hasPendingRestart() const;
182 void setHasPendingRestart(bool newHasPendingRestart);
183
184
185 bool isShuttingDown() const;
186
187 void setIsShuttingDown(bool newIsShuttingDown);
188
192 bool supportsLibraryMonitor() const;
196 void setSupportsLibraryMonitor(bool newSupportsLibraryMonitor);
197
201 qint32 webSocketPortNumber() const;
205 void setWebSocketPortNumber(qint32 newWebSocketPortNumber);
206
214 void setCompletedInstallations(QList<InstallationInfo> newCompletedInstallations);
215 bool completedInstallationsNull() const;
217
221 std::optional<bool> canSelfRestart() const;
225 void setCanSelfRestart(std::optional<bool> newCanSelfRestart);
226
227
228 std::optional<bool> canLaunchWebBrowser() const;
229
230 void setCanLaunchWebBrowser(std::optional<bool> newCanLaunchWebBrowser);
231
235 QString programDataPath() const;
239 void setProgramDataPath(QString newProgramDataPath);
240 bool programDataPathNull() const;
242
246 QString webPath() const;
250 void setWebPath(QString newWebPath);
251 bool webPathNull() const;
252 void setWebPathNull();
253
257 QString itemsByNamePath() const;
261 void setItemsByNamePath(QString newItemsByNamePath);
262 bool itemsByNamePathNull() const;
264
268 QString cachePath() const;
272 void setCachePath(QString newCachePath);
273 bool cachePathNull() const;
274 void setCachePathNull();
275
279 QString logPath() const;
283 void setLogPath(QString newLogPath);
284 bool logPathNull() const;
285 void setLogPathNull();
286
290 QString internalMetadataPath() const;
294 void setInternalMetadataPath(QString newInternalMetadataPath);
295 bool internalMetadataPathNull() const;
297
301 QString transcodingTempPath() const;
305 void setTranscodingTempPath(QString newTranscodingTempPath);
306 bool transcodingTempPathNull() const;
308
316 void setCastReceiverApplications(QList<CastReceiverApplication> newCastReceiverApplications);
317 bool castReceiverApplicationsNull() const;
319
323 std::optional<bool> hasUpdateAvailable() const;
327 void setHasUpdateAvailable(std::optional<bool> newHasUpdateAvailable);
328
329
330 QString encoderLocation() const;
331
332 void setEncoderLocation(QString newEncoderLocation);
333 bool encoderLocationNull() const;
335
336
337 QString systemArchitecture() const;
338
339 void setSystemArchitecture(QString newSystemArchitecture);
340 bool systemArchitectureNull() const;
342
343
344protected:
347 QString m_version;
351 std::optional<bool> m_startupWizardCompleted = std::nullopt;
359 std::optional<bool> m_canSelfRestart = std::nullopt;
360 std::optional<bool> m_canLaunchWebBrowser = std::nullopt;
362 QString m_webPath;
364 QString m_cachePath;
365 QString m_logPath;
369 std::optional<bool> m_hasUpdateAvailable = std::nullopt;
372
373private:
374 // Private constructor which generates an invalid object, for use withing SystemInfo::fromJson();
375 SystemInfo();
376};
377
378
379} // NS DTO
380
381namespace Support {
382
384
385template <>
386SystemInfo fromJsonValue(const QJsonValue &source, convertType<SystemInfo>);
387
388template<>
389QJsonValue toJsonValue(const SystemInfo &source, convertType<SystemInfo>);
390
391} // NS DTO
392} // NS Jellyfin
393
394#endif // JELLYFIN_DTO_SYSTEMINFO_H
An Api client for Jellyfin. Handles requests and authentication.
Definition apiclient.h:90
Definition systeminfo.h:52
qint32 m_webSocketPortNumber
Definition systeminfo.h:357
bool isShuttingDown() const
Definition systeminfo.cpp:390
bool productNameNull() const
Definition systeminfo.cpp:311
QString m_operatingSystemDisplayName
Definition systeminfo.h:352
QString localAddress() const
Gets or sets the local address.
Definition systeminfo.cpp:267
QString programDataPath() const
Gets or sets the program data path.
Definition systeminfo.cpp:433
QString transcodingTempPath() const
Gets or sets the transcode path.
Definition systeminfo.cpp:511
static SystemInfo fromJson(QJsonObject source)
Definition systeminfo.cpp:116
bool startupWizardCompletedNull() const
Definition systeminfo.cpp:350
void setWebPathNull()
Definition systeminfo.cpp:455
QList< InstallationInfo > m_completedInstallations
Definition systeminfo.h:358
bool m_isShuttingDown
Definition systeminfo.h:355
void setCanLaunchWebBrowser(std::optional< bool > newCanLaunchWebBrowser)
Definition systeminfo.cpp:429
void setCanSelfRestart(std::optional< bool > newCanSelfRestart)
Gets or sets a value indicating whether this instance can self restart.
Definition systeminfo.cpp:423
void setCompletedInstallationsNull()
Definition systeminfo.cpp:417
void setProgramDataPathNull()
Definition systeminfo.cpp:442
void setLogPath(QString newLogPath)
Gets or sets the log path.
Definition systeminfo.cpp:487
QString webPath() const
Gets or sets the web UI resources path.
Definition systeminfo.cpp:446
void setOperatingSystemDisplayName(QString newOperatingSystemDisplayName)
Gets or sets the display name of the operating system.
Definition systeminfo.cpp:360
QString m_webPath
Definition systeminfo.h:362
QString jellyfinId() const
Gets or sets the id.
Definition systeminfo.cpp:332
void setCompletedInstallations(QList< InstallationInfo > newCompletedInstallations)
Gets or sets the completed installations.
Definition systeminfo.cpp:410
bool encoderLocationNull() const
Definition systeminfo.cpp:548
bool systemArchitectureNull() const
Definition systeminfo.cpp:561
void setItemsByNamePathNull()
Definition systeminfo.cpp:468
std::optional< bool > m_hasUpdateAvailable
Definition systeminfo.h:369
void setTranscodingTempPath(QString newTranscodingTempPath)
Gets or sets the transcode path.
Definition systeminfo.cpp:513
bool castReceiverApplicationsNull() const
Definition systeminfo.cpp:529
void setFromJson(QJsonObject source)
Definition systeminfo.cpp:123
void setJellyfinId(QString newJellyfinId)
Gets or sets the id.
Definition systeminfo.cpp:334
QString systemArchitecture() const
Definition systeminfo.cpp:556
void setLocalAddressNull()
Definition systeminfo.cpp:276
bool webPathNull() const
Definition systeminfo.cpp:451
bool transcodingTempPathNull() const
Definition systeminfo.cpp:516
bool supportsLibraryMonitor() const
Gets or sets a value indicating whether [supports library monitor].
Definition systeminfo.cpp:396
QString m_programDataPath
Definition systeminfo.h:361
QString m_version
Definition systeminfo.h:347
void setSystemArchitectureNull()
Definition systeminfo.cpp:565
void setProductNameNull()
Definition systeminfo.cpp:315
QString m_transcodingTempPath
Definition systeminfo.h:367
QString logPath() const
Gets or sets the log path.
Definition systeminfo.cpp:485
QString cachePath() const
Gets or sets the cache path.
Definition systeminfo.cpp:472
void setCachePathNull()
Definition systeminfo.cpp:481
void setStartupWizardCompletedNull()
Definition systeminfo.cpp:354
bool versionNull() const
Definition systeminfo.cpp:298
QString operatingSystem() const
Gets or sets the operating system.
Definition systeminfo.cpp:319
bool localAddressNull() const
Definition systeminfo.cpp:272
std::optional< bool > startupWizardCompleted() const
Gets or sets a value indicating whether the startup wizard is completed.
Definition systeminfo.cpp:345
bool packageNameNull() const
Definition systeminfo.cpp:376
void setEncoderLocation(QString newEncoderLocation)
Definition systeminfo.cpp:545
qint32 webSocketPortNumber() const
Gets or sets the web socket port number.
Definition systeminfo.cpp:402
bool itemsByNamePathNull() const
Definition systeminfo.cpp:464
bool operatingSystemDisplayNameNull() const
Definition systeminfo.cpp:363
std::optional< bool > m_canLaunchWebBrowser
Definition systeminfo.h:360
void setHasPendingRestart(bool newHasPendingRestart)
Gets or sets a value indicating whether this instance has pending restart.
Definition systeminfo.cpp:386
void setItemsByNamePath(QString newItemsByNamePath)
Gets or sets the items by name path.
Definition systeminfo.cpp:461
void setInternalMetadataPath(QString newInternalMetadataPath)
Gets or sets the internal metadata path.
Definition systeminfo.cpp:500
QString productName() const
Gets or sets the product name. This is the AssemblyProduct name.
Definition systeminfo.cpp:306
QString version() const
Gets or sets the server version.
Definition systeminfo.cpp:293
void setOperatingSystemDisplayNameNull()
Definition systeminfo.cpp:367
QString m_systemArchitecture
Definition systeminfo.h:371
void setWebSocketPortNumber(qint32 newWebSocketPortNumber)
Gets or sets the web socket port number.
Definition systeminfo.cpp:404
void setCastReceiverApplicationsNull()
Definition systeminfo.cpp:533
void setVersionNull()
Definition systeminfo.cpp:302
bool m_hasPendingRestart
Definition systeminfo.h:354
void setJellyfinIdNull()
Definition systeminfo.cpp:341
QString internalMetadataPath() const
Gets or sets the internal metadata path.
Definition systeminfo.cpp:498
bool internalMetadataPathNull() const
Definition systeminfo.cpp:503
QString m_operatingSystem
Definition systeminfo.h:349
void setStartupWizardCompleted(std::optional< bool > newStartupWizardCompleted)
Gets or sets a value indicating whether the startup wizard is completed.
Definition systeminfo.cpp:347
QString m_logPath
Definition systeminfo.h:365
bool programDataPathNull() const
Definition systeminfo.cpp:438
void setLocalAddress(QString newLocalAddress)
Gets or sets the local address.
Definition systeminfo.cpp:269
std::optional< bool > m_canSelfRestart
Definition systeminfo.h:359
void setLogPathNull()
Definition systeminfo.cpp:494
QString m_productName
Definition systeminfo.h:348
QString m_localAddress
Definition systeminfo.h:345
void setOperatingSystem(QString newOperatingSystem)
Gets or sets the operating system.
Definition systeminfo.cpp:321
QString m_cachePath
Definition systeminfo.h:364
QList< CastReceiverApplication > castReceiverApplications() const
Gets or sets the list of cast receiver applications.
Definition systeminfo.cpp:524
void setVersion(QString newVersion)
Gets or sets the server version.
Definition systeminfo.cpp:295
void setPackageName(QString newPackageName)
Gets or sets the package name.
Definition systeminfo.cpp:373
QString m_serverName
Definition systeminfo.h:346
bool logPathNull() const
Definition systeminfo.cpp:490
bool jellyfinIdNull() const
Definition systeminfo.cpp:337
void setPackageNameNull()
Definition systeminfo.cpp:380
void setOperatingSystemNull()
Definition systeminfo.cpp:328
void replaceData(SystemInfo &other)
Definition systeminfo.cpp:86
void setIsShuttingDown(bool newIsShuttingDown)
Definition systeminfo.cpp:392
QString m_packageName
Definition systeminfo.h:353
bool cachePathNull() const
Definition systeminfo.cpp:477
void setTranscodingTempPathNull()
Definition systeminfo.cpp:520
QString m_encoderLocation
Definition systeminfo.h:370
std::optional< bool > m_startupWizardCompleted
Definition systeminfo.h:351
void setHasUpdateAvailable(std::optional< bool > newHasUpdateAvailable)
Gets or sets a value indicating whether this instance has update available.
Definition systeminfo.cpp:539
void setCachePath(QString newCachePath)
Gets or sets the cache path.
Definition systeminfo.cpp:474
void setSystemArchitecture(QString newSystemArchitecture)
Definition systeminfo.cpp:558
std::optional< bool > canSelfRestart() const
Gets or sets a value indicating whether this instance can self restart.
Definition systeminfo.cpp:421
QList< InstallationInfo > completedInstallations() const
Gets or sets the completed installations.
Definition systeminfo.cpp:408
void setWebPath(QString newWebPath)
Gets or sets the web UI resources path.
Definition systeminfo.cpp:448
std::optional< bool > hasUpdateAvailable() const
Gets or sets a value indicating whether this instance has update available.
Definition systeminfo.cpp:537
QString m_jellyfinId
Definition systeminfo.h:350
QList< CastReceiverApplication > m_castReceiverApplications
Definition systeminfo.h:368
void setServerName(QString newServerName)
Gets or sets the name of the server.
Definition systeminfo.cpp:282
void setServerNameNull()
Definition systeminfo.cpp:289
QString operatingSystemDisplayName() const
Gets or sets the display name of the operating system.
Definition systeminfo.cpp:358
void setProgramDataPath(QString newProgramDataPath)
Gets or sets the program data path.
Definition systeminfo.cpp:435
void setProductName(QString newProductName)
Gets or sets the product name. This is the AssemblyProduct name.
Definition systeminfo.cpp:308
bool m_supportsLibraryMonitor
Definition systeminfo.h:356
QString itemsByNamePath() const
Gets or sets the items by name path.
Definition systeminfo.cpp:459
bool completedInstallationsNull() const
Definition systeminfo.cpp:413
QString encoderLocation() const
Definition systeminfo.cpp:543
void setSupportsLibraryMonitor(bool newSupportsLibraryMonitor)
Gets or sets a value indicating whether [supports library monitor].
Definition systeminfo.cpp:398
QString serverName() const
Gets or sets the name of the server.
Definition systeminfo.cpp:280
std::optional< bool > canLaunchWebBrowser() const
Definition systeminfo.cpp:427
QString m_internalMetadataPath
Definition systeminfo.h:366
SystemInfo(bool hasPendingRestart, bool isShuttingDown, bool supportsLibraryMonitor, qint32 webSocketPortNumber, std::optional< bool > canSelfRestart, std::optional< bool > canLaunchWebBrowser, std::optional< bool > hasUpdateAvailable)
Definition systeminfo.cpp:36
QString m_itemsByNamePath
Definition systeminfo.h:363
QString packageName() const
Gets or sets the package name.
Definition systeminfo.cpp:371
bool serverNameNull() const
Definition systeminfo.cpp:285
QJsonObject toJson() const
Definition systeminfo.cpp:154
void setCastReceiverApplications(QList< CastReceiverApplication > newCastReceiverApplications)
Gets or sets the list of cast receiver applications.
Definition systeminfo.cpp:526
bool hasPendingRestart() const
Gets or sets a value indicating whether this instance has pending restart.
Definition systeminfo.cpp:384
void setEncoderLocationNull()
Definition systeminfo.cpp:552
void setInternalMetadataPathNull()
Definition systeminfo.cpp:507
bool operatingSystemNull() const
Definition systeminfo.cpp:324
Definition mediaplayer2.h:20
Contains auto-generated Data Transfer Objects for the Jellyfin HTTP API.
Definition accessschedule.h:128
Jellyfin::DTO::SystemInfo SystemInfo
Definition systeminfo.h:383
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