songinfo.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_SONGINFO_H
#define JELLYFIN_DTO_SONGINFO_H
 
#include <QDateTime>
#include <QJsonObject>
#include <QJsonValue>
#include <QList>
#include <QString>
#include <QStringList>
#include <optional>
 
#include "JellyfinQt/support/jsonconv.h"
 
namespace Jellyfin {
// Forward declaration
class ApiClient;
}
namespace Jellyfin {
namespace DTO {
 
 
class SongInfo {
public:
    SongInfo(                                                                           
        bool isAutomated                                
    );
 
    SongInfo(const SongInfo &other);
    
    void replaceData(SongInfo &other);
    
    static SongInfo fromJson(QJsonObject source);
    void setFromJson(QJsonObject source);
    QJsonObject toJson() const;
    
    // Properties
    QString name() const;
    void setName(QString newName);
    bool nameNull() const;
    void setNameNull();
 
    QString path() const;
    void setPath(QString newPath);
    bool pathNull() const;
    void setPathNull();
 
    QString metadataLanguage() const;
    void setMetadataLanguage(QString newMetadataLanguage);
    bool metadataLanguageNull() const;
    void setMetadataLanguageNull();
 
    QString metadataCountryCode() const;
    void setMetadataCountryCode(QString newMetadataCountryCode);
    bool metadataCountryCodeNull() const;
    void setMetadataCountryCodeNull();
 
    QJsonObject providerIds() const;
    void setProviderIds(QJsonObject newProviderIds);
    bool providerIdsNull() const;
    void setProviderIdsNull();
 
    std::optional<qint32> year() const;
    void setYear(std::optional<qint32> newYear);
    bool yearNull() const;
    void setYearNull();
 
 
    std::optional<qint32> indexNumber() const;
 
    void setIndexNumber(std::optional<qint32> newIndexNumber);
    bool indexNumberNull() const;
    void setIndexNumberNull();
 
 
    std::optional<qint32> parentIndexNumber() const;
 
    void setParentIndexNumber(std::optional<qint32> newParentIndexNumber);
    bool parentIndexNumberNull() const;
    void setParentIndexNumberNull();
 
 
    QDateTime premiereDate() const;
 
    void setPremiereDate(QDateTime newPremiereDate);
    bool premiereDateNull() const;
    void setPremiereDateNull();
 
 
    bool isAutomated() const;
 
    void setIsAutomated(bool newIsAutomated);
 
 
    QStringList albumArtists() const;
 
    void setAlbumArtists(QStringList newAlbumArtists);
    bool albumArtistsNull() const;
    void setAlbumArtistsNull();
 
 
    QString album() const;
 
    void setAlbum(QString newAlbum);
    bool albumNull() const;
    void setAlbumNull();
 
 
    QStringList artists() const;
 
    void setArtists(QStringList newArtists);
    bool artistsNull() const;
    void setArtistsNull();
 
 
protected:
    QString m_name;
    QString m_path;
    QString m_metadataLanguage;
    QString m_metadataCountryCode;
    QJsonObject m_providerIds;
    std::optional<qint32> m_year = std::nullopt;
    std::optional<qint32> m_indexNumber = std::nullopt;
    std::optional<qint32> m_parentIndexNumber = std::nullopt;
    QDateTime m_premiereDate;
    bool m_isAutomated;
    QStringList m_albumArtists;
    QString m_album;
    QStringList m_artists;
 
private:
    // Private constructor which generates an invalid object, for use withing SongInfo::fromJson();
    SongInfo();
};
 
 
} // NS DTO
 
namespace Support {
 
using SongInfo = Jellyfin::DTO::SongInfo;
 
template <>
SongInfo fromJsonValue(const QJsonValue &source, convertType<SongInfo>);
 
template<>
QJsonValue toJsonValue(const SongInfo &source, convertType<SongInfo>);
 
} // NS DTO
} // NS Jellyfin
 
#endif // JELLYFIN_DTO_SONGINFO_H