harbour-sailfin/core/include/JellyfinQt/dto/taskinfo.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_TASKINFO_H
#define JELLYFIN_DTO_TASKINFO_H

#include <QJsonObject>
#include <QJsonValue>
#include <QList>
#include <QSharedPointer>
#include <QString>
#include <QStringList>
#include <optional>

#include "JellyfinQt/dto/taskresult.h"
#include "JellyfinQt/dto/taskstate.h"
#include "JellyfinQt/dto/tasktriggerinfo.h"
#include "JellyfinQt/support/jsonconv.h"

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


class TaskInfo {
public:
	TaskInfo(			
		TaskState state,							
		QSharedPointer<TaskResult> lastExecutionResult,									
		bool isHidden				
	);

	TaskInfo(const TaskInfo &other);
	
	/**
	 * Replaces the data being hold by this class with that of the other.
	 */
	void replaceData(TaskInfo &other);
	
	static TaskInfo 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();


	TaskState state() const;

	void setState(TaskState newState);

	/**
	 * @brief Gets or sets the progress.
	 */
	std::optional<double> currentProgressPercentage() const;
	/**
	* @brief Gets or sets the progress.
	*/
	void setCurrentProgressPercentage(std::optional<double> newCurrentProgressPercentage);
	bool currentProgressPercentageNull() const;
	void setCurrentProgressPercentageNull();

	/**
	 * @brief Gets or sets the id.
	 */
	QString jellyfinId() const;
	/**
	* @brief Gets or sets the id.
	*/
	void setJellyfinId(QString newJellyfinId);
	bool jellyfinIdNull() const;
	void setJellyfinIdNull();


	QSharedPointer<TaskResult> lastExecutionResult() const;

	void setLastExecutionResult(QSharedPointer<TaskResult> newLastExecutionResult);

	/**
	 * @brief Gets or sets the triggers.
	 */
	QList<TaskTriggerInfo> triggers() const;
	/**
	* @brief Gets or sets the triggers.
	*/
	void setTriggers(QList<TaskTriggerInfo> newTriggers);
	bool triggersNull() const;
	void setTriggersNull();

	/**
	 * @brief Gets or sets the description.
	 */
	QString description() const;
	/**
	* @brief Gets or sets the description.
	*/
	void setDescription(QString newDescription);
	bool descriptionNull() const;
	void setDescriptionNull();

	/**
	 * @brief Gets or sets the category.
	 */
	QString category() const;
	/**
	* @brief Gets or sets the category.
	*/
	void setCategory(QString newCategory);
	bool categoryNull() const;
	void setCategoryNull();

	/**
	 * @brief Gets or sets a value indicating whether this instance is hidden.
	 */
	bool isHidden() const;
	/**
	* @brief Gets or sets a value indicating whether this instance is hidden.
	*/
	void setIsHidden(bool newIsHidden);

	/**
	 * @brief Gets or sets the key.
	 */
	QString key() const;
	/**
	* @brief Gets or sets the key.
	*/
	void setKey(QString newKey);
	bool keyNull() const;
	void setKeyNull();


protected:
	QString m_name;
	TaskState m_state;
	std::optional<double> m_currentProgressPercentage = std::nullopt;
	QString m_jellyfinId;
	QSharedPointer<TaskResult> m_lastExecutionResult = QSharedPointer<TaskResult>();
	QList<TaskTriggerInfo> m_triggers;
	QString m_description;
	QString m_category;
	bool m_isHidden;
	QString m_key;

private:
	// Private constructor which generates an invalid object, for use withing TaskInfo::fromJson();
	TaskInfo();
};


} // NS DTO

namespace Support {

using TaskInfo = Jellyfin::DTO::TaskInfo;

template <>
TaskInfo fromJsonValue(const QJsonValue &source, convertType<TaskInfo>);

template<>
QJsonValue toJsonValue(const TaskInfo &source, convertType<TaskInfo>);

} // NS DTO
} // NS Jellyfin

#endif // JELLYFIN_DTO_TASKINFO_H