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/castreceiverapplication.h"
#include "JellyfinQt/dto/imageresolution.h"
#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/trickplayoptions.h"
#include "JellyfinQt/support/jsonconv.h"
 
namespace Jellyfin {
// Forward declaration
class ApiClient;
}
namespace Jellyfin {
namespace DTO {
 
 
class ServerConfiguration {
public:
    ServerConfiguration(    
        qint32 logFileRetentionDays,            
        bool isStartupWizardCompleted,                                  
        bool enableMetrics,         
        bool enableNormalizedItemByNameIds,         
        bool isPortAuthorized,          
        bool quickConnectAvailable,         
        bool enableCaseSensitiveItemIds,            
        bool disableLiveTvChannelUserDataName,          
        QString metadataPath,           
        QString preferredMetadataLanguage,          
        QString metadataCountryCode,            
        QStringList sortReplaceCharacters,          
        QStringList sortRemoveCharacters,           
        QStringList sortRemoveWords,            
        qint32 minResumePct,            
        qint32 maxResumePct,            
        qint32 minResumeDurationSeconds,            
        qint32 minAudiobookResume,          
        qint32 maxAudiobookResume,          
        qint32 inactiveSessionThreshold,            
        qint32 libraryMonitorDelay,         
        qint32 libraryUpdateDuration,           
        ImageSavingConvention imageSavingConvention,            
        QList<MetadataOptions> metadataOptions,         
        bool skipDeserializationForBasicTypes,          
        QString serverName,         
        QString uICulture,          
        bool saveMetadataHidden,            
        QList<NameValuePair> contentTypes,          
        qint32 remoteClientBitrateLimit,            
        bool enableFolderView,          
        bool enableGroupingIntoCollections,         
        bool displaySpecialsWithinSeasons,          
        QStringList codecsUsed,         
        QList<RepositoryInfo> pluginRepositories,           
        bool enableExternalContentInSuggestions,            
        qint32 imageExtractionTimeoutMs,            
        QList<PathSubstitution> pathSubstitutions,          
        bool enableSlowResponseWarning,         
        qint64 slowResponseThresholdMs,         
        QStringList corsHosts,                  
        qint32 libraryScanFanoutConcurrency,            
        qint32 libraryMetadataRefreshConcurrency,           
        bool removeOldPlugins,          
        bool allowClientLogUpload,          
        qint32 dummyChapterDuration,            
        ImageResolution chapterImageResolution,         
        qint32 parallelImageEncodingLimit,          
        QList<CastReceiverApplication> castReceiverApplications,            
        QSharedPointer<TrickplayOptions> trickplayOptions       
    );
 
    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();

    QString previousVersion() const;
    void setPreviousVersion(QString newPreviousVersion);
    bool previousVersionNull() const;
    void setPreviousVersionNull();

    QString previousVersionStr() const;
    void setPreviousVersionStr(QString newPreviousVersionStr);
    bool previousVersionStrNull() const;
    void setPreviousVersionStrNull();

    bool enableMetrics() const;
    void setEnableMetrics(bool newEnableMetrics);
 
 
    bool enableNormalizedItemByNameIds() const;
 
    void setEnableNormalizedItemByNameIds(bool newEnableNormalizedItemByNameIds);

    bool isPortAuthorized() const;
    void setIsPortAuthorized(bool newIsPortAuthorized);

    bool quickConnectAvailable() const;
    void setQuickConnectAvailable(bool newQuickConnectAvailable);

    bool enableCaseSensitiveItemIds() const;
    void setEnableCaseSensitiveItemIds(bool newEnableCaseSensitiveItemIds);
 
 
    bool disableLiveTvChannelUserDataName() const;
 
    void setDisableLiveTvChannelUserDataName(bool newDisableLiveTvChannelUserDataName);

    QString metadataPath() const;
    void setMetadataPath(QString newMetadataPath);

    QString preferredMetadataLanguage() const;
    void setPreferredMetadataLanguage(QString newPreferredMetadataLanguage);

    QString metadataCountryCode() const;
    void setMetadataCountryCode(QString newMetadataCountryCode);

    QStringList sortReplaceCharacters() const;
    void setSortReplaceCharacters(QStringList newSortReplaceCharacters);

    QStringList sortRemoveCharacters() const;
    void setSortRemoveCharacters(QStringList newSortRemoveCharacters);

    QStringList sortRemoveWords() const;
    void setSortRemoveWords(QStringList newSortRemoveWords);

    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 inactiveSessionThreshold() const;
    void setInactiveSessionThreshold(qint32 newInactiveSessionThreshold);

    qint32 libraryMonitorDelay() const;
    void setLibraryMonitorDelay(qint32 newLibraryMonitorDelay);

    qint32 libraryUpdateDuration() const;
    void setLibraryUpdateDuration(qint32 newLibraryUpdateDuration);
 
 
    ImageSavingConvention imageSavingConvention() const;
 
    void setImageSavingConvention(ImageSavingConvention newImageSavingConvention);
 
 
    QList<MetadataOptions> metadataOptions() const;
 
    void setMetadataOptions(QList<MetadataOptions> newMetadataOptions);
 
 
    bool skipDeserializationForBasicTypes() const;
 
    void setSkipDeserializationForBasicTypes(bool newSkipDeserializationForBasicTypes);
 
 
    QString serverName() const;
 
    void setServerName(QString newServerName);
 
 
    QString uICulture() const;
 
    void setUICulture(QString newUICulture);
 
 
    bool saveMetadataHidden() const;
 
    void setSaveMetadataHidden(bool newSaveMetadataHidden);
 
 
    QList<NameValuePair> contentTypes() const;
 
    void setContentTypes(QList<NameValuePair> newContentTypes);
 
 
    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 codecsUsed() const;
 
    void setCodecsUsed(QStringList newCodecsUsed);
 
 
    QList<RepositoryInfo> pluginRepositories() const;
 
    void setPluginRepositories(QList<RepositoryInfo> newPluginRepositories);
 
 
    bool enableExternalContentInSuggestions() const;
 
    void setEnableExternalContentInSuggestions(bool newEnableExternalContentInSuggestions);
 
 
    qint32 imageExtractionTimeoutMs() const;
 
    void setImageExtractionTimeoutMs(qint32 newImageExtractionTimeoutMs);
 
 
    QList<PathSubstitution> pathSubstitutions() const;
 
    void setPathSubstitutions(QList<PathSubstitution> newPathSubstitutions);

    bool enableSlowResponseWarning() const;
    void setEnableSlowResponseWarning(bool newEnableSlowResponseWarning);

    qint64 slowResponseThresholdMs() const;
    void setSlowResponseThresholdMs(qint64 newSlowResponseThresholdMs);

    QStringList corsHosts() const;
    void setCorsHosts(QStringList newCorsHosts);

    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 allowClientLogUpload() const;
    void setAllowClientLogUpload(bool newAllowClientLogUpload);

    qint32 dummyChapterDuration() const;
    void setDummyChapterDuration(qint32 newDummyChapterDuration);
 
 
    ImageResolution chapterImageResolution() const;
 
    void setChapterImageResolution(ImageResolution newChapterImageResolution);

    qint32 parallelImageEncodingLimit() const;
    void setParallelImageEncodingLimit(qint32 newParallelImageEncodingLimit);

    QList<CastReceiverApplication> castReceiverApplications() const;
    void setCastReceiverApplications(QList<CastReceiverApplication> newCastReceiverApplications);
 
 
    QSharedPointer<TrickplayOptions> trickplayOptions() const;
 
    void setTrickplayOptions(QSharedPointer<TrickplayOptions> newTrickplayOptions);
 
 
protected:
    qint32 m_logFileRetentionDays;
    bool m_isStartupWizardCompleted;
    QString m_cachePath;
    QString m_previousVersion;
    QString m_previousVersionStr;
    bool m_enableMetrics;
    bool m_enableNormalizedItemByNameIds;
    bool m_isPortAuthorized;
    bool m_quickConnectAvailable;
    bool m_enableCaseSensitiveItemIds;
    bool m_disableLiveTvChannelUserDataName;
    QString m_metadataPath;
    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_inactiveSessionThreshold;
    qint32 m_libraryMonitorDelay;
    qint32 m_libraryUpdateDuration;
    ImageSavingConvention m_imageSavingConvention;
    QList<MetadataOptions> m_metadataOptions;
    bool m_skipDeserializationForBasicTypes;
    QString m_serverName;
    QString m_uICulture;
    bool m_saveMetadataHidden;
    QList<NameValuePair> m_contentTypes;
    qint32 m_remoteClientBitrateLimit;
    bool m_enableFolderView;
    bool m_enableGroupingIntoCollections;
    bool m_displaySpecialsWithinSeasons;
    QStringList m_codecsUsed;
    QList<RepositoryInfo> m_pluginRepositories;
    bool m_enableExternalContentInSuggestions;
    qint32 m_imageExtractionTimeoutMs;
    QList<PathSubstitution> m_pathSubstitutions;
    bool m_enableSlowResponseWarning;
    qint64 m_slowResponseThresholdMs;
    QStringList m_corsHosts;
    std::optional<qint32> m_activityLogRetentionDays = std::nullopt;
    qint32 m_libraryScanFanoutConcurrency;
    qint32 m_libraryMetadataRefreshConcurrency;
    bool m_removeOldPlugins;
    bool m_allowClientLogUpload;
    qint32 m_dummyChapterDuration;
    ImageResolution m_chapterImageResolution;
    qint32 m_parallelImageEncodingLimit;
    QList<CastReceiverApplication> m_castReceiverApplications;
    QSharedPointer<TrickplayOptions> m_trickplayOptions = QSharedPointer<TrickplayOptions>();
 
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