virtualfolderinfo.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_VIRTUALFOLDERINFO_H
#define JELLYFIN_DTO_VIRTUALFOLDERINFO_H
 
#include <QJsonObject>
#include <QJsonValue>
#include <QList>
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <optional>
 
#include "JellyfinQt/dto/collectiontypeoptions.h"
#include "JellyfinQt/dto/libraryoptions.h"
#include "JellyfinQt/support/jsonconv.h"
 
namespace Jellyfin {
// Forward declaration
class ApiClient;
}
namespace Jellyfin {
namespace DTO {
 
 
class VirtualFolderInfo {
public:
    VirtualFolderInfo(                  
        CollectionTypeOptions collectionType,           
        QSharedPointer<LibraryOptions> libraryOptions                                       
    );
 
    VirtualFolderInfo(const VirtualFolderInfo &other);
    
    void replaceData(VirtualFolderInfo &other);
    
    static VirtualFolderInfo fromJson(QJsonObject source);
    void setFromJson(QJsonObject source);
    QJsonObject toJson() const;
    
    // Properties
    QString name() const;
    void setName(QString newName);
    bool nameNull() const;
    void setNameNull();

    QStringList locations() const;
    void setLocations(QStringList newLocations);
    bool locationsNull() const;
    void setLocationsNull();
 
 
    CollectionTypeOptions collectionType() const;
 
    void setCollectionType(CollectionTypeOptions newCollectionType);
 
 
    QSharedPointer<LibraryOptions> libraryOptions() const;
 
    void setLibraryOptions(QSharedPointer<LibraryOptions> newLibraryOptions);

    QString itemId() const;
    void setItemId(QString newItemId);
    bool itemIdNull() const;
    void setItemIdNull();

    QString primaryImageItemId() const;
    void setPrimaryImageItemId(QString newPrimaryImageItemId);
    bool primaryImageItemIdNull() const;
    void setPrimaryImageItemIdNull();
 
 
    std::optional<double> refreshProgress() const;
 
    void setRefreshProgress(std::optional<double> newRefreshProgress);
    bool refreshProgressNull() const;
    void setRefreshProgressNull();
 
 
    QString refreshStatus() const;
 
    void setRefreshStatus(QString newRefreshStatus);
    bool refreshStatusNull() const;
    void setRefreshStatusNull();
 
 
protected:
    QString m_name;
    QStringList m_locations;
    CollectionTypeOptions m_collectionType;
    QSharedPointer<LibraryOptions> m_libraryOptions = QSharedPointer<LibraryOptions>();
    QString m_itemId;
    QString m_primaryImageItemId;
    std::optional<double> m_refreshProgress = std::nullopt;
    QString m_refreshStatus;
 
private:
    // Private constructor which generates an invalid object, for use withing VirtualFolderInfo::fromJson();
    VirtualFolderInfo();
};
 
 
} // NS DTO
 
namespace Support {
 
using VirtualFolderInfo = Jellyfin::DTO::VirtualFolderInfo;
 
template <>
VirtualFolderInfo fromJsonValue(const QJsonValue &source, convertType<VirtualFolderInfo>);
 
template<>
QJsonValue toJsonValue(const VirtualFolderInfo &source, convertType<VirtualFolderInfo>);
 
} // NS DTO
} // NS Jellyfin
 
#endif // JELLYFIN_DTO_VIRTUALFOLDERINFO_H