harbour-sailfin/core/include/JellyfinQt/dto/virtualfolderinfo.h

/*
 * 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/libraryoptions.h"
#include "JellyfinQt/support/jsonconv.h"

namespace Jellyfin {
// Forward declaration
class ApiClient;
}
namespace Jellyfin {
namespace DTO {


class VirtualFolderInfo {
public:
	VirtualFolderInfo(							
		QSharedPointer<LibraryOptions> libraryOptions										
	);

	VirtualFolderInfo(const VirtualFolderInfo &other);
	
	/**
	 * Replaces the data being hold by this class with that of the other.
	 */
	void replaceData(VirtualFolderInfo &other);
	
	static VirtualFolderInfo fromJson(QJsonObject source);
	void setFromJson(QJsonObject source);
	QJsonObject toJson() const;
	
	// Properties
	/**
	 * @brief Gets or sets the name.
	 */
	QString name() const;
	/**
	* @brief Gets or sets the name.
	*/
	void setName(QString newName);
	bool nameNull() const;
	void setNameNull();

	/**
	 * @brief Gets or sets the locations.
	 */
	QStringList locations() const;
	/**
	* @brief Gets or sets the locations.
	*/
	void setLocations(QStringList newLocations);
	bool locationsNull() const;
	void setLocationsNull();

	/**
	 * @brief Gets or sets the type of the collection.
	 */
	QString collectionType() const;
	/**
	* @brief Gets or sets the type of the collection.
	*/
	void setCollectionType(QString newCollectionType);
	bool collectionTypeNull() const;
	void setCollectionTypeNull();


	QSharedPointer<LibraryOptions> libraryOptions() const;

	void setLibraryOptions(QSharedPointer<LibraryOptions> newLibraryOptions);

	/**
	 * @brief Gets or sets the item identifier.
	 */
	QString itemId() const;
	/**
	* @brief Gets or sets the item identifier.
	*/
	void setItemId(QString newItemId);
	bool itemIdNull() const;
	void setItemIdNull();

	/**
	 * @brief Gets or sets the primary image item identifier.
	 */
	QString primaryImageItemId() const;
	/**
	* @brief Gets or sets the primary image item identifier.
	*/
	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;
	QString 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