serverconfiguration.h

Go to the documentation of this file.

/*
 * Sailfin: a Jellyfin client written using Qt
 * Copyright (C) 2021 Chris Josten and the Sailfin Contributors.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
/*
 * WARNING: THIS IS AN AUTOMATICALLY GENERATED FILE! PLEASE DO NOT EDIT THIS, AS YOUR EDITS WILL GET
 * OVERWRITTEN AT SOME POINT! 
 *
 * If there is a bug in this file, please fix the code generator used to generate this file found in
 * core/openapigenerator.d. 
 *
 * This file is generated based on Jellyfin's OpenAPI description, "openapi.json". Please update that
 * file with a newer file if needed instead of manually updating the files.
 */
 
#ifndef JELLYFIN_DTO_SERVERCONFIGURATION_H
#define JELLYFIN_DTO_SERVERCONFIGURATION_H
 
#include <QJsonObject>
#include <QJsonValue>
#include <QList>
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <optional>
 
#include "JellyfinQt/dto/imagesavingconvention.h"
#include "JellyfinQt/dto/metadataoptions.h"
#include "JellyfinQt/dto/namevaluepair.h"
#include "JellyfinQt/dto/pathsubstitution.h"
#include "JellyfinQt/dto/repositoryinfo.h"
#include "JellyfinQt/dto/version.h"
#include "JellyfinQt/support/jsonconv.h"
 
namespace Jellyfin {
// Forward declaration
class ApiClient;
}
namespace Jellyfin {
namespace DTO {
 
 
class ServerConfiguration {
public:
    ServerConfiguration(    
        qint32 logFileRetentionDays,            
        bool isStartupWizardCompleted,                  
        QSharedPointer<Version> previousVersion,                    
        bool enableUPnP,            
        bool enableMetrics,         
        qint32 publicPort,          
        bool uPnPCreateHttpPortMap,                 
        bool enableIPV6,            
        bool enableIPV4,            
        bool enableSSDPTracing,                 
        qint32 uDPSendCount,            
        qint32 uDPSendDelay,            
        bool ignoreVirtualInterfaces,                   
        qint32 gatewayMonitorPeriod,            
        bool enableMultiSocketBinding,          
        bool trustAllIP6Interfaces,                         
        bool autoDiscoveryTracing,          
        bool autoDiscovery,         
        qint32 publicHttpsPort,         
        qint32 httpServerPortNumber,            
        qint32 httpsPortNumber,         
        bool enableHttps,           
        bool enableNormalizedItemByNameIds,                         
        bool isPortAuthorized,          
        bool quickConnectAvailable,         
        bool enableRemoteAccess,            
        bool enableCaseSensitiveItemIds,            
        bool disableLiveTvChannelUserDataName,                                                                  
        qint32 minResumePct,            
        qint32 maxResumePct,            
        qint32 minResumeDurationSeconds,            
        qint32 minAudiobookResume,          
        qint32 maxAudiobookResume,          
        qint32 libraryMonitorDelay,         
        bool enableDashboardResponseCaching,            
        ImageSavingConvention imageSavingConvention,                    
        bool skipDeserializationForBasicTypes,                                  
        bool saveMetadataHidden,                    
        qint32 remoteClientBitrateLimit,            
        bool enableFolderView,          
        bool enableGroupingIntoCollections,         
        bool displaySpecialsWithinSeasons,                                          
        bool enableExternalContentInSuggestions,            
        bool requireHttps,          
        bool enableNewOmdbSupport,                  
        bool isRemoteIPFilterBlacklist,         
        qint32 imageExtractionTimeoutMs,                    
        bool enableSimpleArtistDetection,                   
        bool enableSlowResponseWarning,         
        qint64 slowResponseThresholdMs,                                 
        qint32 libraryScanFanoutConcurrency,            
        qint32 libraryMetadataRefreshConcurrency,           
        bool removeOldPlugins,          
        bool disablePluginImages        
    );
 
    ServerConfiguration(const ServerConfiguration &other);
    
    void replaceData(ServerConfiguration &other);
    
    static ServerConfiguration fromJson(QJsonObject source);
    void setFromJson(QJsonObject source);
    QJsonObject toJson() const;
    
    // Properties
    qint32 logFileRetentionDays() const;
    void setLogFileRetentionDays(qint32 newLogFileRetentionDays);
 
    bool isStartupWizardCompleted() const;
    void setIsStartupWizardCompleted(bool newIsStartupWizardCompleted);
 
    QString cachePath() const;
    void setCachePath(QString newCachePath);
    bool cachePathNull() const;
    void setCachePathNull();
 
 
    QSharedPointer<Version> previousVersion() const;
 
    void setPreviousVersion(QSharedPointer<Version> newPreviousVersion);
 
    QString previousVersionStr() const;
    void setPreviousVersionStr(QString newPreviousVersionStr);
    bool previousVersionStrNull() const;
    void setPreviousVersionStrNull();
 
    bool enableUPnP() const;
    void setEnableUPnP(bool newEnableUPnP);
 
    bool enableMetrics() const;
    void setEnableMetrics(bool newEnableMetrics);
 
    qint32 publicPort() const;
    void setPublicPort(qint32 newPublicPort);
 
    bool uPnPCreateHttpPortMap() const;
    void setUPnPCreateHttpPortMap(bool newUPnPCreateHttpPortMap);
 
    QString uDPPortRange() const;
    void setUDPPortRange(QString newUDPPortRange);
    bool uDPPortRangeNull() const;
    void setUDPPortRangeNull();
 
    bool enableIPV6() const;
    void setEnableIPV6(bool newEnableIPV6);
 
    bool enableIPV4() const;
    void setEnableIPV4(bool newEnableIPV4);
 
    bool enableSSDPTracing() const;
    void setEnableSSDPTracing(bool newEnableSSDPTracing);
 
    QString sSDPTracingFilter() const;
    void setSSDPTracingFilter(QString newSSDPTracingFilter);
    bool sSDPTracingFilterNull() const;
    void setSSDPTracingFilterNull();
 
    qint32 uDPSendCount() const;
    void setUDPSendCount(qint32 newUDPSendCount);
 
    qint32 uDPSendDelay() const;
    void setUDPSendDelay(qint32 newUDPSendDelay);
 
    bool ignoreVirtualInterfaces() const;
    void setIgnoreVirtualInterfaces(bool newIgnoreVirtualInterfaces);
 
    QString virtualInterfaceNames() const;
    void setVirtualInterfaceNames(QString newVirtualInterfaceNames);
    bool virtualInterfaceNamesNull() const;
    void setVirtualInterfaceNamesNull();
 
    qint32 gatewayMonitorPeriod() const;
    void setGatewayMonitorPeriod(qint32 newGatewayMonitorPeriod);
 
    bool enableMultiSocketBinding() const;
    void setEnableMultiSocketBinding(bool newEnableMultiSocketBinding);
 
    bool trustAllIP6Interfaces() const;
    void setTrustAllIP6Interfaces(bool newTrustAllIP6Interfaces);
 
    QString hDHomerunPortRange() const;
    void setHDHomerunPortRange(QString newHDHomerunPortRange);
    bool hDHomerunPortRangeNull() const;
    void setHDHomerunPortRangeNull();
 
    QStringList publishedServerUriBySubnet() const;
    void setPublishedServerUriBySubnet(QStringList newPublishedServerUriBySubnet);
    bool publishedServerUriBySubnetNull() const;
    void setPublishedServerUriBySubnetNull();
 
    bool autoDiscoveryTracing() const;
    void setAutoDiscoveryTracing(bool newAutoDiscoveryTracing);
 
    bool autoDiscovery() const;
    void setAutoDiscovery(bool newAutoDiscovery);
 
    qint32 publicHttpsPort() const;
    void setPublicHttpsPort(qint32 newPublicHttpsPort);
 
    qint32 httpServerPortNumber() const;
    void setHttpServerPortNumber(qint32 newHttpServerPortNumber);
 
    qint32 httpsPortNumber() const;
    void setHttpsPortNumber(qint32 newHttpsPortNumber);
 
    bool enableHttps() const;
    void setEnableHttps(bool newEnableHttps);
 
 
    bool enableNormalizedItemByNameIds() const;
 
    void setEnableNormalizedItemByNameIds(bool newEnableNormalizedItemByNameIds);
 
    QString certificatePath() const;
    void setCertificatePath(QString newCertificatePath);
    bool certificatePathNull() const;
    void setCertificatePathNull();
 
    QString certificatePassword() const;
    void setCertificatePassword(QString newCertificatePassword);
    bool certificatePasswordNull() const;
    void setCertificatePasswordNull();
 
    bool isPortAuthorized() const;
    void setIsPortAuthorized(bool newIsPortAuthorized);
 
    bool quickConnectAvailable() const;
    void setQuickConnectAvailable(bool newQuickConnectAvailable);
 
    bool enableRemoteAccess() const;
    void setEnableRemoteAccess(bool newEnableRemoteAccess);
 
    bool enableCaseSensitiveItemIds() const;
    void setEnableCaseSensitiveItemIds(bool newEnableCaseSensitiveItemIds);
 
 
    bool disableLiveTvChannelUserDataName() const;
 
    void setDisableLiveTvChannelUserDataName(bool newDisableLiveTvChannelUserDataName);
 
    QString metadataPath() const;
    void setMetadataPath(QString newMetadataPath);
    bool metadataPathNull() const;
    void setMetadataPathNull();
 
 
    QString metadataNetworkPath() const;
 
    void setMetadataNetworkPath(QString newMetadataNetworkPath);
    bool metadataNetworkPathNull() const;
    void setMetadataNetworkPathNull();
 
    QString preferredMetadataLanguage() const;
    void setPreferredMetadataLanguage(QString newPreferredMetadataLanguage);
    bool preferredMetadataLanguageNull() const;
    void setPreferredMetadataLanguageNull();
 
    QString metadataCountryCode() const;
    void setMetadataCountryCode(QString newMetadataCountryCode);
    bool metadataCountryCodeNull() const;
    void setMetadataCountryCodeNull();
 
    QStringList sortReplaceCharacters() const;
    void setSortReplaceCharacters(QStringList newSortReplaceCharacters);
    bool sortReplaceCharactersNull() const;
    void setSortReplaceCharactersNull();
 
    QStringList sortRemoveCharacters() const;
    void setSortRemoveCharacters(QStringList newSortRemoveCharacters);
    bool sortRemoveCharactersNull() const;
    void setSortRemoveCharactersNull();
 
    QStringList sortRemoveWords() const;
    void setSortRemoveWords(QStringList newSortRemoveWords);
    bool sortRemoveWordsNull() const;
    void setSortRemoveWordsNull();
 
    qint32 minResumePct() const;
    void setMinResumePct(qint32 newMinResumePct);
 
    qint32 maxResumePct() const;
    void setMaxResumePct(qint32 newMaxResumePct);
 
    qint32 minResumeDurationSeconds() const;
    void setMinResumeDurationSeconds(qint32 newMinResumeDurationSeconds);
 
    qint32 minAudiobookResume() const;
    void setMinAudiobookResume(qint32 newMinAudiobookResume);
 
    qint32 maxAudiobookResume() const;
    void setMaxAudiobookResume(qint32 newMaxAudiobookResume);
 
    qint32 libraryMonitorDelay() const;
    void setLibraryMonitorDelay(qint32 newLibraryMonitorDelay);
 
    bool enableDashboardResponseCaching() const;
    void setEnableDashboardResponseCaching(bool newEnableDashboardResponseCaching);
 
 
    ImageSavingConvention imageSavingConvention() const;
 
    void setImageSavingConvention(ImageSavingConvention newImageSavingConvention);
 
 
    QList<MetadataOptions> metadataOptions() const;
 
    void setMetadataOptions(QList<MetadataOptions> newMetadataOptions);
    bool metadataOptionsNull() const;
    void setMetadataOptionsNull();
 
 
    bool skipDeserializationForBasicTypes() const;
 
    void setSkipDeserializationForBasicTypes(bool newSkipDeserializationForBasicTypes);
 
 
    QString serverName() const;
 
    void setServerName(QString newServerName);
    bool serverNameNull() const;
    void setServerNameNull();
 
 
    QString baseUrl() const;
 
    void setBaseUrl(QString newBaseUrl);
    bool baseUrlNull() const;
    void setBaseUrlNull();
 
 
    QString uICulture() const;
 
    void setUICulture(QString newUICulture);
    bool uICultureNull() const;
    void setUICultureNull();
 
 
    bool saveMetadataHidden() const;
 
    void setSaveMetadataHidden(bool newSaveMetadataHidden);
 
 
    QList<NameValuePair> contentTypes() const;
 
    void setContentTypes(QList<NameValuePair> newContentTypes);
    bool contentTypesNull() const;
    void setContentTypesNull();
 
 
    qint32 remoteClientBitrateLimit() const;
 
    void setRemoteClientBitrateLimit(qint32 newRemoteClientBitrateLimit);
 
 
    bool enableFolderView() const;
 
    void setEnableFolderView(bool newEnableFolderView);
 
 
    bool enableGroupingIntoCollections() const;
 
    void setEnableGroupingIntoCollections(bool newEnableGroupingIntoCollections);
 
 
    bool displaySpecialsWithinSeasons() const;
 
    void setDisplaySpecialsWithinSeasons(bool newDisplaySpecialsWithinSeasons);
 
    QStringList localNetworkSubnets() const;
    void setLocalNetworkSubnets(QStringList newLocalNetworkSubnets);
    bool localNetworkSubnetsNull() const;
    void setLocalNetworkSubnetsNull();
 
    QStringList localNetworkAddresses() const;
    void setLocalNetworkAddresses(QStringList newLocalNetworkAddresses);
    bool localNetworkAddressesNull() const;
    void setLocalNetworkAddressesNull();
 
 
    QStringList codecsUsed() const;
 
    void setCodecsUsed(QStringList newCodecsUsed);
    bool codecsUsedNull() const;
    void setCodecsUsedNull();
 
 
    QList<RepositoryInfo> pluginRepositories() const;
 
    void setPluginRepositories(QList<RepositoryInfo> newPluginRepositories);
    bool pluginRepositoriesNull() const;
    void setPluginRepositoriesNull();
 
 
    bool enableExternalContentInSuggestions() const;
 
    void setEnableExternalContentInSuggestions(bool newEnableExternalContentInSuggestions);
 
    bool requireHttps() const;
    void setRequireHttps(bool newRequireHttps);
 
 
    bool enableNewOmdbSupport() const;
 
    void setEnableNewOmdbSupport(bool newEnableNewOmdbSupport);
 
    QStringList remoteIPFilter() const;
    void setRemoteIPFilter(QStringList newRemoteIPFilter);
    bool remoteIPFilterNull() const;
    void setRemoteIPFilterNull();
 
    bool isRemoteIPFilterBlacklist() const;
    void setIsRemoteIPFilterBlacklist(bool newIsRemoteIPFilterBlacklist);
 
 
    qint32 imageExtractionTimeoutMs() const;
 
    void setImageExtractionTimeoutMs(qint32 newImageExtractionTimeoutMs);
 
 
    QList<PathSubstitution> pathSubstitutions() const;
 
    void setPathSubstitutions(QList<PathSubstitution> newPathSubstitutions);
    bool pathSubstitutionsNull() const;
    void setPathSubstitutionsNull();
 
 
    bool enableSimpleArtistDetection() const;
 
    void setEnableSimpleArtistDetection(bool newEnableSimpleArtistDetection);
 
 
    QStringList uninstalledPlugins() const;
 
    void setUninstalledPlugins(QStringList newUninstalledPlugins);
    bool uninstalledPluginsNull() const;
    void setUninstalledPluginsNull();
 
    bool enableSlowResponseWarning() const;
    void setEnableSlowResponseWarning(bool newEnableSlowResponseWarning);
 
    qint64 slowResponseThresholdMs() const;
    void setSlowResponseThresholdMs(qint64 newSlowResponseThresholdMs);
 
    QStringList corsHosts() const;
    void setCorsHosts(QStringList newCorsHosts);
    bool corsHostsNull() const;
    void setCorsHostsNull();
 
    QStringList knownProxies() const;
    void setKnownProxies(QStringList newKnownProxies);
    bool knownProxiesNull() const;
    void setKnownProxiesNull();
 
    std::optional<qint32> activityLogRetentionDays() const;
    void setActivityLogRetentionDays(std::optional<qint32> newActivityLogRetentionDays);
    bool activityLogRetentionDaysNull() const;
    void setActivityLogRetentionDaysNull();
 
    qint32 libraryScanFanoutConcurrency() const;
    void setLibraryScanFanoutConcurrency(qint32 newLibraryScanFanoutConcurrency);
 
    qint32 libraryMetadataRefreshConcurrency() const;
    void setLibraryMetadataRefreshConcurrency(qint32 newLibraryMetadataRefreshConcurrency);
 
    bool removeOldPlugins() const;
    void setRemoveOldPlugins(bool newRemoveOldPlugins);
 
    bool disablePluginImages() const;
    void setDisablePluginImages(bool newDisablePluginImages);
 
 
protected:
    qint32 m_logFileRetentionDays;
    bool m_isStartupWizardCompleted;
    QString m_cachePath;
    QSharedPointer<Version> m_previousVersion = QSharedPointer<Version>();
    QString m_previousVersionStr;
    bool m_enableUPnP;
    bool m_enableMetrics;
    qint32 m_publicPort;
    bool m_uPnPCreateHttpPortMap;
    QString m_uDPPortRange;
    bool m_enableIPV6;
    bool m_enableIPV4;
    bool m_enableSSDPTracing;
    QString m_sSDPTracingFilter;
    qint32 m_uDPSendCount;
    qint32 m_uDPSendDelay;
    bool m_ignoreVirtualInterfaces;
    QString m_virtualInterfaceNames;
    qint32 m_gatewayMonitorPeriod;
    bool m_enableMultiSocketBinding;
    bool m_trustAllIP6Interfaces;
    QString m_hDHomerunPortRange;
    QStringList m_publishedServerUriBySubnet;
    bool m_autoDiscoveryTracing;
    bool m_autoDiscovery;
    qint32 m_publicHttpsPort;
    qint32 m_httpServerPortNumber;
    qint32 m_httpsPortNumber;
    bool m_enableHttps;
    bool m_enableNormalizedItemByNameIds;
    QString m_certificatePath;
    QString m_certificatePassword;
    bool m_isPortAuthorized;
    bool m_quickConnectAvailable;
    bool m_enableRemoteAccess;
    bool m_enableCaseSensitiveItemIds;
    bool m_disableLiveTvChannelUserDataName;
    QString m_metadataPath;
    QString m_metadataNetworkPath;
    QString m_preferredMetadataLanguage;
    QString m_metadataCountryCode;
    QStringList m_sortReplaceCharacters;
    QStringList m_sortRemoveCharacters;
    QStringList m_sortRemoveWords;
    qint32 m_minResumePct;
    qint32 m_maxResumePct;
    qint32 m_minResumeDurationSeconds;
    qint32 m_minAudiobookResume;
    qint32 m_maxAudiobookResume;
    qint32 m_libraryMonitorDelay;
    bool m_enableDashboardResponseCaching;
    ImageSavingConvention m_imageSavingConvention;
    QList<MetadataOptions> m_metadataOptions;
    bool m_skipDeserializationForBasicTypes;
    QString m_serverName;
    QString m_baseUrl;
    QString m_uICulture;
    bool m_saveMetadataHidden;
    QList<NameValuePair> m_contentTypes;
    qint32 m_remoteClientBitrateLimit;
    bool m_enableFolderView;
    bool m_enableGroupingIntoCollections;
    bool m_displaySpecialsWithinSeasons;
    QStringList m_localNetworkSubnets;
    QStringList m_localNetworkAddresses;
    QStringList m_codecsUsed;
    QList<RepositoryInfo> m_pluginRepositories;
    bool m_enableExternalContentInSuggestions;
    bool m_requireHttps;
    bool m_enableNewOmdbSupport;
    QStringList m_remoteIPFilter;
    bool m_isRemoteIPFilterBlacklist;
    qint32 m_imageExtractionTimeoutMs;
    QList<PathSubstitution> m_pathSubstitutions;
    bool m_enableSimpleArtistDetection;
    QStringList m_uninstalledPlugins;
    bool m_enableSlowResponseWarning;
    qint64 m_slowResponseThresholdMs;
    QStringList m_corsHosts;
    QStringList m_knownProxies;
    std::optional<qint32> m_activityLogRetentionDays = std::nullopt;
    qint32 m_libraryScanFanoutConcurrency;
    qint32 m_libraryMetadataRefreshConcurrency;
    bool m_removeOldPlugins;
    bool m_disablePluginImages;
 
private:
    // Private constructor which generates an invalid object, for use withing ServerConfiguration::fromJson();
    ServerConfiguration();
};
 
 
} // NS DTO
 
namespace Support {
 
using ServerConfiguration = Jellyfin::DTO::ServerConfiguration;
 
template <>
ServerConfiguration fromJsonValue(const QJsonValue &source, convertType<ServerConfiguration>);
 
template<>
QJsonValue toJsonValue(const ServerConfiguration &source, convertType<ServerConfiguration>);
 
} // NS DTO
} // NS Jellyfin
 
#endif // JELLYFIN_DTO_SERVERCONFIGURATION_H