Jellyfin Qt
QML Library for interacting with the Jellyfin multimedia server
Loading...
Searching...
No Matches
networkconfiguration.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_NETWORKCONFIGURATION_H
31#define JELLYFIN_DTO_NETWORKCONFIGURATION_H
32
33#include <QJsonObject>
34#include <QJsonValue>
35#include <QList>
36#include <QString>
37#include <QStringList>
38#include <optional>
39
41
42namespace Jellyfin {
43// Forward declaration
44class ApiClient;
45}
46namespace Jellyfin {
47namespace DTO {
48
49
51public:
53 QString baseUrl,
54 bool enableHttps,
55 bool requireHttps,
56 QString certificatePath,
57 QString certificatePassword,
58 qint32 internalHttpPort,
59 qint32 internalHttpsPort,
60 qint32 publicHttpPort,
61 qint32 publicHttpsPort,
62 bool autoDiscovery,
63 bool enableUPnP,
64 bool enableIPv4,
65 bool enableIPv6,
67 QStringList localNetworkSubnets,
68 QStringList localNetworkAddresses,
69 QStringList knownProxies,
71 QStringList virtualInterfaceNames,
73 QStringList publishedServerUriBySubnet,
74 QStringList remoteIPFilter,
76 );
77
79
84
85 static NetworkConfiguration fromJson(QJsonObject source);
86 void setFromJson(QJsonObject source);
87 QJsonObject toJson() const;
88
89 // Properties
93 QString baseUrl() const;
97 void setBaseUrl(QString newBaseUrl);
98
102 bool enableHttps() const;
106 void setEnableHttps(bool newEnableHttps);
107
111 bool requireHttps() const;
115 void setRequireHttps(bool newRequireHttps);
116
120 QString certificatePath() const;
124 void setCertificatePath(QString newCertificatePath);
125
129 QString certificatePassword() const;
133 void setCertificatePassword(QString newCertificatePassword);
134
138 qint32 internalHttpPort() const;
142 void setInternalHttpPort(qint32 newInternalHttpPort);
143
147 qint32 internalHttpsPort() const;
151 void setInternalHttpsPort(qint32 newInternalHttpsPort);
152
156 qint32 publicHttpPort() const;
160 void setPublicHttpPort(qint32 newPublicHttpPort);
161
165 qint32 publicHttpsPort() const;
169 void setPublicHttpsPort(qint32 newPublicHttpsPort);
170
174 bool autoDiscovery() const;
178 void setAutoDiscovery(bool newAutoDiscovery);
179
183 bool enableUPnP() const;
187 void setEnableUPnP(bool newEnableUPnP);
188
192 bool enableIPv4() const;
196 void setEnableIPv4(bool newEnableIPv4);
197
201 bool enableIPv6() const;
205 void setEnableIPv6(bool newEnableIPv6);
206
210 bool enableRemoteAccess() const;
214 void setEnableRemoteAccess(bool newEnableRemoteAccess);
215
219 QStringList localNetworkSubnets() const;
223 void setLocalNetworkSubnets(QStringList newLocalNetworkSubnets);
224
228 QStringList localNetworkAddresses() const;
232 void setLocalNetworkAddresses(QStringList newLocalNetworkAddresses);
233
237 QStringList knownProxies() const;
241 void setKnownProxies(QStringList newKnownProxies);
242
246 bool ignoreVirtualInterfaces() const;
250 void setIgnoreVirtualInterfaces(bool newIgnoreVirtualInterfaces);
251
255 QStringList virtualInterfaceNames() const;
259 void setVirtualInterfaceNames(QStringList newVirtualInterfaceNames);
260
268 void setEnablePublishedServerUriByRequest(bool newEnablePublishedServerUriByRequest);
269
274 QStringList publishedServerUriBySubnet() const;
279 void setPublishedServerUriBySubnet(QStringList newPublishedServerUriBySubnet);
280
284 QStringList remoteIPFilter() const;
288 void setRemoteIPFilter(QStringList newRemoteIPFilter);
289
293 bool isRemoteIPFilterBlacklist() const;
297 void setIsRemoteIPFilterBlacklist(bool newIsRemoteIPFilterBlacklist);
298
299
300protected:
301 QString m_baseUrl;
317 QStringList m_knownProxies;
322 QStringList m_remoteIPFilter;
324
325private:
326 // Private constructor which generates an invalid object, for use withing NetworkConfiguration::fromJson();
328};
329
330
331} // NS DTO
332
333namespace Support {
334
336
337template <>
339
340template<>
342
343} // NS DTO
344} // NS Jellyfin
345
346#endif // JELLYFIN_DTO_NETWORKCONFIGURATION_H
An Api client for Jellyfin. Handles requests and authentication.
Definition apiclient.h:90
Definition networkconfiguration.h:50
bool enableIPv4() const
Gets or sets a value indicating whether IPv6 is enabled.
Definition networkconfiguration.cpp:269
QJsonObject toJson() const
Definition networkconfiguration.cpp:174
QStringList localNetworkSubnets() const
Gets or sets the subnets that are deemed to make up the LAN.
Definition networkconfiguration.cpp:287
QString m_certificatePassword
Definition networkconfiguration.h:305
bool m_enablePublishedServerUriByRequest
Definition networkconfiguration.h:320
bool requireHttps() const
Gets or sets a value indicating whether the server should force connections over HTTPS.
Definition networkconfiguration.cpp:215
QStringList publishedServerUriBySubnet() const
Definition networkconfiguration.cpp:323
void setRemoteIPFilter(QStringList newRemoteIPFilter)
Gets or sets the filter for remote IP connectivity. Used in conjunction with P:MediaBrowser....
Definition networkconfiguration.cpp:331
qint32 m_publicHttpsPort
Definition networkconfiguration.h:309
void setIgnoreVirtualInterfaces(bool newIgnoreVirtualInterfaces)
Gets or sets a value indicating whether address names that match MediaBrowser.Common....
Definition networkconfiguration.cpp:307
bool m_enableIPv6
Definition networkconfiguration.h:313
void setInternalHttpsPort(qint32 newInternalHttpsPort)
Gets or sets the internal HTTPS server port.
Definition networkconfiguration.cpp:241
qint32 internalHttpsPort() const
Gets or sets the internal HTTPS server port.
Definition networkconfiguration.cpp:239
QStringList virtualInterfaceNames() const
Gets or sets a value indicating the interface name prefixes that should be ignored....
Definition networkconfiguration.cpp:311
QString certificatePassword() const
Gets or sets the password required to access the X.509 certificate data in the file specified by Medi...
Definition networkconfiguration.cpp:227
void setEnableUPnP(bool newEnableUPnP)
Gets or sets a value indicating whether to enable automatic port forwarding.
Definition networkconfiguration.cpp:265
void setInternalHttpPort(qint32 newInternalHttpPort)
Gets or sets the internal HTTP server port.
Definition networkconfiguration.cpp:235
static NetworkConfiguration fromJson(QJsonObject source)
Definition networkconfiguration.cpp:140
QStringList m_remoteIPFilter
Definition networkconfiguration.h:322
bool isRemoteIPFilterBlacklist() const
Gets or sets a value indicating whether P:MediaBrowser.Common.Net.NetworkConfiguration....
Definition networkconfiguration.cpp:335
void setCertificatePassword(QString newCertificatePassword)
Gets or sets the password required to access the X.509 certificate data in the file specified by Medi...
Definition networkconfiguration.cpp:229
bool m_isRemoteIPFilterBlacklist
Definition networkconfiguration.h:323
QStringList m_localNetworkAddresses
Definition networkconfiguration.h:316
QString m_baseUrl
Definition networkconfiguration.h:301
qint32 internalHttpPort() const
Gets or sets the internal HTTP server port.
Definition networkconfiguration.cpp:233
QString baseUrl() const
Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at.
Definition networkconfiguration.cpp:203
qint32 m_internalHttpPort
Definition networkconfiguration.h:306
void setLocalNetworkAddresses(QStringList newLocalNetworkAddresses)
Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be us...
Definition networkconfiguration.cpp:295
void setEnablePublishedServerUriByRequest(bool newEnablePublishedServerUriByRequest)
Gets or sets a value indicating whether the published server uri is based on information in HTTP requ...
Definition networkconfiguration.cpp:319
QStringList localNetworkAddresses() const
Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be us...
Definition networkconfiguration.cpp:293
void setEnableHttps(bool newEnableHttps)
Gets or sets a value indicating whether to use HTTPS.
Definition networkconfiguration.cpp:211
bool m_enableUPnP
Definition networkconfiguration.h:311
void setKnownProxies(QStringList newKnownProxies)
Gets or sets the known proxies.
Definition networkconfiguration.cpp:301
bool enableIPv6() const
Gets or sets a value indicating whether IPv6 is enabled.
Definition networkconfiguration.cpp:275
void setLocalNetworkSubnets(QStringList newLocalNetworkSubnets)
Gets or sets the subnets that are deemed to make up the LAN.
Definition networkconfiguration.cpp:289
void setPublicHttpsPort(qint32 newPublicHttpsPort)
Gets or sets the public HTTPS port.
Definition networkconfiguration.cpp:253
void setAutoDiscovery(bool newAutoDiscovery)
Gets or sets a value indicating whether Autodiscovery is enabled.
Definition networkconfiguration.cpp:259
void setEnableRemoteAccess(bool newEnableRemoteAccess)
Gets or sets a value indicating whether access from outside of the LAN is permitted.
Definition networkconfiguration.cpp:283
qint32 publicHttpPort() const
Gets or sets the public HTTP port.
Definition networkconfiguration.cpp:245
QStringList m_localNetworkSubnets
Definition networkconfiguration.h:315
bool m_enableHttps
Definition networkconfiguration.h:302
void setBaseUrl(QString newBaseUrl)
Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at.
Definition networkconfiguration.cpp:205
bool ignoreVirtualInterfaces() const
Gets or sets a value indicating whether address names that match MediaBrowser.Common....
Definition networkconfiguration.cpp:305
bool enableUPnP() const
Gets or sets a value indicating whether to enable automatic port forwarding.
Definition networkconfiguration.cpp:263
QStringList knownProxies() const
Gets or sets the known proxies.
Definition networkconfiguration.cpp:299
void setEnableIPv6(bool newEnableIPv6)
Gets or sets a value indicating whether IPv6 is enabled.
Definition networkconfiguration.cpp:277
bool m_requireHttps
Definition networkconfiguration.h:303
void setVirtualInterfaceNames(QStringList newVirtualInterfaceNames)
Gets or sets a value indicating the interface name prefixes that should be ignored....
Definition networkconfiguration.cpp:313
QStringList m_knownProxies
Definition networkconfiguration.h:317
bool autoDiscovery() const
Gets or sets a value indicating whether Autodiscovery is enabled.
Definition networkconfiguration.cpp:257
QString m_certificatePath
Definition networkconfiguration.h:304
qint32 m_publicHttpPort
Definition networkconfiguration.h:308
void setFromJson(QJsonObject source)
Definition networkconfiguration.cpp:147
void setPublicHttpPort(qint32 newPublicHttpPort)
Gets or sets the public HTTP port.
Definition networkconfiguration.cpp:247
QStringList m_virtualInterfaceNames
Definition networkconfiguration.h:319
qint32 publicHttpsPort() const
Gets or sets the public HTTPS port.
Definition networkconfiguration.cpp:251
void replaceData(NetworkConfiguration &other)
Definition networkconfiguration.cpp:114
QString certificatePath() const
Gets or sets the filesystem path of an X.509 certificate to use for SSL.
Definition networkconfiguration.cpp:221
bool enableRemoteAccess() const
Gets or sets a value indicating whether access from outside of the LAN is permitted.
Definition networkconfiguration.cpp:281
void setCertificatePath(QString newCertificatePath)
Gets or sets the filesystem path of an X.509 certificate to use for SSL.
Definition networkconfiguration.cpp:223
void setEnableIPv4(bool newEnableIPv4)
Gets or sets a value indicating whether IPv6 is enabled.
Definition networkconfiguration.cpp:271
bool enablePublishedServerUriByRequest() const
Gets or sets a value indicating whether the published server uri is based on information in HTTP requ...
Definition networkconfiguration.cpp:317
bool enableHttps() const
Gets or sets a value indicating whether to use HTTPS.
Definition networkconfiguration.cpp:209
bool m_ignoreVirtualInterfaces
Definition networkconfiguration.h:318
bool m_autoDiscovery
Definition networkconfiguration.h:310
bool m_enableRemoteAccess
Definition networkconfiguration.h:314
void setPublishedServerUriBySubnet(QStringList newPublishedServerUriBySubnet)
Definition networkconfiguration.cpp:325
bool m_enableIPv4
Definition networkconfiguration.h:312
void setIsRemoteIPFilterBlacklist(bool newIsRemoteIPFilterBlacklist)
Gets or sets a value indicating whether P:MediaBrowser.Common.Net.NetworkConfiguration....
Definition networkconfiguration.cpp:337
QStringList m_publishedServerUriBySubnet
Definition networkconfiguration.h:321
qint32 m_internalHttpsPort
Definition networkconfiguration.h:307
void setRequireHttps(bool newRequireHttps)
Gets or sets a value indicating whether the server should force connections over HTTPS.
Definition networkconfiguration.cpp:217
QStringList remoteIPFilter() const
Gets or sets the filter for remote IP connectivity. Used in conjunction with P:MediaBrowser....
Definition networkconfiguration.cpp:329
NetworkConfiguration(QString baseUrl, bool enableHttps, bool requireHttps, QString certificatePath, QString certificatePassword, qint32 internalHttpPort, qint32 internalHttpsPort, qint32 publicHttpPort, qint32 publicHttpsPort, bool autoDiscovery, bool enableUPnP, bool enableIPv4, bool enableIPv6, bool enableRemoteAccess, QStringList localNetworkSubnets, QStringList localNetworkAddresses, QStringList knownProxies, bool ignoreVirtualInterfaces, QStringList virtualInterfaceNames, bool enablePublishedServerUriByRequest, QStringList publishedServerUriBySubnet, QStringList remoteIPFilter, bool isRemoteIPFilterBlacklist)
Definition networkconfiguration.cpp:36
Contains auto-generated Data Transfer Objects for the Jellyfin HTTP API.
Definition accessschedule.h:128
AccessSchedule fromJsonValue(const QJsonValue &source, convertType< AccessSchedule >)
Definition accessschedule.cpp:133
Jellyfin::DTO::NetworkConfiguration NetworkConfiguration
Definition networkconfiguration.h:335
QJsonValue toJsonValue(const AccessSchedule &source, convertType< AccessSchedule >)
Definition accessschedule.cpp:139
Definition jsonconvimpl.h:45